Export (0) Print
Expand All

Deprecated Control Pattern Functions

Note  The control pattern functions described in this section are deprecated. Client applications should use the COM interfaces described in the following sections:

Functions

DockPattern_SetDockPosition

Note  This function is deprecated. Client applications should use the Microsoft UI Automation COM interfaces instead.

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

ExpandCollapsePattern_Collapse

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

ExpandCollapsePattern_Expand

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

GridPattern_GetItem

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Gets the node for an item in a grid.

InvokePattern_Invoke

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Sends a request to activate a control and initiate its single, unambiguous action.

ItemContainerPattern_FindItemByProperty

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

LegacyIAccessiblePattern_DoDefaultAction

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Performs the Microsoft Active Accessibility default action for the element.

LegacyIAccessiblePattern_GetIAccessible

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

LegacyIAccessiblePattern_Select

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Performs a Microsoft Active Accessibility selection.

LegacyIAccessiblePattern_SetValue

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Sets the Microsoft Active Accessibility value property for the node.

MultipleViewPattern_GetViewName

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Retrieves the name of a control-specific view.

MultipleViewPattern_SetCurrentView

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Sets a control to a different layout.

RangeValuePattern_SetValue

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

ScrollItemPattern_ScrollIntoView

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

ScrollPattern_SetScrollPercent

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

SelectionItemPattern_AddToSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Adds an unselected element to a selection in a control.

SelectionItemPattern_RemoveFromSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Removes an element from the selection in a selection container.

SelectionItemPattern_Select

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Selects an element in a selection container.

SelectionPattern_GetSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Retrieves all items in the selection container that are currently selected.

SynchronizedInputPattern_Cancel

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

SynchronizedInputPattern_StartListening

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextPattern_get_DocumentRange

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Gets the text range for the entire document.

TextPattern_get_SupportedTextSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextPattern_GetSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextPattern_GetVisibleRanges

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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. For example, a multi-column layout where the columns are partially scrolled out of the visible area of the viewport and the content flows from the bottom of one column to the top of the next.

TextPattern_RangeFromChild

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Gets the text range that a given node spans.

TextPattern_RangeFromPoint

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_AddToSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Copies a text range.

TextRange_Compare

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Compares two text ranges.

TextRange_CompareEndpoints

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_ExpandToEnclosingUnit

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_FindAttribute

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_FindText

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_GetAttributeValue

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_GetBoundingRectangles

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_GetChildren

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_GetEnclosingElement

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_GetText

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_Move

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_MoveEndpointByRange

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_MoveEndpointByUnit

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_RemoveFromSelection

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

TextRange_Select

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Selects a text range.

TogglePattern_Toggle

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Toggles a control to its next supported state.

TransformPattern_Move

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Moves an element to a specified location on the screen.

TransformPattern_Resize

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Resizes an element on the screen.

TransformPattern_Rotate

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Rotates an element on the screen.

ValuePattern_SetValue

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Sets the text value of an element.

VirtualizedItemPattern_Realize

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Makes the virtual item fully accessible as a UI Automation element.

WindowPattern_Close

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

Closes an open window.

WindowPattern_SetVisualState

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

WindowPattern_WaitForInputIdle

Note  This function is deprecated. Client applications should use the UI Automation COM interfaces instead.

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

Community Additions

Show:
© 2014 Microsoft