KeyTipService Class
A service for managing key tips.
public class KeyTipService
- Inheritance:
- object object
Properties
AllowedKeyTipModeShortcuts
The key tip mode shortcuts that are allowed.
public static KeyTipModeShortcuts AllowedKeyTipModeShortcuts { get; set; }
Property Value
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
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
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
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
Defines the IsKeyTipBoundary property.
public static readonly DependencyProperty IsKeyTipBoundaryProperty
IsRootKeyTipScopeProperty
Defines the IsRootKeyTipScope property.
public static readonly DependencyProperty IsRootKeyTipScopeProperty
KeyTipInvokedEvent
Defines the KeyTipInvoked routed event.
public static readonly RoutedEvent KeyTipInvokedEvent
KeyTipOpeningEvent
Defines the KeyTipOpening routed event.
public static readonly RoutedEvent KeyTipOpeningEvent
KeyTipTextProperty
Defines the KeyTipText property.
public static readonly DependencyProperty KeyTipTextProperty
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()