uiautomationcoreapi.h header

This header is used by Windows Accessibility Features. For more information, see:

uiautomationcoreapi.h contains the following programming interfaces:

Functions

 
DockPattern_SetDockPosition

Docks the UI Automation element at the requested dockPosition within a docking container.
ExpandCollapsePattern_Collapse

Hides all descendant nodes, controls, or content of the UI Automation element.
ExpandCollapsePattern_Expand

Expands a control on the screen so that it shows more information.
GridPattern_GetItem

Gets the node for an item in a grid.
InvokePattern_Invoke

Sends a request to activate a control and initiate its single, unambiguous action. (InvokePattern_Invoke)
ItemContainerPattern_FindItemByProperty

Retrieves a node within a containing node, based on a specified property value.
LegacyIAccessiblePattern_DoDefaultAction

Performs the Microsoft Active Accessibility default action for the element. (LegacyIAccessiblePattern_DoDefaultAction)
LegacyIAccessiblePattern_GetIAccessible

Retrieves an IAccessible object that corresponds to the UI Automation element.
LegacyIAccessiblePattern_Select

Performs a Microsoft Active Accessibility selection. (LegacyIAccessiblePattern_Select)
LegacyIAccessiblePattern_SetValue

Sets the Microsoft Active Accessibility value property for the node.
MultipleViewPattern_GetViewName

Retrieves the name of a control-specific view. (MultipleViewPattern_GetViewName)
MultipleViewPattern_SetCurrentView

Sets a control to a different layout.
RangeValuePattern_SetValue

Sets the value of a control that has a numerical range.
ScrollItemPattern_ScrollIntoView

Scrolls the content area of a container object in order to display the UI Automation element within the visible region (viewport) of the container.
ScrollPattern_Scroll

Scrolls the currently visible region of the content area the specified ScrollAmount, horizontally, vertically, or both.
ScrollPattern_SetScrollPercent

Scrolls a container to a specific position horizontally, vertically, or both.
SelectionItemPattern_AddToSelection

Adds an unselected element to a selection in a control.
SelectionItemPattern_RemoveFromSelection

Removes an element from the selection in a selection container.
SelectionItemPattern_Select

Selects an element in a selection container.
SynchronizedInputPattern_Cancel

Causes the UI Automation provider to stop listening for mouse or keyboard input.
SynchronizedInputPattern_StartListening

Causes the UI Automation provider to start listening for mouse or keyboard input.
TextPattern_get_DocumentRange

Gets the text range for the entire document.
TextPattern_get_SupportedTextSelection

Ascertains whether the text container's contents can be selected and deselected.
TextPattern_GetSelection

Gets the current range of selected text from a text container supporting the text pattern.
TextPattern_GetVisibleRanges

Retrieves an array of disjoint text ranges from a text container where each text range begins with the first partially visible line through to the end of the last partially visible line.
TextPattern_RangeFromChild

Gets the text range that a given node spans.
TextPattern_RangeFromPoint

Retrieves the degenerate (empty) text range nearest to the specified screen coordinates. (TextPattern_RangeFromPoint)
TextRange_AddToSelection

Adds to the existing collection of highlighted text in a text container that supports multiple, disjoint selections by highlighting supplementary text corresponding to the calling text range Start and End endpoints.
TextRange_Clone

Copies a text range.
TextRange_Compare

Compares two text ranges.
TextRange_CompareEndpoints

Returns a value indicating whether two text ranges have identical endpoints.
TextRange_ExpandToEnclosingUnit

Expands the text range to a larger or smaller unit such as Character, Word, Line, or Page.
TextRange_FindAttribute

Searches in a specified direction for the first piece of text supporting a specified text attribute.
TextRange_FindText

Returns the first text range in the specified direction that contains the text the client is searching for.
TextRange_GetAttributeValue

Gets the value of a text attribute for a text range.
TextRange_GetBoundingRectangles

Retrieves the minimum number of bounding rectangles that can enclose the range, one rectangle per line.
TextRange_GetChildren

Returns all UI Automation elements contained within the specified text range.
TextRange_GetEnclosingElement

Returns the node for the next smallest provider that covers the range.
TextRange_GetText

Returns the text in a text range, up to a specified number of characters.
TextRange_Move

Moves the text range the specified number of units requested by the client.
TextRange_MoveEndpointByRange

Moves an endpoint of one range to the endpoint of another range.
TextRange_MoveEndpointByUnit

Moves an endpoint of the range the specified number of units.
TextRange_RemoveFromSelection

Removes the selected text, corresponding to the calling text range TextPatternRangeEndpoint_Start and TextPatternRangeEndpoint_End endpoints, from an existing collection of selected text in a text container that supports multiple, disjoint selections.
TextRange_ScrollIntoView

Scrolls the text so the specified range is visible in the viewport.
TextRange_Select

Selects a text range.
TogglePattern_Toggle

Toggles a control to its next supported state.
TransformPattern_Move

Moves an element to a specified location on the screen.
TransformPattern_Resize

Resizes an element on the screen.
TransformPattern_Rotate

Rotates an element on the screen.
UiaAddEvent

Adds a listener for events on a node in the UI Automation tree.
UiaClientsAreListening

Gets a value that indicates whether any client application is subscribed to Microsoft UI Automation events.
UiaDisconnectAllProviders

Releases all Microsoft UI Automation resources that are held by all providers associated with the calling process.
UiaDisconnectProvider

Releases all references that a particular provider holds to Microsoft UI Automation objects.
UiaEventAddWindow

Adds a window to the event listener.
UiaEventRemoveWindow

Removes a window from the event listener.
UiaFind

Retrieves one or more UI Automation nodes that match the search criteria.
UiaGetErrorDescription

Gets an error string so that it can be passed to the client. This method is not used directly by clients.
UiaGetPatternProvider

Retrieves a control pattern.
UiaGetPropertyValue

Retrieves the value of a UI Automation property.
UiaGetReservedMixedAttributeValue

Retrieves a reserved value indicating that the value of a Microsoft UI Automation text attribute varies within a text range.
UiaGetReservedNotSupportedValue

Retrieves a reserved value indicating that a Microsoft UI Automation property or a text attribute is not supported.
UiaGetRootNode

Retrieves the root UI Automation node.
UiaGetRuntimeId

Retrieves the runtime identifier of a UI Automation node.
UiaGetUpdatedCache

Updates the cache of property values and control patterns.
UiaHasServerSideProvider

Ascertains whether a window has a Microsoft UI Automation provider implementation.
UiaHostProviderFromHwnd

Gets the host provider for a window.
UiaHPatternObjectFromVariant

Gets a control pattern object from a VARIANT type.
UiaHTextRangeFromVariant

Gets a text range from a VARIANT type.
UiaHUiaNodeFromVariant

Gets an HUIANODE from a VARIANT type.
UiaIAccessibleFromProvider

Retrieves an IAccessible implementation that provides Microsoft Active Accessibility data on behalf of a Microsoft UI Automation provider.
UiaLookupId

Gets the integer identifier that can be used in methods that require a PROPERTYID, PATTERNID, CONTROLTYPEID, TEXTATTRIBUTEID, or EVENTID.
UiaNavigate

Navigates in the UI Automation tree, optionally retrieving cached information.
UiaNodeFromFocus

Retrieves the UI Automation node for the UI element that currently has input focus.
UiaNodeFromHandle

Retrieves the UI Automation node associated with a window.
UiaNodeFromPoint

Retrieves the UI Automation node for the element at the specified point.
UiaNodeFromProvider

Retrieves the UI Automation node for a raw element provider.
UiaNodeRelease

Deletes a node from memory.
UiaPatternRelease

Deletes an allocated pattern object from memory.
UiaProviderForNonClient

Gets the provider for the entire non-client area of a window, or for a control in the non-client area of a window.
UiaProviderFromIAccessible

Creates a Microsoft UI Automation provider based on the specified Microsoft Active Accessibility object.
UiaRaiseActiveTextPositionChangedEvent

Called by a provider to notify the Microsoft UI Automation core that a text control has programmatically changed text. (UiaRaiseActiveTextPositionChangedEvent)
UiaRaiseAsyncContentLoadedEvent

Called by a provider to notify the Microsoft UI Automation core that content is being loaded asynchronously.
UiaRaiseAutomationEvent

Notifies listeners of an event.
UiaRaiseAutomationPropertyChangedEvent

Called by providers to notify the Microsoft UI Automation core that an element property has changed.
UiaRaiseChangesEvent

Called by providers to notify the Microsoft UI Automation core that a change has occurred.
UiaRaiseNotificationEvent

Called by providers to initiate a notification event.
UiaRaiseStructureChangedEvent

Called by a provider to notify the Microsoft UI Automation core that the tree structure has changed.
UiaRaiseTextEditTextChangedEvent

Called by a provider to notify the Microsoft UI Automation core that a text control has programmatically changed text. (UiaRaiseTextEditTextChangedEvent)
UiaRectIsEmpty

Gets a Boolean value that specifies whether a rectangle has all its coordinates set to 0.
UiaRectSetEmpty

Sets the elements of a UiaRect structure to 0.
UiaRegisterProviderCallback

Registers the application-defined method that is called by UI Automation to obtain a provider for an element.
UiaRemoveEvent

Removes a listener for events on a node in the UI Automation tree.
UiaReturnRawElementProvider

Gets an interface to the UI Automation provider for a window.
UiaSetFocus

Sets the input focus to the specified element in the UI.
UiaTextRangeRelease

Deletes an allocated text range object from memory.
ValuePattern_SetValue

Sets the text value of an element.
VirtualizedItemPattern_Realize

Makes the virtual item fully accessible as a UI Automation element. (VirtualizedItemPattern_Realize)
WindowPattern_Close

Closes an open window.
WindowPattern_SetWindowVisualState

Sets the visual state of a window; for example, to maximize a window.
WindowPattern_WaitForInputIdle

Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first. (WindowPattern_WaitForInputIdle)

Callback functions

 
UiaEventCallback

A client-implemented function that is called by UI Automation when an event is raised that the client has subscribed to.
UiaProviderCallback

An application-defined function that is called by UI Automation to obtain a client-side provider for an element.

Structures

 
UiaAndOrCondition

Note  This structure is deprecated.  Contains information about a complex condition.
UiaAsyncContentLoadedEventArgs

Note  This structure is deprecated.  Contains information about an event raised when content is being asynchronously loaded by a UI element.
UiaCacheRequest

Note  This structure is deprecated.  Contains information about a request to cache data about UI Automation elements.
UiaCondition

Note  This structure is deprecated.  Contains information about a condition.
UiaEventArgs

Note  This structure is deprecated.  Contains information about a Microsoft UI Automation event.
UiaFindParams

Note  This structure is deprecated.  Contains parameters used in the UiaFind function.
UiaNotCondition

Note  This structure is deprecated.  Contains information about a negative condition.
UiaPropertyChangedEventArgs

Note  This structure is deprecated.  Contains information about an event that is raised when a Microsoft UI Automation element property change occurs.
UiaPropertyCondition

Note  This structure is deprecated.  Contains information about a condition used to find UI Automation elements that have a matching property.
UiaStructureChangedEventArgs

Note  This structure is deprecated.  Contains information about an event that is raised when the structure of the Microsoft UI Automation tree changes.
UiaWindowClosedEventArgs

Note  This structure is deprecated.  Contains information about an event that is raised when one or more windows closes.

Enumerations

 
AsyncContentLoadedState

Contains values that describe the progress of asynchronous loading of content.
AutomationElementMode

The AutomationElementMode (uiautomationcoreapi.h) enumeration contains values that specify the type of reference to use when returning UI Automation elements.
AutomationIdentifierType

Contains values used in the UiaLookupId function.
ConditionType

Contains values that specify a type of UiaCondition.
EventArgsType

Contains values that specify the event type described by a UiaEventArgs structure.
NormalizeState

Contains values that specify the behavior of UiaGetUpdatedCache.
PropertyConditionFlags

The PropertyConditionFlags (uiautomationcoreapi.h) enumeration contains values used in creating property conditions.
ProviderType

Contains values that specify the type of a client-side (proxy) UI Automation provider.
TreeScope

The TreeScope (uiautomationcoreapi.h) enumeration contains values that specify the scope of various operations in the Microsoft UI Automation tree.
TreeTraversalOptions

The TreeTraversalOptions (uiautomationcoreapi.h) enumeration defines values that can be used to customize tree navigation order.