Class CustomRibbonItem

Represents the class for custom ribbon item of the QAT.

Inheritance
System.Object
CustomRibbonItem
Implements
System.IDisposable
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Tools.Controls
Assembly: Syncfusion.Tools.Wpf.dll
Syntax
public class CustomRibbonItem : IRibbonControl, IDisposable, INotifyPropertyChanged

Constructors

CustomRibbonItem(Object)

Initializes a new instance of the CustomRibbonItem class. If the source is a System.Windows.FrameworkElement with a RibbonCommandProvider in its Tag, it wraps the source in a Syncfusion.Windows.Tools.Controls.QuickAccessToolBarItem.

Declaration
public CustomRibbonItem(object source)
Parameters
Type Name Description
System.Object source

The source object used to initialize the ribbon item.

Properties

IconTemplate

Gets or sets the template that used to display the icon of CustomRibbonItem.

Declaration
public DataTemplate IconTemplate { get; set; }
Property Value
Type Description
System.Windows.DataTemplate

The System.Windows.DataTemplate that is used to display icon in CustomRibbonItem.
Remarks

IconTemplate inherits its parent DataContext. The CustomRibbonItem exposes IconTemplateSelector, IconTemplate, SmallIcon and VectorImage properties for setting the Icon. It loads icon in the following priority order,

IconTemplateSelector

Gets or sets a System.Windows.Controls.DataTemplateSelector that determines the template to display icon in a CustomRibbonItem based on SizeForm.

Declaration
public DataTemplateSelector IconTemplateSelector { get; set; }
Property Value
Type Description
System.Windows.Controls.DataTemplateSelector

A custom System.Windows.Controls.DataTemplateSelector selector object that provides logic to choose a System.Windows.DataTemplate to be returned. The default is null.
Remarks

The CustomRibbonItem exposes >IconTemplateSelector, IconTemplate, VectorImage and SmallIcon properties for setting the Icon. It loads icon in the following priority order,

See Also

IconType

Gets or sets the type of icon used for the control.

Declaration
public IconType IconType { get; set; }
Property Value
Type
IconType

Label

Gets or sets the label text associated with the control.

Declaration
public string Label { get; set; }
Property Value
Type
System.String

r_AutomationID

Gets or sets the automation ID used for UI automation scenarios.

Declaration
public string r_AutomationID { get; set; }
Property Value
Type
System.String

r_Name

Gets or sets the internal name of the control.

Declaration
public string r_Name { get; set; }
Property Value
Type
System.String

SmallIcon

Gets the small icon associated with the source element.

Declaration
public ImageSource SmallIcon { get; }
Property Value
Type
System.Windows.Media.ImageSource

ToolTip

Gets or sets the tooltip content associated with the control.

Declaration
public object ToolTip { get; set; }
Property Value
Type
System.Object

VectorImage

Gets or sets a value indicating whether VectorImage.

Declaration
public ObservableCollection<Path> VectorImage { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<System.Windows.Shapes.Path>

Methods

Dispose()

Releases resources used by the current instance.

Declaration
public void Dispose()

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable
System.ComponentModel.INotifyPropertyChanged