Class RibbonComboBox

Represents a Ribbon selection control with a drop-down list that can be shown or hidden by clicking the arrow on the control.

Inheritance

System.Object

RibbonComboBox

Implements

IRibbonControl

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class RibbonComboBox : ComboBox, IRibbonControl, IDisposable

Remarks

The RibbonComboBox allows the user to select an item from a drop-down list or optionally to enter new text in the text box of the control.

Constructors

RibbonComboBox()

Initializes a new instance of the RibbonComboBox class.

Declaration

public RibbonComboBox()

Fields

LabelProperty

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

Declaration

public static readonly DependencyProperty LabelProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SmallIconProperty

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

Declaration

public static readonly DependencyProperty SmallIconProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Properties

Label

Gets or sets the text that labels RibbonComboBox.

Declaration

public string Label { get; set; }

Property Value

Type	Description
System.String	Type: System.String Text that labels the RibbonComboBox. The default is empty string.

See Also

System.String

SmallIcon

Gets or sets the icon that appears in RibbonComboBox.

Declaration

public ImageSource SmallIcon { get; set; }

Property Value

Type	Description
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()

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Type	Description
System.Windows.DependencyObject	The element that is used to display the given item.

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Type	Name	Description
System.Object	item	The item to check.

Returns

Type	Description
System.Boolean	Returns true if the item is (or is eligible to be) its own container; otherwise, false.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.

Declaration

public override void OnApplyTemplate()

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.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled Keyboard.GotKeyboardFocus attached 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 OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyboardFocusChangedEventArgs	e	The event data

OnKeyDown(KeyEventArgs)

Invoked when an unhandled Keyboard.KeyDown attached 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 OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The event data

OnLabelChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises LabelChanged event.

Declaration

protected virtual void OnLabelChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property changes details, such as old value and new value.

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled Keyboard.LostKeyboardFocus attached 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 OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyboardFocusChangedEventArgs	e	The event data

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.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Type	Name	Description
System.Windows.DependencyObject	element	Element used to display the specified item.
System.Object	item	Specified item.

Events

LabelChanged

Event that is raised when Label property is changed.

Declaration

public event PropertyChangedCallback LabelChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

SmallIconChanged

Event that is raised when SmallIcon property is changed.

Declaration

public event PropertyChangedCallback SmallIconChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

Explicit Interface Implementations

IRibbonControl.get_ToolTip()

Declaration

object IRibbonControl.get_ToolTip()

Returns

Type	Description
System.Object

Implements

IRibbonControl

System.IDisposable