[]
        
(Showing Draft Content)

C1.Win.Ribbon.RibbonButton

RibbonButton Class

Represents a button element in a C1Ribbon control.

Implements
IUiaButton
IUiaInvokeProvider
IUiaSelectionItemProvider
IUiaScrollItemProvider
Namespace: C1.Win.Ribbon
Assembly: C1.Win.Ribbon.4.8.dll
Syntax
public class RibbonButton : RibbonIconItem, IComponent, IDisposable, IUiaButton, IUiaInvokeProvider, IUiaSelectionItemProvider, IUiaScrollItemProvider

Constructors

Name Description
RibbonButton()

Creates a new instance of RibbonButton.

RibbonButton(Image)

Creates a new instance of RibbonButton.

RibbonButton(string)

Creates a new instance of RibbonButton.

RibbonButton(string, Image)

Creates a new instance of RibbonButton.

RibbonButton(string, Image, Image)

Creates a new instance of RibbonButton.

Properties

Name Description
CanBeAddedToQat

Gets or sets whether the user can add this RibbonItem to the Quick Access Toolbar at runtime.

KeyTip

Gets or sets the KeyTip providing keyboard access to the Button.

OwnerDraw

Gets or sets a value indicating whether the button is owner-drawn.

RepeatPressDelay

Gets or sets the interval before the button starts firing click events, in milliseconds.

RepeatPressInterval

Gets or sets the interval between clicks when the button is kept pressed, in milliseconds.

SelectableInListItem

Gets or sets a value indicating whether this item can be selected in a RibbonListItem.

ShortcutKeyDisplayString

Gets or sets the shortcut key text associated with the menu item.

ShortcutKeys

Gets or sets the shortcut keys associated with the button.

ShowInMore

Gets or sets a value indicating if this RibbonItem can be shown in drop down part of the More button when ribbon is simplified.

Text

Gets or sets the text associated with the RibbonButton.

Methods

Name Description
Dispose(bool)

Clean up any resources being used.

OnClick(EventArgs)

Raises the Click event.

OnDoubleClick(EventArgs)

Raises the DoubleClick event.

OnDrawItem(DrawItemEventArgs)

Raises the DrawItem event.

OnMeasureItem(MeasureItemEventArgs)

Raises the MeasureItem event.

PerformClick()

Performs the Click event.

PerformDoubleClick()

Performs the DoubleClick event.

ResetText()

Restores the default value of the Text property.

ShouldSerializeText()

Specifies whether to save the value of the Text property.

Events

Name Description
Click

Occurs when the button is clicked.

DoubleClick

Occurs when the button is double-clicked.

DrawItem

Occurs when the button is owner-drawn.

MeasureItem

Occurs when the button is measured.