RibbonControlReference Class
Provides a reference for a ribbon control.
public class RibbonControlReference : DependencyObject, IComparable
- Inheritance:
- object object
- Implements:
- IComparable
Constructors
RibbonControlReference(UIElement)
Initializes a new instance of the RibbonControlReference
class.
public RibbonControlReference(UIElement control)
Parameter | Type | Description |
---|---|---|
control | UIElement | The UIElement that is referenced. |
Properties
Control
Gets or sets the UIElement that is referenced.
ControlType
Gets or sets a CommonControlType specifying the type of control.
public CommonControlType ControlType { get; set; }
Property Value
- CommonControlType:
A CommonControlType specifying the type of control.
ImageSource
Gets or sets the image that should be displayed in the customization UI.
public ImageSource ImageSource { get; set; }
Property Value
- ImageSource:
The image that should be displayed in the customization UI.
Label
Gets or sets the label that should be displayed in the customization UI.
public string Label { get; set; }
Property Value
- string:
The label that should be displayed in the customization UI.
Methods
Clone()
Clones the control wrapped by this reference, so that the clone may be added to the QAT.
IsAlreadyAdded(DeferrableObservableCollection<RibbonControlReference>)
Returns whether the referenced control is already included in the specified list.
public bool IsAlreadyAdded(DeferrableObservableCollection<RibbonControlReference> items)
Parameter | Type | Description |
---|---|---|
items | DeferrableObservableCollection<RibbonControlReference> | The list of items to examine. |
Returns
- bool:
true
if the referenced control is already included in the specified list; otherwise,false
.
Fields
ControlProperty
Identifies the Control dependency property. This field is read-only.
public static readonly DependencyProperty ControlProperty
ControlTypeProperty
Identifies the ControlType dependency property. This field is read-only.
public static readonly DependencyProperty ControlTypeProperty
ImageSourceProperty
Identifies the ImageSource dependency property. This field is read-only.
public static readonly DependencyProperty ImageSourceProperty
LabelProperty
Identifies the Label dependency property. This field is read-only.
public static readonly DependencyProperty LabelProperty