Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

RibbonBackstageHeaderButton Class

Namespace:
ActiproSoftware.Windows.Controls.Bars
Assembly:
ActiproSoftware.Bars.Wpf.dll

Represents a button control used within a RibbonBackstage header, alongside tabs.

public class RibbonBackstageHeaderButton : Button, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, ICommandSource, ISupportsCoerceKeyTipText, ISupportsCoerceLabel
Inheritance:
System.Object System.Windows.Threading.DispatcherObject System.Windows.DependencyObject System.Windows.Media.Visual System.Windows.UIElement System.Windows.FrameworkElement System.Windows.Controls.Control System.Windows.Controls.ContentControl System.Windows.Controls.Primitives.ButtonBase System.Windows.Controls.Button Object

Constructors

RibbonBackstageHeaderButton()

Initializes a new instance of the RibbonBackstageHeaderButton class.

public RibbonBackstageHeaderButton()

Properties

HeaderAlignment

Gets or sets a RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header.

public RibbonBackstageHeaderAlignment HeaderAlignment { get; set; }

Property Value

RibbonBackstageHeaderAlignment:

A RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header. The default value is Top.

Key

Gets or sets a string that uniquely identifies the control.

[Localizability(LocalizationCategory.NeverLocalize)]
public string Key { get; set; }

Property Value

System.String:

A string that uniquely identifies the control.

KeyTipText

Gets or sets the key tip text used to access the control.

[Localizability(LocalizationCategory.Label)]
public string KeyTipText { get; set; }

Property Value

System.String:

The key tip text used to access the control.

Label

Gets or sets the text label to display.

[Localizability(LocalizationCategory.Label)]
public string Label { get; set; }

Property Value

System.String:

The text label to display.

ScreenTipFooter

Gets or sets the screen tip footer content.

public object ScreenTipFooter { get; set; }

Property Value

System.Object:

The screen tip footer content.

ScreenTipHeader

Gets or sets the screen tip header content.

public object ScreenTipHeader { get; set; }

Property Value

System.Object:

The screen tip header content.

SmallImageSource

Gets or sets the System.Windows.Media.ImageSource for a small image, generally 16x16 size.

public ImageSource SmallImageSource { get; set; }

Property Value

System.Windows.Media.ImageSource:

The System.Windows.Media.ImageSource for a small image.

Title

Gets or sets the string title, which can override the Label when displayed in screen tips and customization UI.

[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }

Property Value

System.String:

The string title.

Methods

OnClick()

Called when a System.Windows.Controls.Button is clicked.

protected override void OnClick()

OnCreateAutomationPeer()

Creates an appropriate System.Windows.Automation.Peers.ButtonAutomationPeer for this control as part of the WPF infrastructure.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer:

A System.Windows.Automation.Peers.ButtonAutomationPeer for this control.

OnKeyTipInvoked(KeyTipInvokedEventArgs)

Occurs when the control's key tip is invoked.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)
Parameter Type Description
e KeyTipInvokedEventArgs

The KeyTipInvokedEventArgs containing data related to this event.

OnKeyTipOpening(KeyTipOpeningEventArgs)

Occurs when the control's key tip is opening.

protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)
Parameter Type Description
e KeyTipOpeningEventArgs

The KeyTipOpeningEventArgs containing data related to this event.

OnToolTipOpening(ToolTipEventArgs)

Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event.

protected override void OnToolTipOpening(ToolTipEventArgs e)
Parameter Type Description
e System.Windows.Controls.ToolTipEventArgs

Provides data about the event.

ToString()

Returns the string representation of a System.Windows.Controls.Control object.

public override string ToString()

Returns

System.String:

A string that represents the control.

Fields

HeaderAlignmentProperty

Identifies the HeaderAlignment dependency property. This field is read-only.

public static readonly DependencyProperty HeaderAlignmentProperty

KeyProperty

Identifies the Key dependency property. This field is read-only.

public static readonly DependencyProperty KeyProperty

KeyTipTextProperty

Identifies the KeyTipText dependency property. This field is read-only.

public static readonly DependencyProperty KeyTipTextProperty

LabelProperty

Identifies the Label dependency property. This field is read-only.

public static readonly DependencyProperty LabelProperty

ScreenTipFooterProperty

Identifies the ScreenTipFooter dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipFooterProperty

ScreenTipHeaderProperty

Identifies the ScreenTipHeader dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipHeaderProperty

SmallImageSourceProperty

Identifies the SmallImageSource dependency property. This field is read-only.

public static readonly DependencyProperty SmallImageSourceProperty

TitleProperty

Identifies the Title dependency property. This field is read-only.

public static readonly DependencyProperty TitleProperty

Inherited Members

  • System.Object.Equals(System.Object)
  • System.Object.Equals(System.Object, System.Object)
  • System.Object.ReferenceEquals(System.Object, System.Object)
  • System.Object.GetHashCode()
  • System.Object.GetType()
  • System.Object.MemberwiseClone()

Extension Methods