RibbonPageGroup Members

Represents a group within a Ribbon Page.

Constructors

Name Description
RibbonPageGroup() Initializes a new instance of the RibbonPageGroup class with default settings.
RibbonPageGroup(String) Initializes a new instance of the RibbonPageGroup class with the specified caption.

Properties

Name Description
ActualItemLinks For internal use.
Alignment Gets or sets whether this RibbonPageGroup should be aligned to the left (default) or right Ribbon side.
AllowMinimize Gets or sets whether the group is automatically collapsed when there is insufficient space to display all available items.
AllowTextClipping Gets or sets whether to clip the group's text when there's not enough space to display it entirely, or to expand the group to accommodate the entire text.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CaptionButtonVisible Gets or sets whether the Caption Button is visible.
Container Gets the IContainer that contains the Component. Inherited from Component.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Enabled Gets or sets whether the current RibbonPageGroup is enabled.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Glyph Gets or sets the image that is displayed within the group when it's collapsed.
ImageIndex Gets or sets the index of the image within the image collection that is displayed within the group when it's in a collapsed state.
ImageOptions Provides access to properties that allow you to set up a raster or vector image displayed when the group is collapsed.
Images Gets the collection of images that can be displayed within the group when it's in a collapsed state.
ImageUri Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current group when it is collapsed. A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size).
ItemLinks Gets the collection of bar item links displayed within the group.
ItemsLayout Gets or sets the number of rows used to vertically arrange small items within the current RibbonPageGroup in the Office2007, Office2010 and Office2013 Ribbon styles (see RibbonControl.RibbonStyle).
KeyTip Gets or sets the Key Tip used to emulate clicking on the group's Caption Button.
MergeOrder Defines the visual position of the current RibbonPageGroup object after merging this Ribbon Control into an MDI parent Ribbon.
Name Gets the name of the current component.
OriginalPageGroup Gets the group that was used to create the current RibbonPageGroup instance.
Page Gets the page which owns the current group.
Ribbon Gets the RibbonControl which owns the current group.
ShowCaptionButton This property is obsolete, use the RibbonPageGroup.CaptionButtonVisible property instead.
Site Gets or sets the ISite of the Component. Inherited from Component.
State Gets or sets whether the group is always expanded, collapsed, or automatically switches between the expanded and collapsed state depending on the available space.
SuperTip Gets or sets a SuperToolTip associated with the Ribbon page group.
Tag Gets or sets an object that contains data on the current RibbonPageGroup object.
Text Gets or sets the text displayed within the group.
ToolbarContentButtonLink Gets a link to the current group within the Quick Access Toolbar.
Visible Gets or sets whether the group is visible.

Methods

Name Description
AddGroupToToolbar() Creates a link to the current group and adds it to the Quick Access Toolbar.
Assign(RibbonPageGroup) Copies settings of the specified object to the current object.
Clone() Creates a new RibbonPageGroup object with the settings matching those of the current object.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetActualAlignment() Gets whether this page group is actually aligned to the left or right relative to the ribbon.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveGroupFromToolbar() Removes a link to the current group from the Quick Access Toolbar.
ToString() Returns the RibbonPageGroup's caption.

Events

Name Description
CaptionButtonClick Occurs when the group's Caption Button is clicked.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also