Control Pattern Property Identifiers
This topic describes the named constants used to identify the properties associated with specific Microsoft UI Automation control patterns.
| Constant/value | Description |
|---|---|
|
Identifies the AnnotationTypeId property of the Annotation control pattern. Supported starting with Windows 8. This property indicates the type of an annotation. For a list of possible values, see Annotation Type Identifiers. Variant type: VT_I4 Default value: 0 |
|
Identifies the AnnotationTypeName property of the Annotation control pattern. Supported starting with Windows 8. This property is a localized string that contains the name of an annotation type. The name can correspond to one of the annotation type identifiers (for example, Comment for AnnotationType_Comment), but it is not required to. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Author property of the Annotation control pattern. Supported starting with Windows 8. This property is a string that contains the name of the person who authored the annotation. Variant type: VT_BSTR Default value: empty string |
|
Identifies the DateTime property of the Annotation control pattern. Supported starting with Windows 8. This property is a string that contains the date and time when the annotation was created. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Target property of the Annotation control pattern. Supported starting with Windows 8. This property is the IUIAutomationElement interface of the element that is being annotated. Variant type: VT_UNKNOWN Default value: NULL |
|
Identifies the DockPosition property of the Dock control pattern. This property indicates the dock position of the automation element within a docking container, and is expressed as a value from the DockPosition enumerated type. Variant type: VT_I4 Default value: DockPosition_None |
|
Identifies the DropEffect property of the Drag control pattern. Supported starting with Windows 8. This property indicates what happens when an element is dropped as part of a drag-drop operation. Variant type: VT_BSTR Default value: empty string |
|
Identifies the DropEffects property of the Drag control pattern. Supported starting with Windows 8. This property is a collection of strings that enumerate the possible effects that can happen when an element is dropped as part of a drag-drop operation. Variant type: VT_BSTR | VT_ARRAY Default value: empty array |
|
Identifies the IsGrabbed property of the Drag control pattern. Supported starting with Windows 8. This property indicates whether an element is being dragged. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the GrabbedItems property of the Drag control pattern. Supported starting with Windows 8. This property is a collection of elements that are being dragged as part of a drag operation. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the DropTargetEffect property of the DropTarget control pattern. Supported starting with Windows 8. This property indicates the current drop effect for the element being dragged. Variant type: VT_BSTR Default value: empty string |
|
Identifies the DropTargetEffects property of the DropTarget control pattern. Supported starting with Windows 8. This property indicates the possible drop effects that can happen when an element is dropped on a drop target. Variant type: VT_BSTR | VT_ARRAY Default value: empty array |
|
Identifies the ExpandCollapseState property of the ExpandCollapse control pattern. This property indicates the current state, expanded or collapsed, of the automation element, and is expressed as a value from the ExpandCollapseState enumerated type. Variant type: VT_I4 Default value: ExpandCollapseState_LeafNode |
|
Identifies the ColumnCount property of the Grid control pattern. This property indicates the total number of columns in the grid. Variant type: VT_I4 Default value: 0 |
|
Identifies the Column property of the GridItem control pattern. This property indicates the ordinal number of the column that contains the cell or item. Variant type: VT_I4 Default value: 0 |
|
Identifies the ColumnSpan property of the GridItem control pattern. This property indicates the number of columns spanned by the cell or item. Variant type:VT_I4 Default value: 1 |
|
Identifies the ContainingGrid property of the GridItem control pattern. This property is the IUIAutomationElement interface pointer of the automation element that contains the cell or item. The container element implements the Grid control pattern (IGridProvider). Variant type: VT_UNKNOWN Default value: NULL |
|
Identifies the Row property of the GridItem control pattern. This property is the ordinal number of the row that contains the cell or item. Variant type: VT_I4 Default value: 0 |
|
Identifies the RowSpan property of the GridItem control pattern. This property indicates the number of rows spanned by the cell or item. Variant type: VT_I4 Default value: 1 |
|
Identifies the RowCount property of the Grid control pattern. This property indicates the total number of rows in the grid. Variant type: VT_I4 Default value: 0 |
|
Identifies the ChildId property of the LegacyIAccessible control pattern. This property is the Microsoft Active Accessibility (MSAA) child identifier of the automation element. Variant type: VT_I4 Default value: 0 |
|
Identifies the DefaultAction property of the LegacyIAccessible control pattern. This property is the MSAA default action (accDefaultAction) for the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Description property of the LegacyIAccessible control pattern. This property is the MSAA description (accDescription) for the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Help property of the LegacyIAccessible control pattern. This property is the MSAA help string (accHelp) for the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the KeyboardShortcut property of the LegacyIAccessible control pattern. This property is the MSAA keyboard shortcut string (accKeyboardShortcut) for the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Name property of the LegacyIAccessible control pattern. This property is the MSAA name string (accName) for the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Roleproperty of the LegacyIAccessible control pattern. This property is the MSAA role identifier (accRole) for the automation element. Variant type: VT_I4 Default value: 0 |
|
Identifies the Selection property of the LegacyIAccessible control pattern. This property is the MSAA list of selected items (accSelection) in the control represented by the automation element. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the State property of the LegacyIAccessible control pattern. This property is the MSAA state (accState) of the automation element. Variant type: VT_I4 Default value: 0 |
|
Identifies the Value property of the LegacyIAccessible control pattern. This property is the MSAA value (accValue) of the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the CurrentView property of the MultipleView control pattern. This property indicates the current view state of the automation element. Variant type: VT_I4 Default value: 0 |
|
Identifies the SupportedViews property of the MultipleView control pattern. This property is a list of identifiers for the view states supported by the automation element. Variant type: VT_I4 | VT_ARRAY Default value: empty array |
|
Identifies the IsReadOnly property of the RangeValue control pattern. This property indicates whether the value of the automation element is read-only. Variant type: VT_BOOL Default value: TRUE |
|
Identifies the LargeChange property of the RangeValue control pattern. This property is the large-change value, unique to the automation element, that is added to or subtracted from the Value property. Variant type: VT_R8 Default value: 0 |
|
Identifies the Maximum property of the RangeValue control pattern. This property is the maximum range value supported by the automation element. Variant type: VT_R8 Default value: 0 |
|
Identifies the Minimum property of the RangeValue control pattern. This property is the minimum range value supported by the automation element. Variant type: VT_R8 Default value: 0 |
|
Identifies the SmallChange property of the RangeValue control pattern. This property is the small-change value, unique to the automation element, that is added to or subtracted from the Value property. Variant type: VT_R8 Default value: 0 |
|
Identifies the Value property of the RangeValue control pattern. This property is the current value of the automation element. Variant type: VT_R8 Default value: 0 |
|
Identifies the HorizontallyScrollable property of the Scroll control pattern. This property indicates whether the automation element can scroll horizontally. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the HorizontalScrollPercent property of the Scroll control pattern. This property is the current horizontal scroll position expressed as a percentage of the total content area within the automation element. Variant type: VT_R8 Default value: 0 |
|
Identifies the HorizontalViewSize property of the Scroll control pattern. This property is the horizontal size of the viewable region expressed as a percentage of the total content area within the element. Variant type: VT_R8 Default value: 100 |
|
Identifies the VerticallyScrollable property of the Scroll control pattern. This property indicates whether the automation element can scroll vertically. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the VerticalScrollPercent property of the Scroll control pattern. This property is the current vertical scroll position expressed as a percentage of the total content area within the automation element. Variant type: VT_R8 Default value: 0 |
|
Identifies the VerticalViewSize property of the Scroll control pattern. This property is the vertical size of the viewable region expressed as a percentage of the total content area within the element. Variant type: VT_R8 Default value: 100 |
|
Identifies the CanSelectMultiple property of the Selection control pattern. This property indicates whether the automation element allows more than one child element to be selected concurrently. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the IsSelectionRequired property of the Selection control pattern. This property indicates whether the automation element requires at least one child item to be selected. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the Selection property of the Selection control pattern. This property is a collection of the selected child elements, and is expressed as an IUIAutomationElementArray pointer. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the IsSelected property of the SelectionItem control pattern. This property indicates whether the automation element is selected. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the SelectionContainer property of the SelectionItem control pattern. This property is the IUIAutomationElement interface pointer for the automation element that contains the current element. Variant type: VT_UNKNOWN Default value: NULL |
|
Identifies the Formula property of the SpreadsheetItem control pattern. This property is a string that contains the formula for the spreadsheet cell. Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string |
|
Identifies the AnnotationObjects property of the SpreadsheetItem control pattern. This property is a collection of UI Automation elements representing the annotations associated with the spreadsheet cell. The collection is expressed as an IUIAutomationElementArray interface. Supported starting with Windows 8. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the AnnotationTypes property of the SpreadsheetItem control pattern. Supported starting with Windows 8. This property is array of annotation type identifiers, one for each type of annotation associated with the spreadsheet cell. For a list of possible values, see Annotation Type Identifiers. Variant type: VT_I4 | VT_ARRAY Default value: empty array |
|
Identifies the ExtendedProperties property of the Styles control pattern. This property contains a localized, formatted string that contains additional properties that are not included in the Styles control pattern, but that provide information about the document content that might be useful to the user. The format of the string is as follows: "prop1=value;prop2=value2". Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string |
|
Identifies the FillColor property of the Styles control pattern. This property specifies the color used to fill an element. This property is expressed as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Supported starting with Windows 8. Variant type: VT_I4 Default value: 0 |
|
Identifies the FillPatternColor property of the Styles control pattern. This property specifies the color of the pattern used to fill an element. This property is expressed as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Supported starting with Windows 8. Variant type: VT_I4 Default value: 0 |
|
Identifies the FillPatternStyle property of the Styles control pattern. This property is a localized string that contains the style of the pattern used to fill an element, such as "Vertical Stripe". Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string |
|
Identifies the Shape property of the Styles control pattern. This property is a localized string that indicates the shape of the element. Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string |
|
Identifies the StyleId property of the Styles control pattern. This property identifies the visual style of the element. For a list of possible values, see Style Identifiers. Supported starting with Windows 8. Variant type: VT_I4 Default value: 0 |
|
Identifies the StyleName property of the Styles control pattern. This property is the name of the visual style of the element. Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string |
|
Identifies the ColumnHeaders property of the Table control pattern. This property is a collection of automation elements for all column headers in the table, and is expressed as an IUIAutomationElementArray interface pointer. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the ColumnHeaderItems property of the TableItem control pattern. This property is a collection of automation elements for all column headers in the table item or cell, and is expressed as an IUIAutomationElementArray interface pointer. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the RowHeaders property of the Table control pattern. This property is a collection of automation elements for all row headers in the table, and is expressed as an IUIAutomationElementArray interface pointer. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the RowOrColumnMajor property of the Table control pattern. This property indicates the primary direction of traversal for the table, and is expressed as a value from the RowOrColumnMajor enumerated type. Variant type: VT_I4 Default value: RowOrColumnMajor_Indeterminate |
|
Identifies the RowHeaderItems property of the TableItem control pattern. This property is a collection of automation elements for all row headers in the table item or cell, and is expressed as an IUIAutomationElementArray interface pointer. Variant type: VT_UNKNOWN | VT_ARRAY Default value: empty array |
|
Identifies the ToggleState property of the Toggle control pattern. This property indicates the toggle state of the automation element, and is expressed as a value from the ToggleState enumerated type. Variant type: VT_I4 Default value: ToggleState_Indeterminate |
|
Identifies the CanMove property of the Transform control pattern. This property indicates whether the automation element can be moved. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the CanResize property of the Transform control pattern. This property indicates whether the automation element can be resized. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the CanRotate property of the Transform control pattern. This property indicates whether the automation element can be rotated. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the CanZoom property of the Transform control pattern. This property indicates whether the control supports zooming of its viewport. Supported starting with Windows 8. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the ZoomLevel property of the Transform control pattern. Supported starting with Windows 8. This property indicates the current zooming level of the control's viewport. Variant type: VT_R8 Default value: 1 |
|
Identifies the ZoomMaximum property of the Transform control pattern. Supported starting with Windows 8. This property indicates the maximum zooming level supported by the control's viewport. Variant type: VT_R8 Default value: 1 |
|
Identifies the ZoomMinimum property of the Transform control pattern. Supported starting with Windows 8. This property indicates the minimum zooming level supported by the control's viewport. Variant type: VT_R8 Default value: 1 |
|
Identifies the IsReadOnly property of the Value control pattern. This property indicates whether the value of the automation element is read-only. Variant type: VT_BOOL Default value: TRUE |
|
Identifies the Value property of the Value control pattern. This property indicates the value of the automation element. Variant type: VT_BSTR Default value: empty string |
|
Identifies the CanMaximize property of the Window control pattern. This property indicates whether the window can be maximized. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the CanMinimize property of the Window control pattern. This property indicates whether the window can be minimized. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the IsModal property of the Window control pattern. This property indicates whether the window is modal. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the IsTopmost property of the Window control pattern. This property indicates whether the window is the topmost element in the z-order. Variant type: VT_BOOL Default value: FALSE |
|
Identifies the WindowInteractionState property of the Window control pattern. This property indicates the state of the window for the purposes of user interaction, and is expressed as a value from the WindowInteractionState enumerated type. Variant type: VT_I4 Default value: WindowInteractionState_Running |
|
Identifies the WindowVisualState property of the Window control pattern. This property indicates the visual state of the window, and is expressed as a value from the WindowVisualState enumerated type. Variant type: VT_I4 Default value: WindowVisualState_Normal |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows XP [desktop apps | UWP apps] |
| Minimum supported server |
Windows Server 2003 [desktop apps | UWP apps] |
| Header |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for