Class BackStageCommandButton

Class provides the UIAutomation support of Backstage Command Button.

Inheritance
System.Object
RibbonButton
BackStageCommandButton
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Tools.Controls
Assembly: Syncfusion.Tools.Wpf.dll
Syntax
public class BackStageCommandButton : RibbonButton, ICollapsable, IRibbonControl, IDisposable, IBackStageItem

Constructors

BackStageCommandButton()

Initializes a new instance of the BackStageCommandButton class.

Declaration
public BackStageCommandButton()

Fields

HeaderProperty

Identifies the Header dependency property.

Declaration
public static readonly DependencyProperty HeaderProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Header dependency property.

IconProperty

Identifies the Icon dependency property.

Declaration
public static readonly DependencyProperty IconProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Icon dependency property.

IsMouseOverProperty

Identifies the IsMouseOver dependency property.

Declaration
public static readonly DependencyProperty IsMouseOverProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the IsMouseOver dependency property.

PositionProperty

Identifies the Position dependency property.

Declaration
public static readonly DependencyProperty PositionProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Position dependency property.

Properties

Header

Gets or sets the header.

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

The header.

Icon

Gets or sets the value for icon image.

Declaration
public ImageSource Icon { get; set; }
Property Value
Type Description
System.Windows.Media.ImageSource

The icon.

IsMouseOver

Gets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree).

Declaration
public bool IsMouseOver { get; set; }
Property Value
Type
System.Boolean

Position

Gets or sets the placement of the BackStageCommandButton inside the Backstage.

Declaration
public VerticalPosition Position { get; set; }
Property Value
Type Description
VerticalPosition

When Position is set to Bottom, then it will be placed at bottom of the Backstage. Otherwise BackStageCommandButton will placed at top of the Backstage. The default value is Top.

Methods

OnApplyTemplate()

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

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

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

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

The type-specific AutomationPeer implementation.
Overrides

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.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 System.Windows.Input.KeyboardFocusChangedEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Occurs when a key is pressed while the control has focus.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

System.Windows.Input.KeyEventArgsThe data for the event.

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Called when an element loses keyboard focus.

Declaration
protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyboardFocusChangedEventArgs e

The event data for the System.Windows.IInputElement.LostKeyboardFocus event.

Implements

System.IDisposable