UltraRibbon¶
Infragistics 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¶
DropdownCount¶
NUmber of dropdown controls.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Name of a dropdown. |
Type: number
Accessors: GetDropdownCount
value = SeS('SomeUltraRibbon').GetDropdownCount(caption)
ItemValue¶
Value of an item.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Name of an item. |
Type: string|number|boolean
Accessors: GetItemValue
value = SeS('SomeUltraRibbon').GetItemValue(caption)
ToggleState¶
Toggle state of a button
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Name of a button. |
Type: boolean
Accessors: GetToggleState
value = SeS('SomeUltraRibbon').GetToggleState(caption)
Action Detail¶
DoClickApplicationButton¶
Clicks an application button on the ribbon.
SeS('SomeUltraRibbon').DoClickApplicationButton(xOffset, yOffset)
Parameters:
| Name | Type | Description |
|---|---|---|
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoClickItem¶
Clicks on an item on the ribbon.
SeS('SomeUltraRibbon').DoClickItem(caption, xOffset, yOffset)
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Caption of an item to click. |
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoClickTab¶
Clicks on a tab in the ribbon.
SeS('SomeUltraRibbon').DoClickTab(caption, xOffset, yOffset)
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Caption of a tab to click. |
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoItemDropSelect¶
Clicks specific item in the drop control.
SeS('SomeUltraRibbon').DoItemDropSelect(caption, item)
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | Caption of the drop control. |
| item | string | Item to select. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoMenu¶
Performs click on the menu item.
SeS('SomeUltraRibbon').DoMenu(path, separator)
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. Possible values: ";", ",", "\", "/" Optional, Default: ";". |
Returns:
boolean: 'true' if success, 'false' otherwise.