WPF › Ribbon › BinaryKeyTip

BinaryKeyTip

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Controls.Office

A class that helps in displaying KeyTips on all controls hosted in BinaryRibbonWindow control.

public class BinaryKeyTip : Control

Inherits from / implements: Control

Remarks

BinaryRibbon supports the concept of KeyTips whereby any control in the Ribbon Window can be associated with a key code to provide keyboard access to the control.
Upon invoking the specified keyboard key code as is specified in the KeyTip of the control, the control is expected to perform some command invocation, like a button's click event handling and the like.
Any control that is hosted in the BinaryRibbonWindow can have a KeyTip specified on them by using the AccessKey attached property.
When the user invokes the specified KeyTip, if the control wants to execute some logic, then it needs to implement this interface IBinaryRibbonKeyTipControl.
By implementing the prescribed method PerformKeyTipExecute, BinaryRibbon control will ensure that the implemented method is run at the time when the user invokes the specified AccessKey/Keytip.

Members at a glance

`ChangeColorForAccessTips`	A helper method for changing the color for access tips on a given framework element.
`GetAccessKey`	Gets the access key / keytip / key code string set for a given control's instance.
`GetDeferOrDisable`	Gets as to whether to defer or disable keytip display on a given control.
`GetTipBackground`	Gets the Keytip background brush.
`GetTipForeground`	Gets the Keytip foreground brush.
`GetXOffset`	Gets the X offset of the bounds where the KeyTip will be displayed.
`GetYOffset`	Gets the Y offset of the bounds where the KeyTip will be displayed.
`SetAccessKey`	Sets the access key / keytip / key code string for a given control's instance.
`SetDeferOrDisable`	Sets as to whether to defer or disable keytip display on a given control.
`SetTipBackground`	Sets the keytip background brush.
`SetTipForeground`	Sets the Keytip foreground brush.
`SetXOffset`	Sets the X offset for displaying the KeyTip.
`SetYOffset`	Sets the Y offset for displaying the KeyTip.
`AccessKeyProperty`	Attached property for the AccessKey property.
`DeferOrDisableProperty`	DeferOrDisableProperty attached property.
`TipBackgroundProperty`	Attached property for KeyTip background brush.
`TipForegroundProperty`	Attached property for KeyTip foreground brush.
`XOffsetProperty`	XOffset attached property.
`YOffsetProperty`	YOffset attached property.

Methods

ChangeColorForAccessTips

public static void ChangeColorForAccessTips(FrameworkElement fe, Brush desiredBrush, BrushChangeTargetProperty changeTargetProperty)

A helper method for changing the color for access tips on a given framework element.

fe: The Framework element on which the keytip is set.
desiredBrush: The desired brush.
changeTargetProperty: The change target property as is listed in BrushChangeTargetProperty.

GetAccessKey

public static string GetAccessKey(DependencyObject obj)

Gets the access key / keytip / key code string set for a given control's instance.

GetDeferOrDisable

public static bool GetDeferOrDisable(DependencyObject obj)

Gets as to whether to defer or disable keytip display on a given control.

GetTipBackground

public static Brush GetTipBackground(DependencyObject obj)

Gets the Keytip background brush.

GetTipForeground

public static Brush GetTipForeground(DependencyObject obj)

Gets the Keytip foreground brush.

GetXOffset

public static double GetXOffset(DependencyObject obj)

Gets the X offset of the bounds where the KeyTip will be displayed.

GetYOffset

public static double GetYOffset(DependencyObject obj)

Gets the Y offset of the bounds where the KeyTip will be displayed.

SetAccessKey

public static void SetAccessKey(DependencyObject obj, string value)

Sets the access key / keytip / key code string for a given control's instance.

SetDeferOrDisable

public static void SetDeferOrDisable(DependencyObject obj, bool value)

Sets as to whether to defer or disable keytip display on a given control.

SetTipBackground

public static void SetTipBackground(DependencyObject obj, Brush value)

Sets the keytip background brush.

SetTipForeground

public static void SetTipForeground(DependencyObject obj, Brush value)

Sets the Keytip foreground brush.

SetXOffset

public static void SetXOffset(DependencyObject obj, double value)

Sets the X offset for displaying the KeyTip.

SetYOffset

public static void SetYOffset(DependencyObject obj, double value)

Sets the Y offset for displaying the KeyTip.

Fields

AccessKeyProperty

public static readonly DependencyProperty AccessKeyProperty

Attached property for the AccessKey property.

DeferOrDisableProperty

public static readonly DependencyProperty DeferOrDisableProperty

DeferOrDisableProperty attached property.

TipBackgroundProperty

public static readonly DependencyProperty TipBackgroundProperty

Attached property for KeyTip background brush.

TipForegroundProperty

public static readonly DependencyProperty TipForegroundProperty

Attached property for KeyTip foreground brush.

XOffsetProperty

public static readonly DependencyProperty XOffsetProperty

XOffset attached property.

YOffsetProperty

public static readonly DependencyProperty YOffsetProperty

YOffset attached property.