Skip to content

DXRibbon

DevXpress Ribbon.

UI element class: DevExpress.XtraBars.Ribbon.RibbonControl

Extends ManagedObject

Extends SeSSimulatedObject

Behavior Pattern: DXRibbonControlBehavior

Action Summary

Action Description
DoClickApplicationButton Clicks an application button on the ribbon.
DoClickGalleryItem Select a gallery item in the Ribbon gallery control.
DoClickItem Clicks on an item on the ribbon.
DoClickTab Clicks on a tab in the ribbon.

Action Detail

DoClickApplicationButton

Clicks an application button on the ribbon.

SeS('SomeDXRibbon').DoClickApplicationButton(caption, xOffset, yOffset)

Parameters:

Name Type Description
caption string Caption of the application button 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.

DoClickGalleryItem

Select a gallery item in the Ribbon gallery control.

SeS('SomeDXRibbon').DoClickGalleryItem(gallery, galleryItem, bNewValue, bUncheckOthers)

Parameters:

Name Type Description
gallery string | number Gallery control identifier in the Ribbon.
galleryItem string | number Caption or index of item to click.
bNewValue boolean New checked value for an item
Optional, Default: "true".
bUncheckOthers boolean set to 'false' if this click is a part of multi-selection
Optional, Default: "true".

Returns:

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

DoClickItem

Clicks on an item on the ribbon.

SeS('SomeDXRibbon').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('SomeDXRibbon').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.