Documentation
Download compressed HTML Help
     

Constants


Detailed Description


Error codes

Error Code Description
RX_ERROR_ITEM_NOT_FOUND The specified item cannot be found.
RX_ERROR_INVALID_PARAMETER The used parameter is invalid.
RX_ERROR_INVALID_HANDLE The used handle is invalid.
RX_ERROR_MENU_NOT_FOUND The specified menu item cannot be found.


Element Roles

Role Description
ROLE_SYSTEM_ALERT The object represents an alert or a condition that a user should be notified about. This role is used only for objects that embody an alert but are not associated with another user interface element such as a message box, graphic, text, or sound.
ROLE_SYSTEM_ANIMATION The object represents an animation control, which contains content that changes over time, such as a control that displays a series of bitmap frames. Animation controls are displayed when files are copied, or when some other time-consuming task is performed.
ROLE_SYSTEM_APPLICATION The object represents a main window for an application.
ROLE_SYSTEM_BORDER The object represents a window border. The entire border is represented by a single object rather than by separate objects for each side.
ROLE_SYSTEM_BUTTONDROPDOWN The object represents a button that drops down a list of items.
ROLE_SYSTEM_BUTTONDROPDOWNGRID The object represents a button that drops down a grid.
ROLE_SYSTEM_BUTTONMENU The object represents a button that drops down a menu.
ROLE_SYSTEM_CARET The object represents the system caret.
ROLE_SYSTEM_CELL The object represents a cell within a table.
ROLE_SYSTEM_CHARACTER The object represents a cartoon-like graphic object, such as Microsoft Office Assistant, which is displayed to provide help to users of an application.
ROLE_SYSTEM_CHART The object represents a graphical image used to represent data.
ROLE_SYSTEM_CHECKBUTTON The object represents a check box control, an option that is turned on or off independently of other options.
ROLE_SYSTEM_CLIENT The object represents a window's client area. Active Accessibility uses this role as a default if there is a question about the role of a UI element.
ROLE_SYSTEM_CLOCK The object represents a control that displays time.
ROLE_SYSTEM_COLUMN The object represents a column of cells within a table.
ROLE_SYSTEM_COLUMNHEADER The object represents a column header, providing a visual label for a column in a table.
ROLE_SYSTEM_COMBOBOX The object represents a combo box; an edit control with an associated list box that provides a set of predefined choices.
ROLE_SYSTEM_CURSOR The object represents the system mouse pointer.
ROLE_SYSTEM_DIAGRAM The object represents a graphical image used to diagram data.
ROLE_SYSTEM_DIAL The object represents a dial or knob.
ROLE_SYSTEM_DIALOG The object represents a dialog box or message box.
ROLE_SYSTEM_DOCUMENT The object represents a document window. A document window is always contained within an application window. This role applies only to multiple-document interface (MDI) windows and refers to the object that contains the MDI title bar.
ROLE_SYSTEM_DROPLIST The object represents the calendar control, SysDateTimePick32. Oleacc uses this role to indicate that Active Accessibility has found either a date or a calendar control.
ROLE_SYSTEM_EQUATION The object represents a mathematical equation.
ROLE_SYSTEM_GRAPHIC The object represents a picture.
ROLE_SYSTEM_GRIP The object represents a special mouse pointer, which allows a user to manipulate user interface elements such as windows. For example, a user clicks and drags a sizing grip in the lower-right corner of a window to resize it.
ROLE_SYSTEM_GROUPING The object logically groups other objects. There is not always a parent-child relationship between the grouping object and the objects it contains.
ROLE_SYSTEM_HELPBALLOON The object displays a Help topic in the form of a ToolTip or Help balloon.
ROLE_SYSTEM_HOTKEYFIELD The object represents a hot-key field that allows the user to enter a combination or sequence of keystrokes.
ROLE_SYSTEM_INDICATOR The object represents an indicator, such as a pointer graphic, that points to the current item.
ROLE_SYSTEM_IPADDRESS The object represents an edit control designed for an Internet Protocol (IP) address. The edit control is divided into sections for the different parts of the IP address.
ROLE_SYSTEM_LINK The object represents a link to something else. This object might look like text or a graphic, but it acts like a button.
ROLE_SYSTEM_LIST The object represents a list box, allowing the user to select one or more items.
ROLE_SYSTEM_LISTITEM The object represents an item in a list box or the list portion of a combo box, drop-down list box, or drop-down combo box.
ROLE_SYSTEM_MENUBAR The object represents the menu bar (positioned beneath the title bar of a window) from which menus are selected by the user.
ROLE_SYSTEM_MENUITEM The object represents a menu item, which is an entry in a menu that a user can choose to carry out a command, select an option, or display another menu. Functionally, a menu item is equivalent to a push button, radio button, check box, or menu.
ROLE_SYSTEM_MENUPOPUP The object represents a menu, which presents a list of options from which the user can make a selection to perform an action. All menu types must have this role, including drop-down menus that are displayed by selecting from a menu bar, and shortcut menus that are displayed by clicking the right mouse button.
ROLE_SYSTEM_OUTLINE The object represents an outline or tree structure, such as a tree view control, that displays a hierarchical list and allows the user to expand and collapse branches.
ROLE_SYSTEM_OUTLINEBUTTON The object represents items that navigate like an outline item. You can use the up and down arrows to move through the outline. However, instead of expanding and collapsing the menus by using left and right arrow keys, these menus expand or collapse when the space bar or enter key is pressed and the item has focus.
ROLE_SYSTEM_OUTLINEITEM The object represents an item in an outline or tree structure.
ROLE_SYSTEM_PAGETAB The object represents a page tab. The only child of a page tab control is a ROLE_SYSTEM_GROUPING object that contains the contents of the associated page.
ROLE_SYSTEM_PAGETABLIST The object represents a container of page tab controls.
ROLE_SYSTEM_PANE The object represents a pane within a frame or document window. Users can navigate between panes and within the contents of the current pane, but cannot navigate between items in different panes. Thus, panes represent a level of grouping lower than frame windows or documents, but above individual controls. The user navigates between panes by pressing TAB, F6, or CTRL+TAB, depending on the context.
ROLE_SYSTEM_PROGRESSBAR The object represents a progress bar, dynamically showing the user the percent complete of an operation in progress. This control takes no user input.
ROLE_SYSTEM_PROPERTYPAGE The object represents a property sheet.
ROLE_SYSTEM_PUSHBUTTON The object represents a push button control.
ROLE_SYSTEM_RADIOBUTTON The object represents an option button, also called a radio button. It is one of a group of mutually exclusive options. All objects sharing a single parent that have this attribute are assumed to be part of single mutually exclusive group. Use ROLE_SYSTEM_GROUPING objects to divide them into separate groups.
ROLE_SYSTEM_ROW The object represents a row of cells within a table.
ROLE_SYSTEM_ROWHEADER The object represents a row header, which provides a visual label for a table row.
ROLE_SYSTEM_SCROLLBAR The object represents a vertical or horizontal scroll bar, which is part of the client area or used in a control.
ROLE_SYSTEM_SEPARATOR The object is used to visually divide a space into two regions, such as a separator menu item or a bar that divides split panes within a window.
ROLE_SYSTEM_SLIDER The object represents a slider, which allows the user to adjust a setting in given increments between minimum and maximum values.
ROLE_SYSTEM_SOUND The object represents a system sound, which is associated with various system events.
ROLE_SYSTEM_SPINBUTTON The object represents a spin box, which is a control that allows the user to increment or decrement the value displayed in a separate "buddy" control associated with the spin box.
ROLE_SYSTEM_SPLITBUTTON The role represents a button on a toolbar that has a drop-down list icon directly adjacent to the button.
ROLE_SYSTEM_STATICTEXT The object represents read-only text, such as labels for other controls or instructions in a dialog box. Static text cannot be modified or selected.
ROLE_SYSTEM_STATUSBAR The object represents a status bar, which is an area at the bottom of a window that displays information about the current operation, state of the application, or selected object. The status bar has multiple fields, which display different kinds of information.
ROLE_SYSTEM_TABLE The object represents a table that contains rows and columns of cells, and optionally, row headers and column headers.
ROLE_SYSTEM_TEXT The object represents selectable text that allows edits or is designated read-only.
ROLE_SYSTEM_TITLEBAR The object represents a title or caption bar for a window.
ROLE_SYSTEM_TOOLBAR The object represents a toolbar, which is a grouping of controls that provides easy access to frequently used features.
ROLE_SYSTEM_TOOLTIP The object represents a ToolTip that provides helpful hints.
ROLE_SYSTEM_WHITESPACE The object represents blank space between other objects.
ROLE_SYSTEM_WINDOW The object represents the window frame, which contains child objects such as a title bar, client, and other objects contained in a window.

Element States

State Description
STATE_SYSTEM_ALERT_HIGH Indicates important information to convey immediately to the user. For example, when a battery-level indicator reaches a critically low level, it generates a high-level alert. As a result, a blind access utility announces this information immediately to the user, and a screen magnification program scrolls the screen so that the battery indicator is in view. This state is also appropriate for any prompt or operation that must be completed before the user can continue.
STATE_SYSTEM_ALERT_MEDIUM Indicates important information that is not conveyed immediately to the user. For example, when a battery-level indicator is starting to reach a low level, it generates a medium-level alert. A blind access utility then generates a sound to let the user know that important information is available, without actually interrupting the user's work. The user could then query the alert information at his or her leisure.
STATE_SYSTEM_ALERT_LOW Indicates low-priority information that is not important to the user. This state is used, for example, when Word changes the appearance of the TipWizard button on its toolbar to indicate that it has a hint for the user.
STATE_SYSTEM_ANIMATED The object's appearance changes rapidly or constantly. Graphics that are occasionally animated are described as ROLE_SYSTEM_GRAPHIC with the State property set to STATE_SYSTEM_ANIMATED. This state is used to indicate that the object's location is changing.
STATE_SYSTEM_BUSY The control cannot accept input at this time.
STATE_SYSTEM_CHECKED The object's check box is selected.
STATE_SYSTEM_COLLAPSED Children of this object that have the ROLE_SYSTEM_OUTLINEITEM role are hidden.
STATE_SYSTEM_DEFAULT This state represents the default button in a window.
STATE_SYSTEM_EXPANDED Children of this object that have the ROLE_SYSTEM_OUTLINEITEM role are displayed.
STATE_SYSTEM_EXTSELECTABLE Indicates that an object extends its selection using SELFLAG_EXTENDSELECTION in the IAccessible::accSelect method.
STATE_SYSTEM_FLOATING The object is not clipped to the boundary of its parent object and does not move automatically when the parent moves.
STATE_SYSTEM_FOCUSABLE The object is on the active window and is ready to receive keyboard focus.
STATE_SYSTEM_FOCUSED The object has the keyboard focus. Do not confuse object focus with object selection. For more information, see Selection and Focus Properties and Methods. For objects with this object state, send EVENT_OBJECT_SHOW, or EVENT_OBJECT_HIDE WinEvents to notify client applications about state changes. Do not use EVENT_OBJECT_STATECHANGE.
STATE_SYSTEM_HASPOPUP Object displays a pop-up menu or window when invoked.
STATE_SYSTEM_HOTTRACKED The object is hot-tracked by the mouse, which means that its appearance has changed to indicate that the mouse pointer is located over it.
STATE_SYSTEM_INVISIBLE The object is programmatically hidden. For example, menu itmes are programmatically hidden until a user activates the menu. Because objects with this state are not available to users, client applications should not communicate information about the object to users. However, if client applications find an object with this state, they should check to see if STATE_SYSTEM_OFFSCREEN is also set. If this second state is defined, then clients can communicate the information about the object to users. For example, a list box can have both STATE_SYSTEM_INVISIBLE and STATE_SYSTEM_OFFSCREEN set. In this case, the client application can communicate all items in the list to users.
If a client application is navigating through an IAccessible tree and encounters a parent object that is invisible, Active Accessibility will not expose information about any possible children of the parent as long as the parent is invisible.
STATE_SYSTEM_LINKED Indicates that the object is formatted as a hyperlink. The object role will usually be ROLE_SYSTEM_TEXT.
STATE_SYSTEM_MARQUEED Indicates scrolling or moving text or graphics.
STATE_SYSTEM_MIXED Indicates that the state of a three-state check box or toolbar button is not determined. The check box is neither checked nor unchecked and is therefore in the third or mixed state.
STATE_SYSTEM_MOVEABLE Indicates that the object can be moved. For example, a user can click on the titlebar for the object and drag the object to a new location.
STATE_SYSTEM_MULTISELECTABLE Indicates that the object accepts multiple selected items; SELFLAG_ADDSELECTION for the IAccessible::accSelect method is valid.
STATE_SYSTEM_NORMAL Indicates that the object does not have another state assigned to it.
STATE_SYSTEM_OFFSCREEN The object is clipped, or scrolled out of view, but not programmatically hidden. If the user makes the viewport larger, more of the object will be visible on the computer screen.
STATE_SYSTEM_PRESSED The object is pressed.
STATE_SYSTEM_PROTECTED The object is a password-protected edit control.
STATE_SYSTEM_READONLY The object is designated read-only.
STATE_SYSTEM_SELECTABLE The object accepts selection.
STATE_SYSTEM_SELECTED The object is selected.
STATE_SYSTEM_SELFVOICING The object or child uses text-to-speech (TTS) technology for description purposes. A speech-based accessibility aid does not announce information when an object with this state has the focus because the object automatically announces information.
STATE_SYSTEM_SIZEABLE The object can be resized. For example, a user could change the size of a window by clicking the border with a mouse and dragging the mouse.
STATE_SYSTEM_TRAVERSED The object is a hyperlink that has been visited (previously clicked) by a user.
STATE_SYSTEM_UNAVAILABLE The object is unavailable.

Element Selection Flags

Selection Description
SELFLAG_NONE Performs no action. The function Element.Select does not change the selection or focus.
SELFLAG_TAKEFOCUS Sets the focus to the object and makes it the selection anchor. Used by itself, this flag does not alter the selection. The effect is similar to moving the focus manually by pressing the arrow keys while holding down the CTRL key in Windows Explorer or in any multiple-selection list box. With objects that have the StateMultiselectable, SELFLAG_TAKEFOCUS is combined with the following values:
SELFLAG_TAKESELECTION
SELFLAG_EXTENDSELECTION
SELFLAG_ADDSELECTION
SELFLAG_REMOVESELECTION
SELFLAG_ADDSELECTION | SELFLAG_EXTENDSELECTION
SELFLAG_REMOVESELECTION | SELFLAG_EXTENDSELECTION
If you call Element.Select with the TakeFocus flag on an object that has an HWND, the flag takes effect only if the object's parent already has the focus.
SELFLAG_TAKESELECTION Selects the object and removes the selection from all other objects in the container. This flag does not change the focus or the selection anchor unless it is combined with TakeFocus. The SELFLAG_TAKESELECTION | SELFLAG_TAKEFOCUS combination is equivalent to single-clicking an item in Windows Explorer. This flag must not be combined with the following flags: SELFLAG_ADDSELECTION
SELFLAG_REMOVESELECTION
SELFLAG_EXTENDSELECTION
SELFLAG_EXTENDSELECTION Alters the selection so that all objects between the selection anchor and this object take on the anchor object's selection state. If the anchor object is not selected, the objects are removed from the selection. If the anchor object is selected, the selection is extended to include this object and all the objects in between. Set the selection state by combining this flag with SELFLAG_ADDSELECTION or SELFLAG_REMOVESELECTION.
This flag does not change the focus or the selection anchor unless it is combined with TakeFocus. The SELFLAG_EXTENDSELECTION | TakeFocus combination is equivalent to adding an item to a selection manually by holding down the SHIFT key and clicking an unselected object in Windows Explorer. This flag is not combined with SELFLAG_TAKESELECTION.
SELFLAG_ADDSELECTION Adds the object to the current selection; possible result is a noncontiguous selection. This flag does not change the focus or the selection anchor unless it is combined with SELFLAG_TAKEFOCUS. The SELFLAG_ADDSELECTION | SELFLAG_TAKEFOCUS combination is equivalent to adding an item to a selection manually by holding down the CTRL key and clicking an unselected object in Windows Explorer. This flag is not combined with SELFLAG_REMOVESELECTION or with SELFLAG_TAKESELECTION.
SELFLAG_REMOVESELECTION Removes the object from the current selection; possible result is a noncontiguous selection. This flag does not change the focus or the selection anchor unless it is combined with TakeFocus. The SELFLAG_REMOVESELECTION | SELFLAG_TAKEFOCUS combination is equivalent to removing an item from a selection manually by holding down the CTRL key while clicking a selected object in Windows Explorer. This flag is not combined with SELFLAG_ADDSELECTION or SELFLAG_TAKESELECTION.

Documentation based on Ranorex Version 1.5.0 - www.ranorex.com