[]
        
(Showing Draft Content)

C1.Win.Ribbon.RibbonGroup

RibbonGroup Class

Represents an item group on a RibbonTab.

Implements
ISupportUiaContainer
Namespace: C1.Win.Ribbon
Assembly: C1.Win.Ribbon.4.8.dll
Syntax
public class RibbonGroup : Component, IComponent, IDisposable, ISupportUiaContainer

Constructors

Name Description
RibbonGroup()

Creates a new instance of RibbonGroup.

RibbonGroup(string)

Creates a new instance of RibbonGroup.

Properties

Name Description
AllowCollapsed

Gets or sets a value indicating whether the group can be collapsed.

CanBeAddedToQat

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

CollapseIndex

Gets or sets the priority index of the groups for resizing and collapsing.

Enabled

Gets or sets whether this item group is enabled.

GroupKeyTip

Gets or sets the KeyTip providing keyboard access to a RibbonGroup.

GroupToolTip

Gets or sets the tooltip for the collapsed group button.

HasLauncherButton

Gets or sets whether this RibbonGroup has a dialog launcher button.

IconSet

Gets the icon set.

Image

Gets or sets the small image (16 x 16) used when the group is collapsed.

IsDisposed

Gets a value indicating whether the RibbonGroup has been disposed of.

Items

Gets the collection of Ribbon items in this group.

LauncherEnabled

Gets or sets whether the dialog launcher button is enabled for this RibbonGroup.

LauncherKeyTip

Gets or sets the KeyTip providing keyboard access to a dialog launcher button.

LauncherToolTip

Gets or sets the tooltip for the dialog launcher button.

Name

Gets or sets the unique name for this RibbonGroup.

OwnerCollection

Gets the owner collection for this RibbonGroup.

Ribbon

Gets the C1Ribbon that this item group belongs to.

Site

Gets or sets the ISite of the RibbonGroup.

Tab

Gets the RibbonTab that this item group belongs to.

Tag

User-defined data associated with the RibbonGroup.

Text

Gets or sets the text label that appears at the bottom of this group.

TrimLongCaption

Gets or sets whether the group caption should be trimmed if it is longer than the contents of the group.

Visible

Gets or sets whether this item group is visible.

Methods

Name Description
Dispose(bool)

Clean up any resources being used.

Equals(object)

Determines whether the specified RibbonGroup is equal to the current RibbonGroup.

GetHashCode()

Serves as a hash function for a particular type.

OnDialogLauncherClick(EventArgs)

Raises the DialogLauncherClick event.

OnMouseEnter(EventArgs)

Raises the MouseEnter event.

OnMouseLeave(EventArgs)

Raises the MouseLeave event.

ResetText()

Restores the default value of the Text property.

ShouldSerializeID()
ShouldSerializeItems()
ShouldSerializeName()
ShouldSerializeText()

Specifies whether to save the value of the Text property.

Events

Name Description
DialogLauncherClick

Occurs when the user clicks the dialog launcher button.

MouseEnter

Occurs when the mouse enters the Ribbon group.

MouseLeave

Occurs when the mouse leaves the Ribbon group.

Operators

Name Description
operator ==(RibbonGroup, RibbonGroup)

Determines whether the specified RibbonGroup instances are considered equal.

operator !=(RibbonGroup, RibbonGroup)

Determines whether the specified RibbonGroup instances are considered not equal.