Class RibbonCommandProvider

Provides the main user interface data for all controls that use a certain command.

Inheritance

System.Object

RibbonCommandProvider

Implements

IRibbonControl

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class RibbonCommandProvider : DependencyObject, IRibbonControl, IDisposable

Constructors

RibbonCommandProvider()

Initializes a new instance of the RibbonCommandProvider class.

Declaration

public RibbonCommandProvider()

RibbonCommandProvider(String)

Initializes a new instance of the RibbonCommandProvider class.

Declaration

public RibbonCommandProvider(string label)

Parameters

Type	Name	Description
System.String	label	The label.

RibbonCommandProvider(String, String, String)

Initializes a new instance of the RibbonCommandProvider class.

Declaration

public RibbonCommandProvider(string groupName, string label, string image)

Parameters

Type	Name	Description
System.String	groupName	Name of the group.
System.String	label	The label Text that will be displayed for control that use this command.
System.String	image	The image that will be displayed for control that use this command.

RibbonCommandProvider(String, String, String, Object)

Initializes a new instance of the RibbonCommandProvider class.

Declaration

public RibbonCommandProvider(string groupName, string label, string image, object toolTip)

Parameters

Type	Name	Description
System.String	groupName	Name of the group.
System.String	label	The label param value.
System.String	image	The image param value.
System.Object	toolTip	The tool tip value.

RibbonCommandProvider(String, String, ImageSource, Object)

Initializes a new instance of the RibbonCommandProvider class.

Declaration

public RibbonCommandProvider(string groupName, string label, ImageSource image, object toolTip)

Parameters

Type	Name	Description
System.String	groupName	Name of the group.
System.String	label	The label value.
System.Windows.Media.ImageSource	image	The image source.
System.Object	toolTip	The tool tip value.

Fields

GroupNameProperty

Defines group name in which command will be placed. This is a dependency property.

Declaration

public static readonly DependencyProperty GroupNameProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ImageProperty

Defines the image that will be displayed for control that use this command.

Declaration

public static readonly DependencyProperty ImageProperty

Field Value

Type	Description
System.Windows.DependencyProperty

LabelProperty

Defines the text that will be displayed for control that use this command.

Declaration

public static readonly DependencyProperty LabelProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SourceElementProperty

Defines the source element. This is a dependency property.

Declaration

protected static readonly DependencyProperty SourceElementProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SourceElementPropertyKey

Defines the source element. This is a dependency property key.

Declaration

protected static readonly DependencyPropertyKey SourceElementPropertyKey

Field Value

Type	Description
System.Windows.DependencyPropertyKey

ToolTipProperty

Defines the tooltip that will be displayed for control that use this command.

Declaration

public static readonly DependencyProperty ToolTipProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Properties

Command

Gets or sets a command associated with provider.

Declaration

protected ICommand Command { get; set; }

Property Value

Type	Description
System.Windows.Input.ICommand

See Also

System.Windows.Input.ICommand

CommandParameter

Gets or sets a command parameter associated with command.

Declaration

protected object CommandParameter { get; set; }

Property Value

Type	Description
System.Object

See Also

System.Windows.Input.ICommand

GroupName

Gets the name of the QATCustomization dialog group.

Declaration

public string GroupName { get; }

Property Value

Type	Description
System.String

Label

Gets the value of the Label property.

Declaration

public string Label { get; }

Property Value

Type	Description
System.String

SmallIcon

Gets the value of the Image property.

Declaration

public ImageSource SmallIcon { get; }

Property Value

Type	Description
System.Windows.Media.ImageSource

ToolTip

Gets or sets tooltip of the control.

Declaration

public object ToolTip { get; set; }

Property Value

Type	Description
System.Object

Methods

Dispose()

Dispose all used objects

Declaration

public void Dispose()

Implements

IRibbonControl

System.IDisposable