Class BinaryKeyTip

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

Namespace: Binarymission.WPF.Controls.Office

Assembly: Binarymission.WPF.Controls.BinaryRibbon.dll

Syntax

public class BinaryKeyTip : 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 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.

Constructors

BinaryKeyTip()

Declaration

public BinaryKeyTip()

Methods

ChangeColorForAccessTips(FrameworkElement, Brush, BinaryKeyTip.BrushChangeTargetProperty)

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

Declaration

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

Parameters

Type	Name	Description
FrameworkElement	fe	The Framework element on which the keytip is set.
Brush	desiredBrush	The desired brush.
BinaryKeyTip.BrushChangeTargetProperty	changeTargetProperty	The change target property as is listed in BinaryKeyTip.BrushChangeTargetProperty.

GetAccessKey(DependencyObject)

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

Declaration

public static string GetAccessKey(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
String

GetDeferOrDisable(DependencyObject)

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

Declaration

public static bool GetDeferOrDisable(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Boolean

GetTipBackground(DependencyObject)

Gets the Keytip background brush.

Declaration

public static Brush GetTipBackground(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Brush

GetTipForeground(DependencyObject)

Gets the Keytip foreground brush.

Declaration

public static Brush GetTipForeground(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Brush

GetXOffset(DependencyObject)

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

Declaration

public static double GetXOffset(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Double

GetYOffset(DependencyObject)

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

Declaration

public static double GetYOffset(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Double

SetAccessKey(DependencyObject, String)

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

Declaration

public static void SetAccessKey(DependencyObject obj, string value)

Parameters

Type	Name	Description
DependencyObject	obj
String	value

SetDeferOrDisable(DependencyObject, Boolean)

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

Declaration

public static void SetDeferOrDisable(DependencyObject obj, bool value)

Parameters

Type	Name	Description
DependencyObject	obj
Boolean	value

SetTipBackground(DependencyObject, Brush)

Sets the keytip background brush.

Declaration

public static void SetTipBackground(DependencyObject obj, Brush value)

Parameters

Type	Name	Description
DependencyObject	obj
Brush	value

SetTipForeground(DependencyObject, Brush)

Sets the Keytip foreground brush.

Declaration

public static void SetTipForeground(DependencyObject obj, Brush value)

Parameters

Type	Name	Description
DependencyObject	obj
Brush	value

SetXOffset(DependencyObject, Double)

Sets the X offset for displaying the KeyTip.

Declaration

public static void SetXOffset(DependencyObject obj, double value)

Parameters

Type	Name	Description
DependencyObject	obj
Double	value

SetYOffset(DependencyObject, Double)

Sets the Y offset for displaying the KeyTip.

Declaration

public static void SetYOffset(DependencyObject obj, double value)

Parameters

Type	Name	Description
DependencyObject	obj
Double	value