Skip to content

DXDockedBarControl

DevXpress Docked Bar.

UI element class: regex:DevExpress.XtraBars.Controls.DockedBarControl

Extends ManagedObject

Extends SeSSimulatedObject

Behavior Pattern: DXBarControlBehavior

Property Summary

Property Description Getter Setter
Item Caption of the item specified by index GetItem
ItemCount Number of items. GetItemCount
ItemEnabled Enabled state of an item at index. GetItemEnabled
ItemTooltip Tooltip assigned to an item at index. GetItemTooltip

Action Summary

Action Description
DoClickItem Performs click on the navigation item

Property Detail

Item

Caption of the item specified by index

Getter Parameters:

Name Type Description
ind number Index of an item to get caption

Type: string

Accessors: GetItem

value = SeS('SomeDXDockedBarControl').GetItem(/**number*/ind)

ItemCount

Number of items.

Type: number

Accessors: GetItemCount

value = SeS('SomeDXDockedBarControl').GetItemCount()

ItemEnabled

Enabled state of an item at index. Returns boolean value.

Getter Parameters:

Name Type Description
ind number Zero-based index of an item.

Type: boolean

Accessors: GetItemEnabled

value = SeS('SomeDXDockedBarControl').GetItemEnabled(/**number*/ind)

ItemTooltip

Tooltip assigned to an item at index.

Getter Parameters:

Name Type Description
ind number Zero-based index of an item.

Type: string

Accessors: GetItemTooltip

value = SeS('SomeDXDockedBarControl').GetItemTooltip(/**number*/ind)

Action Detail

DoClickItem

Performs click on the navigation item

SeS('SomeDXDockedBarControl').DoClickItem(nameCaptionIndex, xOffset, yOffset)

Parameters:

Name Type Description
nameCaptionIndex string | number index, name or caption of the item to be selected.
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 successful, 'false' otherwise.