KeyTipService Class
A service for managing key tips.
public class KeyTipService- Inheritance:
- object object
Properties
AllowedKeyTipModeShortcuts
Gets or sets the key tip mode shortcuts that are allowed.
public static KeyTipModeShortcuts AllowedKeyTipModeShortcuts { get; set; }Property Value
- KeyTipModeShortcuts:
The KeyTipModeShortcuts value indicating the allowed shortcuts.
Methods
AddKeyTipInvokedHandler(DependencyObject, EventHandler<KeyTipInvokedEventArgs>)
Adds a handler for the KeyTipInvoked event to the specified object.
public static void AddKeyTipInvokedHandler(DependencyObject obj, EventHandler<KeyTipInvokedEventArgs> handler)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object requiring the handler. |
| handler | EventHandler<KeyTipInvokedEventArgs> | The event handler. |
AddKeyTipOpeningHandler(DependencyObject, EventHandler<KeyTipOpeningEventArgs>)
Adds a handler for the KeyTipOpening event to the specified object.
public static void AddKeyTipOpeningHandler(DependencyObject obj, EventHandler<KeyTipOpeningEventArgs> handler)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object requiring the handler. |
| handler | EventHandler<KeyTipOpeningEventArgs> | The event handler. |
GetIsKeyTipBoundary(DependencyObject)
Gets the value of the IsKeyTipBoundary attached property for the specified object.
public static bool GetIsKeyTipBoundary(DependencyObject obj)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object from which the property value is read. |
Returns
- bool:
The object's value.
GetIsRootKeyTipScope(DependencyObject)
Gets the value of the IsRootKeyTipScope attached property for the specified object.
public static bool GetIsRootKeyTipScope(DependencyObject obj)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object from which the property value is read. |
Returns
- bool:
The object's value.
GetKeyTipText(DependencyObject)
Gets the value of the KeyTipText attached property for the specified object.
public static string GetKeyTipText(DependencyObject obj)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object from which the property value is read. |
Returns
- string:
The object's value.
RemoveKeyTipInvokedHandler(DependencyObject, EventHandler<KeyTipInvokedEventArgs>)
Removes a handler for the KeyTipInvoked event from the specified object.
public static void RemoveKeyTipInvokedHandler(DependencyObject obj, EventHandler<KeyTipInvokedEventArgs> handler)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object with the handler. |
| handler | EventHandler<KeyTipInvokedEventArgs> | The event handler. |
RemoveKeyTipOpeningHandler(DependencyObject, EventHandler<KeyTipOpeningEventArgs>)
Removes a handler for the KeyTipOpening event from the specified object.
public static void RemoveKeyTipOpeningHandler(DependencyObject obj, EventHandler<KeyTipOpeningEventArgs> handler)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object with the handler. |
| handler | EventHandler<KeyTipOpeningEventArgs> | The event handler. |
SetIsKeyTipBoundary(DependencyObject, bool)
Sets the value of the IsKeyTipBoundary attached property to the specified object.
public static void SetIsKeyTipBoundary(DependencyObject obj, bool value)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object to which the attached property is written. |
| value | bool | The value to set. |
SetIsRootKeyTipScope(DependencyObject, bool)
Sets the value of the IsRootKeyTipScope attached property to the specified object.
public static void SetIsRootKeyTipScope(DependencyObject obj, bool value)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object to which the attached property is written. |
| value | bool | The value to set. |
SetKeyTipText(DependencyObject, string)
Sets the value of the KeyTipText attached property to the specified object.
public static void SetKeyTipText(DependencyObject obj, string value)| Parameter | Type | Description |
|---|---|---|
| obj | DependencyObject | The object to which the attached property is written. |
| value | string | The value to set. |
UpdateIsActiveRootKeyTipScope(FrameworkElement)
Updates the core property tracking whether a control is loaded and actively a root key tip scope.
public static void UpdateIsActiveRootKeyTipScope(FrameworkElement element)| Parameter | Type | Description |
|---|---|---|
| element | FrameworkElement | The control to examine. |
Remarks
This method should be called by root key tip scope controls when their Loaded and Unloaded events are raised.
Fields
IsKeyTipBoundaryProperty
Identifies the IsKeyTipBoundary dependency property. This field is read-only.
public static readonly DependencyProperty IsKeyTipBoundaryPropertyIsRootKeyTipScopeProperty
Identifies the IsRootKeyTipScope dependency property. This field is read-only.
public static readonly DependencyProperty IsRootKeyTipScopePropertyKeyTipInvokedEvent
Identifies the KeyTipInvoked routed event. This field is read-only.
public static readonly RoutedEvent KeyTipInvokedEventKeyTipOpeningEvent
Identifies the KeyTipOpening routed event. This field is read-only.
public static readonly RoutedEvent KeyTipOpeningEventKeyTipTextProperty
Identifies the KeyTipText dependency property. This field is read-only.
public static readonly DependencyProperty KeyTipTextProperty