UltraRibbon

UI element class: Infragistics.Win.UltraWinToolbars.UltraToolbarsDockArea

Extends ManagedObject

Extends SeSSimulatedObject

Behavior Pattern: UltraRibbonControlBehavior

Property Summary

Property Description Getter Setter
DropdownCount NUmber of dropdown controls. GetDropdownCount
ItemValue Value of an item. GetItemValue
ToggleState Toggle state of a button GetToggleState

Action Summary

Action Description
DoClickApplicationButton Clicks an application button on the ribbon.
DoClickItem Clicks on an item on the ribbon.
DoClickTab Clicks on a tab in the ribbon.
DoItemDropSelect Clicks specific item in the drop control.
DoMenu Performs click on the menu item.

Property Detail

NUmber of dropdown controls.

Getter Parameters:

Name Type Description
caption string Name of a dropdown.

Type: number

Accessors: GetDropdownCount

ItemValue

Value of an item.

Getter Parameters:

Name Type Description
caption string Name of an item.

Type: string|number|boolean

Accessors: GetItemValue

ToggleState

Toggle state of a button

Getter Parameters:

Name Type Description
caption string Name of a button.

Type: boolean

Accessors: GetToggleState

Action Detail

DoClickApplicationButton(xOffset, yOffset)

Clicks an application button on the ribbon.

Parameters:

Name Type Description
xOffset number X offset to click within object. Default is a center.
Optional.
yOffset number Y offset to click within object. Default is a center.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoClickItem(caption, xOffset, yOffset)

Clicks on an item on the ribbon.

Parameters:

Name Type Description
caption string Caption of an item to click.
xOffset number X offset to click within object. Default is a center.
Optional.
yOffset number Y offset to click within object. Default is a center.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoClickTab(caption, xOffset, yOffset)

Clicks on a tab in the ribbon.

Parameters:

Name Type Description
caption string Caption of a tab to click.
xOffset number X offset to click within object. Default is a center.
Optional.
yOffset number Y offset to click within object. Default is a center.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoItemDropSelect(caption, item)

Clicks specific item in the drop control.

Parameters:

Name Type Description
caption string Caption of the drop control.
item string Item to select.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoMenu(path, separator)

Performs click on the menu item.

Parameters:

Name Type Description
path string Path from the menu root to a leaf item with components delimited by separator parameter.
separator string Separator character.
Optional, Default: ;.

Returns:

boolean: 'true' if success, 'false' otherwise.