Skip to main content
Bar

BarItemLink.UserRibbonStyle Property

Gets or sets the options that specify the current BarItemLink‘s possible states within a Ribbon Control.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[Browsable(false)]
[XtraSerializableProperty]
public RibbonItemStyles UserRibbonStyle { get; set; }

Property Value

Type Description
RibbonItemStyles

A set of RibbonItemStyles flags that specify the bar item’s possible states within a Ribbon Control.

Available values:

Name Description
Default

If active, an item’s possible states with a Ribbon Control are determined based on the item’s settings. For example, if the item is associated with a small image and isn’t associated with a large image, its possible states within the Ribbon Control are RibbonItemStyles.SmallWithoutText and RibbonItemStyles.SmallWithText.

Large

If active, a bar item can be displayed as a large bar item.

LargeItem

SmallWithText

If active, an item can be displayed like a smal bar item with its caption.

SmalWithTextItem

SmallWithoutText

If active, an item can be displayed like a smal bar item without its caption.

SmalWithoutTextItem

All

If active, enables all other options.

Remarks

The link’s style can be specified by the corresponding item’s BarItem.RibbonStyle property or by the link’s UserRibbonStyle property. The latter gives you the ability to specify the style of a single link. This allows you to use multiple links to the same item but with different styles. The link’s BarLinkUserDefines.RibbonStyle option determines which of these properties specify the link’s style. If this option is active, the link’s style is specified by its UserRibbonStyle property. Otherwise, by the corresponding item’s BarItem.RibbonStyle property.

Options that specify which link settings are determined by a user can be accessed via the BarItemLink.UserDefine property. Note that individual options can be enabled/disabled only via code. To disable all user defined options, call the BarItemLink.Reset method.

See Also