Version

Ribbon Class Members

The following tables list the members exposed by Ribbon.

Protected Constructors
 NameDescription
Protected ConstructorRibbon ConstructorConstructor used for deserialization.  
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectReturns the System.Windows.Forms.AccessibleObject for this toolbar.  
Public PropertyAccessibleDescriptionReturns or sets a string that describes the accessible description of the ribbon.  
Public PropertyAllowAutoHideGets or sets if the Ribbon can be auto-hidden and if the Ribbon Display Options button is displayed.  
Public PropertyApplicationMenuReturns the object that represents the main application menu that is displayed when the button in the upper left corner of the ribbon is clicked.  
Public PropertyApplicationMenu2010Returns the object that represents the main application menu that is displayed when the Application Menu button is click when using Office2010 Style.  
Public PropertyApplicationMenuButtonImageReturns or sets the image that is displayed within the application menu button in the upper left area of the ribbon.  
Public PropertyAutoCollapseThresholdHorizontalReturns or sets the minimum width of the UltraToolbarsManager.DockWithinContainer before ribbon area is automatically hidden.  
Public PropertyAutoCollapseThresholdHorizontalResolvedReturns the actual AutoCollapseThresholdHorizontal that the ribbon will use to determine when it should automatically collapse.  
Public PropertyAutoCollapseThresholdVerticalReturns or sets the minimum height of the UltraToolbarsManager's DockWithinContainer before ribbon area is hidden.  
Public PropertyAutoCollapseThresholdVerticalResolvedReturns the actual AutoCollapseThresholdVertical that the ribbon will use to determine when it should automatically collapse.  
Public PropertyCaptionReturns or sets the caption that will be displayed in the ribbon caption area.  
Public PropertyCaptionAreaActiveAppearanceReturns or sets the appearance used to render the background of the caption area when the form is active.  
Public PropertyCaptionAreaAppearanceReturns or sets the appearance used to render the background of the caption area.  
Public PropertyCaptionButtonsAppearancesGets/Sets the appearance of caption buttons with the exception of the caption buttons on maximized MDI child forms.  
Public PropertyCaptionInactiveReturns or sets the caption that will be displayed in the ribbon caption area when the containing form is inactive.  
Public PropertyContextualTabGroupsReturns the collection of ContextualTabGroup instances in the ribbon.  
Public PropertyDefaultCaptionButtonsAppearancesGets/Sets the general appearance of all caption buttons.  
Public PropertyDisplayModeGets/Sets the current state of the Ribbon.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyFileMenuButtonActiveAppearanceGets/Sets File Menu button's active and pressed appearance.  
Public PropertyFileMenuButtonAppearanceGets/Sets File Menu button's appearance.  
Public PropertyFileMenuButtonCaptionGets/Sets caption for the File Menu button.  
Public PropertyFileMenuButtonCaptionResolvedGets the caption for the file menu button (if there is one) and FileMenuButtonCaptionVisible is true.  
Public PropertyFileMenuButtonCaptionVisibleGets/Sets whether the file menu button displays a caption.  
Public PropertyFileMenuButtonHotTrackAppearanceGets/Sets File Menu button's hot track appearance  
Public PropertyFileMenuStyleGets/Sets file menu style for the menu that will show up when the menu button is clicked.  
Public PropertyGroupBorderStyleReturns or sets the border style for the ribbon groups.  
Public PropertyGroupBorderStyleResolvedReturns the resolved border style for the ribbon groups.  
Public PropertyGroupSettingsReturns an object that can be used to specify default values for the RibbonGroup objects in the tabs of the ribbon.  
Public PropertyHasCaptionAreaActiveAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasCaptionAreaAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasCaptionButtonsAppearancesReturns whether a CaptionButtonsAppearances object has been created for the CaptionButtonsAppearances.  
Public PropertyHasDefaultCaptionButtonsAppearancesReturns whether a CaptionButtonsAppearances object has been created for the DefaultCaptionButtonsAppearances.  
Public PropertyHasFileMenuButtonActiveAppearanceTrue if an appearance object has been allocated  
Public PropertyHasFileMenuButtonAppearanceTrue if an appearance object has been allocated  
Public PropertyHasFileMenuButtonHotTrackAppearanceTrue if an appearance object has been allocated  
Public PropertyHasGroupSettingsIndicates whether the RibbonGroupSettings object for the GroupSettings property has been created.  
Public PropertyHasMaximizedMdiChildFormCaptionButtonsAppearancesReturns whether a CaptionButtonsAppearances object has been created for the MaximizedMdiChildFormCaptionButtonsAppearances.  
Public PropertyHasRibbonAreaAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasTabAreaAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasTabSettingsIndicates whether the RibbonTabSettings object for the TabSettings property has been created.  
Public PropertyMaximizedMdiChildFormCaptionButtonsAppearancesGets/Sets the appearance of caption buttons on maximized MDI child forms.  
Public PropertyMultiMonitorDropDownBehaviorReturns or sets the MultiMonitorDropDownBehavior for the Ribbon.  
Public PropertyNotificationBadgeSettingsThe NotificationBadgeSettings for the whole Ribbon  
Public PropertyQuickAccessToolbarReturns the object that represents the toolbar displayed above or below the ribbon that contains frequently used tools.  
Public PropertyReservedKeyTipToolTipTextGets or sets the formatted text displayed in a tool tip when a reserved key tip is used.  
Public PropertyReservedKeyTipToolTipTextResolvedGets the resolved value of ReservedKeyTipToolTipText.  
Public PropertyReservedKeyTipToolTipTitleGets or sets the title displayed in a tool tip when a reserved key tip is used.  
Public PropertyReservedKeyTipToolTipTitleResolvedGets the resolved value of ReservedKeyTipToolTipTitle.  
Public PropertyReserveMenuBarKeyTipsGets or sets the value indicating whether to prevent the first-level key tips of the ribbon from conflicting with the mnemonics on a hidden main menu bar.  
Public PropertyRibbonAreaAppearanceReturns or sets the appearance used to render the background of the ribbon area.  
Public PropertyRibbonCaptionAreaAccessibilityObjectThe accessible object for the ribbon caption area  
Public PropertyRibbonCaptionCloseButtonAccessibilityObjectThe accessible object for the ribbon caption close button  
Public PropertyRibbonCaptionMaximizeButtonAccessibilityObjectThe accessible object for the ribbon caption maximize button  
Public PropertyRibbonCaptionMinimizeButtonAccessibilityObjectThe accessible object for the ribbon caption minimize button  
Public PropertyRibbonCustomizationProviderGets or set the provider that should be used for the customizing the ribbon.  
Public PropertyRibbonGroupAreaAccessibilityObjectThe accessible object for the ribbon group area  
Public PropertyRibbonGroupAreaPagerButtonLeftAccessibilityObjectThe accessible object for the left pager button inside the ribbon group area  
Public PropertyRibbonGroupAreaPagerButtonRightAccessibilityObjectThe accessible object for the right pager button inside the ribbon group area  
Public PropertyRibbonTabItemAreaAccessibilityObjectThe accessible object for the ribbon tab item area  
Public PropertyRibbonTabPagerButtonLeftAccessibilityObjectThe accessible object for the left pager button inside the ribbon tab item area  
Public PropertyRibbonTabPagerButtonRightAccessibilityObjectThe accessible object for the right pager button inside the ribbon tab item area  
Public PropertySelectedTabReturns or sets the tab in the ribbon whose contents are visible to the end user.  
Public PropertyTabAreaAppearanceReturns or sets the appearance used to render the area behind the tab items and tab page.  
Public PropertyTabItemAreaDisplayStyleGets/sets a value indicating how the Ribbon's Tab Item Area will be shown  
Public PropertyTabItemToolbarGets the toolbar which shows tools on the right side of the ribbon tab area.  
Public PropertyTabsReturns a collection of RibbonTab objects that represent the tab items of the ribbon.  
Public PropertyTabSettingsReturns an object that provides the default values for the tabs within the ribbon.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyToolbarsManagerThe UltraToolbarsManager component that owns the Ribbon.  
Public PropertyVisibleReturns or sets whether the Ribbon area is visible.  
Protected Properties
 NameDescription
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownDisplays the entire Ribbon or the contents of the SelectedTab when the DisplayMode property is set to RibbonDisplayMode.AutoHide or RibbonDisplayMode.TabsOnly.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGroupFromPointReturns the RibbonGroup at the specified screen coordinate.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodResetResets the settings of the object to their default values.  
Public MethodResetAccessibleDescriptionResets the AccessibleDescription property to its default value.  
Public MethodResetAllowAutoHideResets the AllowAutoHide property to its default value.  
Public MethodResetApplicationMenuResets the ApplicationMenu collection.  
Public MethodResetApplicationMenu2010Resets the ApplicationMenu2010 object.  
Public MethodResetCaptionAreaActiveAppearanceResets the CaptionAreaActiveAppearance property to its default value.  
Public MethodResetCaptionAreaAppearanceResets the CaptionAreaAppearance property to its default value.  
Public MethodResetCaptionButtonsAppearancesResets the properties of the CaptionButtonsAppearances to their default values.  
Public MethodResetContextualTabGroupsResets the ContextualTabGroups collection.  
Public MethodResetDefaultCaptionButtonsAppearancesResets the properties of the DefaultCaptionButtonsAppearances to their default values.  
Public MethodResetDisplayModeResets the DisplayMode property to its default value.  
Public MethodResetFileMenuButtonActiveAppearanceResets the FileMenuButtonActiveAppearance property to its default value.  
Public MethodResetFileMenuButtonAppearanceResets the FileMenuButtonAppearance property to its default value.  
Public MethodResetFileMenuButtonCaptionResets the FileMenuButtonCaption property to its default value.  
Public MethodResetFileMenuButtonCaptionVisibleResets the FileMenuButtonCaptionVisible property to its default value.  
Public MethodResetFileMenuButtonHotTrackAppearanceResets the FileMenuButtonHotTrackAppearance property to its default value.  
Public MethodResetFileMenuStyleResets the FileMenuStyle property to its default value.  
Public MethodResetGroupBorderStyleResets the GroupBorderStyle property to its default value.  
Public MethodResetGroupSettingsResets the GroupSettings collection.  
Public MethodResetMaximizedMdiChildFormCaptionButtonsAppearancesResets the properties of the MaximizedMdiChildFormCaptionButtonsAppearances to their default values.  
Public MethodResetMultiMonitorDropDownBehaviorResets the UltraToolbarsManager.MultiMonitorDropDownBehavior property to its default value.  
Public MethodResetNotificationBadgeSettingsResets the NotificationBadgeSettings to their default value (null)  
Public MethodResetQuickAccessToolbarResets the QuickAccessToolbar collection.  
Public MethodResetRibbonAreaAppearanceResets the RibbonAreaAppearance property to its default value.  
Public MethodResetRibbonCustomizationProviderResets the property to its default value.  
Public MethodResetTabAreaAppearanceResets the TabAreaAppearance property to its default value.  
Public MethodResetTabItemAreaDisplayStyleResets the TabItemAreaDisplayStyle property to its default value.  
Public MethodResetTabItemToolbarResets the TabItemToolbar collection.  
Public MethodResetTabsResets the Tabs collection.  
Public MethodResetTabSettingsResets the TabSettings collection.  
Public MethodResolveGroupCaptionAppearanceResolves the appearance of the caption area of the provider RibbonGroup.  
Public MethodShouldSerializeDetermines whether any properties of the object differ from their default values.  
Public MethodShouldSerializeApplicationMenuDetermines whether the ApplicationMenu property is set to its default value.  
Public MethodShouldSerializeApplicationMenu2010Determines whether the ApplicationMenu2010 property is set to its default value.  
Public MethodShouldSerializeContextualTabGroupsDetermines whether the ContextualTabGroups property is set to its default value.  
Public MethodShouldSerializeGroupBorderStyleDetermines whether the GroupBorderStyle property is set to its default value.  
Public MethodShouldSerializeGroupSettingsDetermines whether the GroupSettings property is set to its default value.  
Public MethodShouldSerializeNotificationBadgeSettingsDetermines if the NotificationBadgeSettings should be serialized  
Public MethodShouldSerializeQuickAccessToolbarDetermines whether the QuickAccessToolbar property is set to its default value.  
Public MethodShouldSerializeTabItemToolbarDetermines whether the TabItemToolbar property is set to its default value.  
Public MethodShouldSerializeTabsDetermines whether the Tabs property is set to its default value.  
Public MethodShouldSerializeTabSettingsDetermines whether the TabSettings property is set to its default value.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodShowRibbonCustomizationDialogDisplays the RibbonCustomizationProvider's dialog.  
Public MethodTabFromPointReturns the RibbonTab at the specified screen coordinate.  
Public MethodToStringReturns an empty string so nothing shows up on the right side of the property grid.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodGetObjectDataPopulates the specified System.Runtime.Serialization.SerializationInfo with the data from the object.  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnDeserializationInvoked after the entire object graph has been deserialized.  
Protected MethodOnDisposeOverridden. Invoked when the object is disposed.  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when a property has changed on a sub object.  
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeAllowAutoHide

Returns a Boolean value that determines whether the AllowAutoHide property is set to its default value.

 
Protected MethodShouldSerializeCaptionAreaActiveAppearanceDetermines whether the CaptionAreaActiveAppearance property is set to its default value.  
Protected MethodShouldSerializeCaptionAreaAppearanceDetermines whether the CaptionAreaAppearance property is set to its default value.  
Protected MethodShouldSerializeCaptionButtonsAppearancesReturns whether the CaptionButtonsAppearances requires serialization.  
Protected MethodShouldSerializeDefaultCaptionButtonsAppearancesReturns whether the DefaultCaptionButtonsAppearances requires serialization.  
Protected MethodShouldSerializeDisplayMode

Returns a Boolean value that determines whether the DisplayMode property is set to its default value.

 
Protected MethodShouldSerializeFileMenuButtonActiveAppearance

Returns a Boolean value that determines whether the FileMenuButtonActiveAppearance property is set to its default value.

 
Protected MethodShouldSerializeFileMenuButtonAppearance

Returns a Boolean value that determines whether the FileMenuButtonAppearance property is set to its default value.

 
Protected MethodShouldSerializeFileMenuButtonCaption

Returns a Boolean value that determines whether the FileMenuButtonCaption property is set to its default value.

 
Protected MethodShouldSerializeFileMenuButtonCaptionVisible

Returns a Boolean value that determines whether the FileMenuButtonCaptionVisible property is set to its default value.

 
Protected MethodShouldSerializeFileMenuButtonHotTrackAppearance

Returns a Boolean value that determines whether the FileMenuButtonHotTrackAppearance property is set to its default value.

 
Protected MethodShouldSerializeFileMenuStyle

Returns a Boolean value that determines whether the FileMenuStyle property is set to its default value.

 
Protected MethodShouldSerializeMaximizedMdiChildFormCaptionButtonsAppearancesReturns whether the MaximizedMdiChildFormCaptionButtonsAppearances requires serialization.  
Protected MethodShouldSerializeMultiMonitorDropDownBehaviorDetermines whether the MultiMonitorDropDownBehavior property is set to its default value.  
Protected MethodShouldSerializeRibbonAreaAppearanceDetermines whether the RibbonAreaAppearance property is set to its default value.  
Protected MethodShouldSerializeTabAreaAppearanceDetermines whether the TabAreaAppearance property is set to its default value.  
Protected MethodShouldSerializeTabItemAreaDisplayStyle

Returns a Boolean value that determines whether the TabItemAreaDisplayStyle property is set to its default value.

 
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also