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
UIA_AnnotationAnnotationTypeIdPropertyId
30113
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
UIA_AnnotationAnnotationTypeNamePropertyId
30114
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
UIA_AnnotationAuthorPropertyId
30115
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
UIA_AnnotationDateTimePropertyId
30116
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
UIA_AnnotationTargetPropertyId
30117
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
UIA_DockDockPositionPropertyId
30069
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
UIA_DragDropEffectPropertyId
30139
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
UIA_DragDropEffectsPropertyId
30140
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
UIA_DragIsGrabbedPropertyId
30138
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
UIA_DragGrabbedItemsPropertyId
30144
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
UIA_DropTargetDropTargetEffectPropertyId
30142
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
UIA_DropTargetDropTargetEffectsPropertyId
30143
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
UIA_ExpandCollapseExpandCollapseStatePropertyId
30070
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
UIA_GridColumnCountPropertyId
30063
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
UIA_GridItemColumnPropertyId
30065
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
UIA_GridItemColumnSpanPropertyId
30067
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
UIA_GridItemContainingGridPropertyId
30068
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
UIA_GridItemRowPropertyId
30064
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
UIA_GridItemRowSpanPropertyId
30066
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
UIA_GridRowCountPropertyId
30062
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
UIA_LegacyIAccessibleChildIdPropertyId
30091
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
UIA_LegacyIAccessibleDefaultActionPropertyId
30100
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
UIA_LegacyIAccessibleDescriptionPropertyId
30094
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
UIA_LegacyIAccessibleHelpPropertyId
30097
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
UIA_LegacyIAccessibleKeyboardShortcutPropertyId
30098
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
UIA_LegacyIAccessibleNamePropertyId
30092
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
UIA_LegacyIAccessibleRolePropertyId
30095
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
UIA_LegacyIAccessibleSelectionPropertyId
30099
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
UIA_LegacyIAccessibleStatePropertyId
30096
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
UIA_LegacyIAccessibleValuePropertyId
30093
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
UIA_MultipleViewCurrentViewPropertyId
30071
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
UIA_MultipleViewSupportedViewsPropertyId
30072
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
UIA_RangeValueIsReadOnlyPropertyId
30048
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
UIA_RangeValueLargeChangePropertyId
30051
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
UIA_RangeValueMaximumPropertyId
30050
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
UIA_RangeValueMinimumPropertyId
30049
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
UIA_RangeValueSmallChangePropertyId
30052
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
UIA_RangeValueValuePropertyId
30047
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
UIA_ScrollHorizontallyScrollablePropertyId
30057
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
UIA_ScrollHorizontalScrollPercentPropertyId
30053
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
UIA_ScrollHorizontalViewSizePropertyId
30054
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
UIA_ScrollVerticallyScrollablePropertyId
30058
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
UIA_ScrollVerticalScrollPercentPropertyId
30055
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
UIA_ScrollVerticalViewSizePropertyId
30056
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
UIA_SelectionCanSelectMultiplePropertyId
30060
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
UIA_SelectionIsSelectionRequiredPropertyId
30061
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
UIA_SelectionSelectionPropertyId
30059
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
UIA_SelectionItemIsSelectedPropertyId
30079
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
UIA_SelectionItemSelectionContainerPropertyId
30080
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
UIA_SpreadsheetItemFormulaPropertyId
30129
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
UIA_SpreadsheetItemAnnotationObjectsPropertyId
30130
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
UIA_SpreadsheetItemAnnotationTypesPropertyId
30131
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
UIA_StylesExtendedPropertiesPropertyId
30126
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
UIA_StylesFillColorPropertyId
30122
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
UIA_StylesFillPatternColorPropertyId
30125
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
UIA_StylesFillPatternStylePropertyId
30123
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
UIA_StylesShapePropertyId
30124
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
UIA_StylesStyleIdPropertyId
30120
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
UIA_StylesStyleNamePropertyId
30121
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
UIA_TableColumnHeadersPropertyId
30082
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
UIA_TableItemColumnHeaderItemsPropertyId
30085
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
UIA_TableRowHeadersPropertyId
30081
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
UIA_TableRowOrColumnMajorPropertyId
30083
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
UIA_TableItemRowHeaderItemsPropertyId
30084
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
UIA_ToggleToggleStatePropertyId
30086
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
UIA_TransformCanMovePropertyId
30087
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
UIA_TransformCanResizePropertyId
30088
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
UIA_TransformCanRotatePropertyId
30089
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
UIA_Transform2CanZoomPropertyId
30133
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
UIA_Transform2ZoomLevelPropertyId
30145
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
UIA_Transform2ZoomMaximumPropertyId
30147
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
UIA_Transform2ZoomMinimumPropertyId
30146
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
UIA_ValueIsReadOnlyPropertyId
30046
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
UIA_ValueValuePropertyId
30045
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
UIA_WindowCanMaximizePropertyId
30073
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
UIA_WindowCanMinimizePropertyId
30074
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
UIA_WindowIsModalPropertyId
30077
Identifies the IsModal property of the Window control pattern.
This property indicates whether the window is modal.
Variant type: VT_BOOL
Default value: FALSE
UIA_WindowIsTopmostPropertyId
30078
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
UIA_WindowWindowInteractionStatePropertyId
30076
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
UIA_WindowWindowVisualStatePropertyId
30075
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

Minimum supported client
Windows XP [desktop apps | UWP apps]
Minimum supported server
Windows Server 2003 [desktop apps | UWP apps]
Header
UIAutomationClient.h

See also

Conceptual

UI Automation Properties Overview

Retrieving Properties from UI Automation Elements

UI Automation Control Patterns Overview