Packages
 In this topic

*Methods

*Fields

 

Packages   PreviousThis PackageNext
Package com.ms.ui   Previous This
Package
Next

 


Interface IUIAccessible

public interface IUIAccessible
{
  // Fields
  public static final int CHILDID_SELF;
  public static final int DISP_E_MEMBERNOTFOUND;
  public static final int E_INVALIDARG;
  public static final int E_NOTIMPL;
  public static final int NAVDIR_DOWN;
  public static final int NAVDIR_FIRST;
  public static final int NAVDIR_LAST;
  public static final int NAVDIR_LEFT;
  public static final int NAVDIR_NEXT;
  public static final int NAVDIR_PREV;
  public static final int NAVDIR_RIGHT;
  public static final int NAVDIR_UP;
  public static final int ROLE_SYSTEM_ALERT;
  public static final int ROLE_SYSTEM_ANIMATION;
  public static final int ROLE_SYSTEM_APPLICATION;
  public static final int ROLE_SYSTEM_BORDER;
  public static final int ROLE_SYSTEM_BUTTONDROPDOWN;
  public static final int ROLE_SYSTEM_BUTTONDROPDOWNGRID;
  public static final int ROLE_SYSTEM_BUTTONMENU;
  public static final int ROLE_SYSTEM_CARET;
  public static final int ROLE_SYSTEM_CELL;
  public static final int ROLE_SYSTEM_CHARACTER;
  public static final int ROLE_SYSTEM_CHART;
  public static final int ROLE_SYSTEM_CHECKBUTTON;
  public static final int ROLE_SYSTEM_CLIENT;
  public static final int ROLE_SYSTEM_CLOCK;
  public static final int ROLE_SYSTEM_COLUMN;
  public static final int ROLE_SYSTEM_COLUMNHEADER;
  public static final int ROLE_SYSTEM_COMBOBOX;
  public static final int ROLE_SYSTEM_CURSOR;
  public static final int ROLE_SYSTEM_DIAGRAM;
  public static final int ROLE_SYSTEM_DIAL;
  public static final int ROLE_SYSTEM_DIALOG;
  public static final int ROLE_SYSTEM_DOCUMENT;
  public static final int ROLE_SYSTEM_DROPLIST;
  public static final int ROLE_SYSTEM_EQUATION;
  public static final int ROLE_SYSTEM_GRAPHIC;
  public static final int ROLE_SYSTEM_GRIP;
  public static final int ROLE_SYSTEM_GROUPING;
  public static final int ROLE_SYSTEM_HELPBALLOON;
  public static final int ROLE_SYSTEM_HOTKEYFIELD;
  public static final int ROLE_SYSTEM_INDICATOR;
  public static final int ROLE_SYSTEM_LINK;
  public static final int ROLE_SYSTEM_LIST;
  public static final int ROLE_SYSTEM_LISTITEM;
  public static final int ROLE_SYSTEM_MENUBAR;
  public static final int ROLE_SYSTEM_MENUITEM;
  public static final int ROLE_SYSTEM_MENUPOPUP;
  public static final int ROLE_SYSTEM_OUTLINE;
  public static final int ROLE_SYSTEM_OUTLINEITEM;
  public static final int ROLE_SYSTEM_PAGETAB;
  public static final int ROLE_SYSTEM_PAGETABLIST;
  public static final int ROLE_SYSTEM_PANE;
  public static final int ROLE_SYSTEM_PROGRESSBAR;
  public static final int ROLE_SYSTEM_PROPERTYPAGE;
  public static final int ROLE_SYSTEM_PUSHBUTTON;
  public static final int ROLE_SYSTEM_RADIOBUTTON;
  public static final int ROLE_SYSTEM_ROW;
  public static final int ROLE_SYSTEM_ROWHEADER;
  public static final int ROLE_SYSTEM_SCROLLBAR;
  public static final int ROLE_SYSTEM_SEPARATOR;
  public static final int ROLE_SYSTEM_SLIDER;
  public static final int ROLE_SYSTEM_SOUND;
  public static final int ROLE_SYSTEM_SPINBUTTON;
  public static final int ROLE_SYSTEM_STATICTEXT;
  public static final int ROLE_SYSTEM_STATUSBAR;
  public static final int ROLE_SYSTEM_TABLE;
  public static final int ROLE_SYSTEM_TEXT;
  public static final int ROLE_SYSTEM_TITLEBAR;
  public static final int ROLE_SYSTEM_TOOLBAR;
  public static final int ROLE_SYSTEM_TOOLTIP;
  public static final int ROLE_SYSTEM_WHITESPACE;
  public static final int ROLE_SYSTEM_WINDOW;
  public static final int S_FALSE;
  public static final int SELFLAG_ADDSELECTION;
  public static final int SELFLAG_EXTENDSELECTION;
  public static final int SELFLAG_NONE;
  public static final int SELFLAG_REMOVESELECTION;
  public static final int SELFLAG_TAKEFOCUS;
  public static final int SELFLAG_TAKESELECTION;
  public static final int STATE_SYSTEM_ANIMATED;
  public static final int STATE_SYSTEM_BUSY;
  public static final int STATE_SYSTEM_CHECKED;
  public static final int STATE_SYSTEM_COLLAPSED;
  public static final int STATE_SYSTEM_DEFAULT;
  public static final int STATE_SYSTEM_EXPANDED;
  public static final int STATE_SYSTEM_EXTSELECTABLE;
  public static final int STATE_SYSTEM_FLOATING;
  public static final int STATE_SYSTEM_FOCUSABLE;
  public static final int STATE_SYSTEM_FOCUSED;
  public static final int STATE_SYSTEM_HOTTRACKED;
  public static final int STATE_SYSTEM_INVISIBLE;
  public static final int STATE_SYSTEM_LINKED;
  public static final int STATE_SYSTEM_MARQUEED;
  public static final int STATE_SYSTEM_MIXED;
  public static final int STATE_SYSTEM_MOVEABLE;
  public static final int STATE_SYSTEM_MULTISELECTABLE;
  public static final int STATE_SYSTEM_OFFSCREEN;
  public static final int STATE_SYSTEM_PRESSED;
  public static final int STATE_SYSTEM_READONLY;
  public static final int STATE_SYSTEM_SELECTABLE;
  public static final int STATE_SYSTEM_SELECTED;
  public static final int STATE_SYSTEM_SELFVOICING;
  public static final int STATE_SYSTEM_SIZEABLE;
  public static final int STATE_SYSTEM_TRAVERSED;
  public static final int STATE_SYSTEM_UNAVAILABLE;
  public static final int STATE_SYSTEM_VALID;

  // Methods
  public void doDefaultAction();
  public Rectangle getBounds(IUIComponent comp);
  public String getDefaultAction();
  public String getDescription();
  public String getHelp();
  public String getKeyboardShortcut();
  public int getRoleCode();
  public int getStateCode();
  public String getValueText();
  public IUIComponent navigate(IUIComponent comp, int direction,
        boolean keyable);
  public void setValueText(String value);
}

This interface is used to access control information that could otherwise be retrieved only by viewing the graphical user interface (GUI). UIComponent implements IUIAccessible.

Note The hot-track color is the same color as the button text color. As a result, hot-tracking does not appear to be functional.

Methods

doDefaultAction

public void doDefaultAction();

Performs the default action for the object. For example, the default action for a button is to be pressed.

Return Value:

No return value.

getBounds

public Rectangle getBounds(IUIComponent comp);

Retrieves the bounding rectangle of the object, relative to the specified component.

Return Value:

Returns the rectangle identifying the object's bounding area, in the coordinate space of the specified component.

ParameterDescription
comp The reference component. The coordinates of the returned Rectangle object are relative to this component. If null, screen coordinates are used.

getDefaultAction

public String getDefaultAction();

Retrieves the default action for the object.

Return Value:

Returns a string describing the object's default action. For example, a button's default action is "Press".

getDescription

public String getDescription();

Retrieves a description of the object.

Return Value:

Returns a string describing the object, beyond the information provided by getRoleCode, getStateCode, and getName.

getHelp

public String getHelp();

Retrieves the Help text for the object.

Return Value:

Returns a string describing the function of the object. This value expands on the information provided by getRoleCode, getStateCode, and getName.

Remarks:

This method can be used to set a ToolTip that describes the object.

getKeyboardShortcut

public String getKeyboardShortcut();

Retrieves the keyboard shortcut for the object.

Return Value:

Returns a string describing the sequence of keystrokes that transfer input focus to the object.

getRoleCode

public int getRoleCode();

Retrieves the role of the object.

Return Value:

Returns the ROLE_SYSTEM code that best describes the role of the object.

getStateCode

public int getStateCode();

Retrieves the state of the object.

Return Value:

Returns the combination of STATE_SYSTEM codes that best describes the state of the object.

getValueText

public String getValueText();

Retrieves the value of the object.

Return Value:

Returns a string describing the visual information contained in the object. This value expands on the information provided by getRoleCode, getStateCode, and getName.

navigate

public IUIComponent navigate(IUIComponent comp, int direction,
        boolean keyable);

Navigates from the specified component to another component in the specified direction.

Return Value:

Returns the component navigated to (if a component in the specified direction exists); otherwise, returns null.

ParameterDescription
comp The component to navigate from.
direction The navigation direction. Specify one of the NAVDIR field values.
keyable If true, only components that are able to receive keyboard input can be navigated to; otherwise, all components can be navigated to.

setValueText

public void setValueText(String value);

Sets the value of the object.

Return Value:

No return value.

ParameterDescription
value The string that describes the visual information contained in the object. This value expands on the information provided by getRoleCode, getStateCode, and getName.

Fields

CHILDID_SELF
The identifier of the object itself.
DISP_E_MEMBERNOTFOUND
COM error that indicates the specified member was not found.
E_INVALIDARG
COM error that indicates an invalid argument.
E_NOTIMPL
COM error that indicates no implementation.
NAVDIR_DOWN
Specifies that the navigation direction is down.
NAVDIR_FIRST
Navigates to the first object.
NAVDIR_LAST
Navigates to the last object.
NAVDIR_LEFT
Specifies that the navigation direction is to the left.
NAVDIR_NEXT
Navigates to the next object.
NAVDIR_PREV
Navigates to the previous object.
NAVDIR_RIGHT
Specifies that the navigation direction is to the right.
NAVDIR_UP
Specifies that the navigation direction is up.
ROLE_SYSTEM_ALERT
The role code that describes an alert message.
ROLE_SYSTEM_ANIMATION
The role code that describes an animation. UIMarquee.getRoleCode returns this code.
ROLE_SYSTEM_APPLICATION
The role code that describes an application.
ROLE_SYSTEM_BORDER
The role code that describes a border object.
ROLE_SYSTEM_BUTTONDROPDOWN
The role code that describes a button that when pressed, opens a drop-down object.
ROLE_SYSTEM_BUTTONDROPDOWNGRID
The role code that describes a button, when pressed, opens a drop-down grid.
ROLE_SYSTEM_BUTTONMENU
The role code that describes a button, when pressed, opens a menu.
ROLE_SYSTEM_CARET
The role code that describes a caret.
ROLE_SYSTEM_CELL
The role code that describes a cell within a grid.
ROLE_SYSTEM_CHARACTER
The role code that describes a single character.
ROLE_SYSTEM_CHART
The role code that describes a chart.
ROLE_SYSTEM_CHECKBUTTON
The role code that describes a check box button. UICheckButton.getRoleCode returns this code.
ROLE_SYSTEM_CLIENT
The role code that describes a client object.
ROLE_SYSTEM_CLOCK
The role code that describes a clock control.
ROLE_SYSTEM_COLUMN
The role code that describes a column within a grid.
ROLE_SYSTEM_COLUMNHEADER
The role code that describes a column header. UIColumnHeader.getRoleCode returns this code.
ROLE_SYSTEM_COMBOBOX
The role code that describes a combo box. UIChoice.getRoleCode returns this code.
ROLE_SYSTEM_CURSOR
The role code that describes a cursor.
ROLE_SYSTEM_DIAGRAM
The role code that describes a diagram.
ROLE_SYSTEM_DIAL
The role code that describes a dial control.
ROLE_SYSTEM_DIALOG
The role code that describes a dialog box.
ROLE_SYSTEM_DOCUMENT
The role code that describes a document.
ROLE_SYSTEM_DROPLIST
The role code that describes a drop-down list box.
ROLE_SYSTEM_EQUATION
The role code that describes an equation.
ROLE_SYSTEM_GRAPHIC
The role code that describes a graphic object. UIGraphic.getRoleCode and UIItem.getRoleCode return this code.
ROLE_SYSTEM_GRIP
The role code that describes the thumb control of a scroll bar. UIThumb.getRoleCode returns this code.
ROLE_SYSTEM_GROUPING
The role code that describes a grouping.
ROLE_SYSTEM_HELPBALLOON
The role code that describes a Help balloon.
ROLE_SYSTEM_HOTKEYFIELD
The role code that describes a keyboard shortcut.
ROLE_SYSTEM_INDICATOR
The role code that describes an indicator control.
ROLE_SYSTEM_LINK
The role code that describes a link between two objects.
ROLE_SYSTEM_LIST
The role code that describes a list. UISelector.getRoleCode returns this code.
ROLE_SYSTEM_LISTITEM
The role code that describes an item in a list.
ROLE_SYSTEM_MENUBAR
The role code that describes a menu bar.
ROLE_SYSTEM_MENUITEM
The role code that describes an item on a menu bar.
ROLE_SYSTEM_MENUPOPUP
The role code that describes a pop-up menu. UIPopup.getRoleCode returns this code.
ROLE_SYSTEM_OUTLINE
The role code that describes a hierarchical list object, such as a tree. UITree.getRoleCode returns this code.
ROLE_SYSTEM_OUTLINEITEM
The role code that describes an item within a hierarchical list.
ROLE_SYSTEM_PAGETAB
The role code that describes a tab control. UITab.getRoleCode returns this code.
ROLE_SYSTEM_PAGETABLIST
The role code that describes a list of tab controls.
ROLE_SYSTEM_PANE
The role code that describes a contained window. UIScrollViewer.getRoleCode and UIViewer.getRoleCode return this code.
ROLE_SYSTEM_PROGRESSBAR
The role code that describes a progress bar. UIProgress.getRoleCode returns this code.
ROLE_SYSTEM_PROPERTYPAGE
The role code that describes a Properties page.
ROLE_SYSTEM_PUSHBUTTON
The role code that describes a push button. UIPushButton.getRoleCode returns this code.
ROLE_SYSTEM_RADIOBUTTON
The role code that describes a radio button. UIRadioButton.getRoleCode returns this code.
ROLE_SYSTEM_ROW
The role code that describes a row within a grid. UIRow.getRoleCode returns this code.
ROLE_SYSTEM_ROWHEADER
The role code that describes a row header.
ROLE_SYSTEM_SCROLLBAR
The role code that describes a scroll bar. UIScroll.getRoleCode returns this code.
ROLE_SYSTEM_SEPARATOR
The role code that describes an object that separates two fields.
ROLE_SYSTEM_SLIDER
The role code that describes a slider control.
ROLE_SYSTEM_SOUND
The role code that describes a sound.
ROLE_SYSTEM_SPINBUTTON
The role code that describes a spin button.
ROLE_SYSTEM_STATICTEXT
The role code that describes a static text object. UIText.getRoleCode returns this code.
ROLE_SYSTEM_STATUSBAR
The role code that describes a status bar. UIStatus.getRoleCode returns this code.
ROLE_SYSTEM_TABLE
The role code that describes a table.
ROLE_SYSTEM_TEXT
The role code that describes an editable text object.
ROLE_SYSTEM_TITLEBAR
The role code that describes a title bar.
ROLE_SYSTEM_TOOLBAR
The role code that describes a toolbar. UIBand.getRoleCode, UIBandBox.getRoleCode, and UILine.getRoleCode return this code.
ROLE_SYSTEM_TOOLTIP
The role code that describes a ToolTip.
ROLE_SYSTEM_WHITESPACE
The role code that describes white space on a page of text.
ROLE_SYSTEM_WINDOW
The role code that describes a top-level window.
S_FALSE
COM error that indicates a false return value.
SELFLAG_ADDSELECTION
Indicates the object is added to a multiple selection.
SELFLAG_EXTENDSELECTION
Indicates the object is added to an extended selection.
SELFLAG_NONE
Indicates no object is selected.
SELFLAG_REMOVESELECTION
Indicates the object is deselected.
SELFLAG_TAKEFOCUS
Indicates focus is transferred to the selected object.
SELFLAG_TAKESELECTION
Indicates the object is the only selected item in the container.
STATE_SYSTEM_ANIMATED
The state code that indicates the object is animated.
STATE_SYSTEM_BUSY
The state code that indicates the object is busy.
STATE_SYSTEM_CHECKED
The state code that indicates the object is checked. See UIComponent.getStateCode.
STATE_SYSTEM_COLLAPSED
The state code that indicates the object is collapsed. See UITree.getStateCode.
STATE_SYSTEM_DEFAULT
The state code that indicates the object is the default item.
STATE_SYSTEM_EXPANDED
The state code that indicates the object is expanded. See UITree.getStateCode.
STATE_SYSTEM_EXTSELECTABLE
The state code that indicates the object supports extended selection. See UISelector.getStateCode.
STATE_SYSTEM_FLOATING
The state code that indicates the object is owned, not contained, by another object.
STATE_SYSTEM_FOCUSABLE
The state code that indicates the object can receive focus. See UIComponent.getStateCode.
STATE_SYSTEM_FOCUSED
The state code that indicates the object has focus. See UIComponent.getStateCode.
STATE_SYSTEM_HOTTRACKED
The state code that indicates the object is hot-tracked. See UIComponent.getStateCode.
STATE_SYSTEM_INVISIBLE
The state code that indicates the object is hidden. See UIComponent.getStateCode.
STATE_SYSTEM_LINKED
The state code that indicates the object is linked to another object (a hypertext link, for example).
STATE_SYSTEM_MARQUEED
The state code that indicates the object's content can scroll. See UIMarquee.getStateCode.
STATE_SYSTEM_MIXED
The state code that indicates the object is indeterminate. See UIComponent.getStateCode.
STATE_SYSTEM_MOVEABLE
The state code that indicates the object can be moved. See UIComponent.getStateCode.
STATE_SYSTEM_MULTISELECTABLE
The state code that indicates the object supports multiple selection. See UISelector.getStateCode.
STATE_SYSTEM_OFFSCREEN
The state code that indicates the object is off the screen.
STATE_SYSTEM_PRESSED
The state code that indicates the object is pressed. See UIComponent.getStateCode.
STATE_SYSTEM_READONLY
The state code that indicates the object's contents are static
STATE_SYSTEM_SELECTABLE
The state code that indicates the object can be selected. See UIComponent.getStateCode.
STATE_SYSTEM_SELECTED
The state code that indicates the object is selected. See UIComponent.getStateCode.
STATE_SYSTEM_SELFVOICING
The state code that indicates the Text To Speech (TTS) feature can be used to make the object audible.
STATE_SYSTEM_SIZEABLE
The state code that indicates the object can be resized. See UIComponent.getStateCode.
STATE_SYSTEM_TRAVERSED
The state code that indicates a link has been traversed. See STATE_SYSTEM_LINKED.
STATE_SYSTEM_UNAVAILABLE
The state code that indicates the object is disabled.
STATE_SYSTEM_VALID
The state code that indicates the object is valid.

upnrm.gif © 1998 Microsoft Corporation. All rights reserved. Terms of use.