/// <summary> /// Build a cacherequest for properties and patterns /// </summary> /// <param name="uia"></param> /// <param name="pps">Property ids</param> /// <param name="pts">Pattern ids</param> /// <returns></returns> public static IUIAutomationCacheRequest GetPropertiesCache(IUIAutomation uia, List <int> pps, List <int> pts) { if (uia == null) { throw new ArgumentNullException(nameof(uia)); } var cr = uia.CreateCacheRequest(); if (pps != null) { foreach (var pp in pps) { cr.AddProperty(pp); } } if (pts != null) { foreach (var pt in pts) { if (pt != 0) { cr.AddPattern(pt); } } } return(cr); }
///////////////////////////////////////////////////////////////////////////////////////////////// // // RegisterFocusChangedListener() // // Add a UIA event handler to react to focus change events sent from UIA. // // Runs on the background thread. // ///////////////////////////////////////////////////////////////////////////////////////////////// void RegisterFocusChangedListener() { // Create a cache request for the properties we know we'll need when a focus change occurs. // By setting up this cache request, we won't incur a cross-proc call later to get the // properties when we receive the event. IUIAutomationCacheRequest cacheRequest = _automation.CreateCacheRequest(); cacheRequest.AddProperty(_propertyIdName); cacheRequest.AddProperty(_propertyIdBoundingRectangle); // The above properties are all we'll need, so we have have no need for a reference // to the source element when we receive the event. cacheRequest.AutomationElementMode = AutomationElementMode.AutomationElementMode_None; // Now set up the event handler. _automation.AddFocusChangedEventHandler(cacheRequest, this); _fAddedEventHandler = true; }
/// <summary> /// Build a cacherequest for properties and patterns /// </summary> /// <param name="uia"></param> /// <param name="pps">Property ids</param> /// <param name="pts">Pattern ids</param> /// <returns></returns> public static IUIAutomationCacheRequest GetPropertiesCache(IUIAutomation uia, IEnumerable <int> pps, IEnumerable <int> pts) { if (uia == null) { throw new ArgumentNullException(nameof(uia)); } var cr = uia.CreateCacheRequest(); if (pps != null) { foreach (var pp in pps) { cr.AddProperty(pp); } } IEnumerable <int> cps = Registrar.GetDefaultInstance().GetCustomPropertyRegistrations().Keys; foreach (var cp in cps) { cr.AddProperty(cp); } if (pts != null) { foreach (var pt in pts) { if (pt != 0) { cr.AddPattern(pt); } } } return(cr); }
////////////////////////////////////////////////////////////////////////////////////////////////////////////// // // BuildListOfHyperlinksFromElement() // // Retrieve a list of hyperlinks from a UIAutomation element. Notifies the main // UI thread when it's found all the hyperlinks to be added to the app's list of // hyperlinks. // // Runs on the background thread. // ////////////////////////////////////////////////////////////////////////////////////////////////////////////// private void BuildListOfHyperlinksFromElement(IUIAutomationElement elementBrowser, bool fUseCache, bool fSearchLinkChildren) { IUIAutomationCacheRequest cacheRequest = null; // If a cache is used, then for each of the elements returned to us after a search // for elements, specific properties (and patterns), can be cached with the element. // This means that when we access one of the properties later, a cross-proc call // does not have to be made. (But it also means that when such a call is made, we // don't learn whether the original element still exists.) if (fUseCache) { // Create a cache request containing all the properties and patterns // we will need once we've retrieved the hyperlinks. By using this // cache, when can avoid time-consuming cross-process calls when // getting hyperlink properties later. cacheRequest = _automation.CreateCacheRequest(); // We'll need the hyperlink's name and bounding rectangle later. // A full list of Automation element properties can be found at // http://msdn.microsoft.com/en-us/library/ee684017(v=VS.85).aspx. cacheRequest.AddProperty(_propertyIdName); cacheRequest.AddProperty(_propertyIdBoundingRectangle); // The target of the hyperlink might be stored in the Value property of // the hyperlink. The Value property is only avaliable if an element // supports the Value pattern. This sample doesn't use the Value, but // if it did, it would call the following here. // hr = pCacheRequest->AddProperty(UIA_ValueValuePropertyId); // It's ok to attempt to cache a property on a pattern which might not // exist on the cached elements. In that case, the property just won't // be available when we try to retrieve it from the cache later. // Note that calling AddPattern() does not cache the properties // associated with a pattern. The pattern's properties must be // added explicitly to the cache if required. // Cache the Invoke pattern too. This means when we prepare to invoke a link later, // we won't need to make a cross-proc call during that preparation. (A cross-proc // call will occur at the time Invoke() is actually called.) A full list of patterns // can be found at http://msdn.microsoft.com/en-us/library/ee684023(v=VS.85).aspx. cacheRequest.AddPattern(_patternIdInvoke); // The next step is to specify for which elements we want to have the properties, (and // pattern) cached. By default, caching will occur on each element found in the search // below. But we can also request that the data is cached for direct children of the // elements found, or even all the descendants of the elements founds. (A scope of // Parent or Ancestors cannot be used in a cached request.) // So in this sample, if TreeScope_Element is used as the scope here, (which is the // default), then only properties for the found hyperlinks will be cached. The sample // optionally caches the properties for the direct children of the hyperlinks too. // This means that if we find a hyperlink with no name, we can search the hyperlink's // children to see if one of the child elements has a name we can use. (Searching the // children could be done without using the cache, but it would incur the time cost of // making cross-proc calls.) TreeScope scope = TreeScope.TreeScope_Element; if (fSearchLinkChildren) { scope = scope | TreeScope.TreeScope_Children; } cacheRequest.TreeScope = scope; // Note: By default the cache request has a Mode of Full. This means a reference to the // target element is included in the cache, as well as whatever properties and patterns // we specified should be in the cache. With a reference to the target element, we can: // // (i) Retrieve a property later for an element which we didn't request should be in // the cache. Eg we could call get_CurrentHasKeyboardFocus(). // // (ii) We can call a method of a pattern that the element supports. Eg if Full mode was // not used here, we would not be able to call Invoke() on the hyperlink later. // If we specified a Mode of None for the cache request here, then the results only include // cached data, with no connection at all after the call returns to the source elements. If // only data is required, then it would be preference to use a Mode of None, as less work is // required by UIA. (Also, if a reference to the element is returned in the cache and kept // around for a non-trivial time, then it increases the chances that the target process // attempts to free the element, but it can't do so in a clean manner as it would like, // due to the client app here holding a reference to it.) To specify that we want a Mode of // None, we'd make this call here: // cacheRequest.AutomationElementMode = AutomationElementMode.AutomationElementMode_None; } // Now regardless of whether we're using a cache, we need to specify which elements // we're interested in during our search for elements. We do this by building up a // property condition. This property condition tells UIA which properties must be // satisfied by an element for it to be included in the search results. We can // combine a number of properties with AND and OR logic. // We shall first say that we're only interested in elements that exist in the Control view. // By default, a property condition uses the Raw view, which means that every element in the // target browser's UIA tree will be examined. The Control view is a subset of the Raw view, // and only includes elements which present some useful UI. (The Raw view might include // container elements which simply group elements logically together, but the containers // themselves might have no visual representation on the screen.) IUIAutomationCondition conditionControlView = _automation.ControlViewCondition; IUIAutomationCondition conditionHyperlink = _automation.CreatePropertyCondition(_propertyIdControlType, _controlTypeIdHyperlink); // Now combine these two properties such that the search results only contain // elements that are in the Control view AND are hyperlinks. We would get the // same results here if we didn't include the Control view clause, (as hyperlinks // won't exist only in the Raw view), but by specifying that we're only interested // in the Control view, UIA won't bother checking all the elements that only exist // in the Raw view to see if they're hyperlinks. IUIAutomationCondition condition = _automation.CreateAndCondition(conditionControlView, conditionHyperlink); // Now retrieve all the hyperlinks in the browser. We must specify a scope in the Find calls here, // to control how far UIA will go in looking for elements to include in the search results. For // this sample, we must check all descendants of the browser window. // *** Note: use TreeScope_Descendants with care, as depending on what you're searching for, UIA may // have to process potentially thousands of elements. For example, if you only need to find top level // windows on your desktop, you would search for TreeScope_Children of the root of the UIA tree. (The // root element can be found with a call to IUIAutomation::GetRootElement().) // *** Note: If the following searches included searching for elements in the client app's own UI, // then the calls must be made on a background thread. (ie not your main UI thread.) Once event // handlers are used, then it's preferable to have all UIA calls made on a background thread // regardless of whether the app interacts with its own UI. IUIAutomationElementArray elementArray; if (fUseCache) { elementArray = elementBrowser.FindAllBuildCache(TreeScope.TreeScope_Descendants, condition, cacheRequest); } else { elementArray = elementBrowser.FindAll(TreeScope.TreeScope_Descendants, condition); } // Build up a list of items to be passed to the main thread in order for it to // populate the list of hyperlinks shown in the UI. _linkItems.Clear(); if (elementArray != null) { // Find the number of hyperlinks returned by the search. (The number of hyperlinks // found might be zero if the browser window is minimized.) int cLinks = elementArray.Length; // Process each returned hyperlink element. for (int idxLink = 0; idxLink < cLinks; ++idxLink) { IUIAutomationElement elementLink = elementArray.GetElement(idxLink); // Get the name property for the hyperlink element. How we get this depends // on whether we requested that the property should be cached or not. string strLinkName = null; if (fUseCache) { strLinkName = GetCachedDataFromElement(elementLink, fSearchLinkChildren); } else { strLinkName = GetCurrentDataFromElement(elementLink, fSearchLinkChildren); } // If we have non-null name, add the link to the list. (This sample does not check // for names that only contains whitespace.) if (strLinkName != null) { strLinkName = strLinkName.Trim(); LinkItem item = new LinkItem(); item.linkName = strLinkName; item.element = elementLink; _linkItems.Add(item); } } } // Notify the main UI thread that a list of links is ready for processing. Do not block in this call. _listViewLinks.BeginInvoke(_UIUpdateDelegate, _linkItems); }
public string GetMail() { string strMailContent = ""; // Try to find a Windows Live Mail window for composing and reading e-mails. // Using the Spy tool, the class of the main window can be found. This test // app assumes there's only one Windows Live Mail window of interest. IntPtr hwnd = Win32.FindWindow("ATH_Note", null); if (hwnd != IntPtr.Zero) { // We found a window, so get the UIA element associated with the window. IUIAutomationElement elementMailAppWindow = _automation.ElementFromHandle( hwnd); // Find an element somewhere beneath the main window element in the UIA // tree which represents the main area where the e-mail content is shown. // Using the Inspect SDK tool, we can see that the main e-mail content // is contained within an element whose accessible name is "NoteWindow". // So create a condition such that the FindFirst() call below will only // return an element if its name is "NoteWindow". IUIAutomationCondition conditionNote = _automation.CreatePropertyCondition( _propertyIdName, "NoteWindow"); IUIAutomationElement elementNoteWindow = elementMailAppWindow.FindFirst( TreeScope.TreeScope_Descendants, conditionNote); // As it happens, the actual element that supports the Text Pattern is // somewhere beneath the "NoteWindow" element in the UIA tree. Using // Inspect we can see that there is an element that supports the // Text Pattern. Once we have that element, we can avoid a cross-process // call to access the Text Pattern object by using cache request. IUIAutomationCacheRequest cacheRequest = _automation.CreateCacheRequest(); cacheRequest.AddPattern(_patternIdTextPattern); // Now find the element that supports the Text Pattern. This test app assumes // there’s only one element that can be returned which supports the Text Pattern. bool fTextPatternSupported = true; IUIAutomationCondition conditionTextPattern = _automation.CreatePropertyCondition( _propertyIdIsTextPatternAvailable, fTextPatternSupported); IUIAutomationElement elementMailContent = elementMailAppWindow.FindFirstBuildCache( TreeScope.TreeScope_Descendants, conditionTextPattern, cacheRequest); // Because the Text Pattern object is cached, we don't have to make a cross-process // call here to get object. Later calls which actually use methods and properties // on the Text Pattern object will incur cross-proc calls. IUIAutomationTextPattern textPattern = (IUIAutomationTextPattern) elementMailContent.GetCachedPattern( _patternIdTextPattern); // This test app is only interested in getting all the e-mail text, so we get that through // the DocumentRange property. A more fully featured app might be interested in getting a // collection of Text Ranges from the e-mail. Each range might relate to an individual // word or paragraph. Given that a provider which supports the Text Pattern allows a // client to find the bounding rectangles of these ranges, the client could choose to use // its own method of highlighting the text as the text is being spoken. IUIAutomationTextRange rangeDocument = textPattern.DocumentRange; // Pass -1 here because we're not interested in limiting the amount of text here. strMailContent = rangeDocument.GetText(-1); } return(strMailContent); }