Class RibbonCheckBox

Represents a RibbonCheckBox control.

Inheritance
System.Object
RibbonCheckBox
Implements
System.IDisposable
Namespace: Syncfusion.Windows.Tools.Controls
Assembly: Syncfusion.Tools.Wpf.dll
Syntax
public class RibbonCheckBox : CheckBox, IRibbonControl, IDisposable
Remarks

RibbonCheckBox controls inherit from CheckBox and can have three states: checked, unchecked, and indeterminate. You can display CheckBox controls in a group so that users can choose from a list of options. You can also offer users a combination of options.

Constructors

RibbonCheckBox()

Initializes a new instance of the RibbonCheckBox class.

Declaration
public RibbonCheckBox()

Fields

LabelProperty

Defines the text that labels RibbonCheckBox. This is a dependency property.

Declaration
public static readonly DependencyProperty LabelProperty
Field Value
Type
System.Windows.DependencyProperty

SmallIconProperty

Defines the icon that appears in RibbonCheckBox. This is a dependency property.

Declaration
public static readonly DependencyProperty SmallIconProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

Label

Gets the value of the Label property.

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

Get the content.

SmallIcon

Gets or sets the icon that appears in RibbonCheckBox.

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

Many controls have more than just text in the element. Often there is an icon.

See Also
System.Windows.Media.ImageSource

Methods

Dispose()

Dispose all used objects

Declaration
public void Dispose()

OnCreateAutomationPeer()

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
System.Windows.Automation.Peers.AutomationPeer

The type-specific AutomationPeer implementation.

OnMouseRightButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseRightButtonUp�routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the right mouse button was released.

OnSmallIconChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises SmallIconChanged event.

Declaration
protected virtual void OnSmallIconChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property changes details, such as old value and new value.

Events

SmallIconChanged

Event that is raised when SmallIcon property is changed.

Declaration
public event PropertyChangedCallback SmallIconChanged
Event Type
Type
System.Windows.PropertyChangedCallback

Explicit Interface Implementations

IRibbonControl.get_ToolTip()

Declaration
object IRibbonControl.get_ToolTip()
Returns
Type
System.Object

Implements

System.IDisposable