In This Article

RibbonControlCustomizationCategory Class

Represents a customization category.

public class RibbonControlCustomizationCategory : DependencyObject
Inheritance:
object object

Constructors

RibbonControlCustomizationCategory(UIElement)

Initializes a new instance of the RibbonControlCustomizationCategory class.

public RibbonControlCustomizationCategory(UIElement sourceLocation)
Parameter Type Description
sourceLocation UIElement

The source location of the category.

Properties

Label

Gets or sets the category label.

public string Label { get; set; }

Property Value

string:

The category label.

Methods

DisposeUnusedClones(Ribbon, DeferrableObservableCollection<RibbonControlReference>)

Disposes any clones created during a customization session in which the clones that were created did not get applied to be used on the Ribbon.

public static void DisposeUnusedClones(Ribbon ribbon, DeferrableObservableCollection<RibbonControlReference> items)
Parameter Type Description
ribbon Ribbon

The Ribbon to update.

items DeferrableObservableCollection<RibbonControlReference>

The list of items that should appear in the QAT.

GetCategories(Ribbon)

Returns a list of all the ribbon control customization categories for the specified Ribbon.

public static DeferrableObservableCollection<RibbonControlCustomizationCategory> GetCategories(Ribbon ribbon)
Parameter Type Description
ribbon Ribbon

The Ribbon to examine.

Returns

DeferrableObservableCollection<RibbonControlCustomizationCategory>:

A list of all the ribbon control customization categories for the specified Ribbon.

GetControls()

Returns a list of all the ribbon controls located within the category.

public virtual DeferrableObservableCollection<RibbonControlReference> GetControls()

Returns

DeferrableObservableCollection<RibbonControlReference>:

A list of all the ribbon controls located within the category.

GetQuickAccessToolBarItems(Ribbon)

Gets a list of RibbonControlReference items that represent the current list of items in the specified Ribbon's QAT.

public static DeferrableObservableCollection<RibbonControlReference> GetQuickAccessToolBarItems(Ribbon ribbon)
Parameter Type Description
ribbon Ribbon

The Ribbon to examine.

Returns

DeferrableObservableCollection<RibbonControlReference>:

A list of RibbonControlReference items that represent the current list of items in the specified Ribbon's QAT.

SetQuickAccessToolBarItems(Ribbon, DeferrableObservableCollection<RibbonControlReference>)

Replaces the items in the specified Ribbon's QAT with the specified items list.

public static void SetQuickAccessToolBarItems(Ribbon ribbon, DeferrableObservableCollection<RibbonControlReference> items)
Parameter Type Description
ribbon Ribbon

The Ribbon to update.

items DeferrableObservableCollection<RibbonControlReference>

The list of items that should appear in the QAT.

Fields

LabelProperty

Identifies the Label dependency property. This field is read-only.

public static readonly DependencyProperty LabelProperty