Back to Devexpress

RibbonPage Members

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribbonpage-dot-underscore-members.md

latest14.5 KB
Original Source

RibbonPage Members

Represents a Ribbon Page within a RibbonControl.

Constructors

NameDescription
RibbonPage()Initializes a new instance of the RibbonPage class.
RibbonPage(String)Initializes a new instance of the RibbonPage class with the specified caption.

Properties

NameDescription
ActualReduceOperationsThis member supports the internal infrastructure, and is not intended to be used directly from your code.
AppearanceProvides access to the RibbonPage‘s appearance settings.
AppearanceHoveredAllows you to access Appearance settings applied to this page when a user hovers over it.
AppearanceSelectedAllows you to access Appearance settings applied to this page when it is selected (active).
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CategoryGets or sets the page category with which the current RibbonPage object is associated.
CollectionGets the collection of pages that contains the current RibbonPage object.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
GroupsGets the collection of Ribbon page groups owned by the current page.
ImageGets or sets an image displayed within the Ribbon page’s header. This property is obsolete. Use the ImageOptions property instead.
ImageAlignGets or sets the alignment of the image displayed within the page’s header. This property is obsolete. Use the ImageOptions property instead.
ImageIndexGets or sets an image displayed within the Ribbon page’s header. This property is obsolete. Use the ImageOptions property instead.
ImageOptionsProvides access to properties that allow you to set up raster and vector images for this page.
ImagesGets a collection of images.
ImageToTextIndentGets or sets the distance between the page header’s image and text.
ImageUri

Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current page’s tab. A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). This property is obsolete. Use the ImageOptions property instead.

| | IsInDefaultCategory | Gets or sets whether the current page belongs to the default page category. | | KeyTip | Gets or sets the Key Tip for a Ribbon Page. | | MergedGroups | Provides access to groups that have been merged into the current page. | | MergeOrder | Defines the visual position of the current RibbonPage object after merging this Ribbon Control into an MDI parent Ribbon. | | MergeType | Specifies the active merge logic for this Ribbon Page: should the parent Ribbon copy items from a merged Page, ignore them, or use them to replace its own items. | | Name | Gets the name of the current component. | | PageIndex | Gets the page’s index within the page collection of the category to which this page belongs. | | PageInfo | Gets the information used to render the Ribbon page. | | ReduceOperations | This member supports the internal infrastructure, and is not intended to be used directly from your code. | | ReduceOperationsSimplified | This member supports the internal infrastructure, and is not intended to be used directly from your code. | | Ribbon | Returns the RibbonControl which owns the current page. | | Site | Gets or sets the ISite of the Component. Inherited from Component. | | Tag | Gets or sets an object that contains data on the current RibbonPage object. | | Text | Gets or sets the text displayed within the page’s header. | | Visible | Gets or sets whether the page is visible. |

Methods

NameDescription
Clone()Creates a new RibbonPage 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, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetGroupByName(String)Locates a page group with the specified name within the current page.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetImage()Returns an image displayed within the pager’s header.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ToString()Returns the RibbonPage‘s caption.
XtraFindGroupsItem(XtraItemEventArgs)This member supports the internal infrastructure, and is not intended to be used directly from your code.

Events

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

RibbonPage Class

DevExpress.XtraBars.Ribbon Namespace