KeyTipService Class
A service for managing key tips.
public class KeyTipService
- Inheritance:
- object object
Constructors
KeyTipService()
Initializes an instance of the class.
public KeyTipService()
Properties
AllowedKeyTipModeShortcuts
A KeyTipModeShortcuts value indicating the allowed shortcuts.
public static KeyTipModeShortcuts AllowedKeyTipModeShortcuts { get; set; }
Property Value
- KeyTipModeShortcuts:
The default value is All.
Methods
AddKeyTipInvokedHandler(Interactive, EventHandler<KeyTipInvokedEventArgs>)
Adds a handler for the KeyTipInvoked
event to the specified object.
public static void AddKeyTipInvokedHandler(Interactive obj, EventHandler<KeyTipInvokedEventArgs> handler)
Parameter | Type | Description |
---|---|---|
obj | Interactive | The object requiring the handler. |
handler | EventHandler<KeyTipInvokedEventArgs> | The event handler. |
AddKeyTipOpeningHandler(Interactive, EventHandler<KeyTipOpeningEventArgs>)
Adds a handler for the KeyTipOpening
event to the specified object.
public static void AddKeyTipOpeningHandler(Interactive obj, EventHandler<KeyTipOpeningEventArgs> handler)
Parameter | Type | Description |
---|---|---|
obj | Interactive | The object requiring the handler. |
handler | EventHandler<KeyTipOpeningEventArgs> | The event handler. |
GetIsKeyTipBoundary(AvaloniaObject)
Gets the value of the IsKeyTipBoundary
attached property for the specified object.
public static bool GetIsKeyTipBoundary(AvaloniaObject obj)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object from which the property value is read. |
Returns
- bool:
The object's value.
GetIsRootKeyTipScope(AvaloniaObject)
Gets the value of the IsRootKeyTipScope
attached property for the specified object.
public static bool GetIsRootKeyTipScope(AvaloniaObject obj)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object from which the property value is read. |
Returns
- bool:
The object's value.
GetKeyTipText(AvaloniaObject)
Gets the value of the KeyTipText
attached property for the specified object.
public static string? GetKeyTipText(AvaloniaObject obj)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object from which the property value is read. |
Returns
- string:
The object's value.
RemoveKeyTipInvokedHandler(Interactive, EventHandler<KeyTipInvokedEventArgs>)
Removes a handler for the KeyTipInvoked
event from the specified object.
public static void RemoveKeyTipInvokedHandler(Interactive obj, EventHandler<KeyTipInvokedEventArgs> handler)
Parameter | Type | Description |
---|---|---|
obj | Interactive | The object with the handler. |
handler | EventHandler<KeyTipInvokedEventArgs> | The event handler. |
RemoveKeyTipOpeningHandler(Interactive, EventHandler<KeyTipOpeningEventArgs>)
Removes a handler for the KeyTipOpening
event from the specified object.
public static void RemoveKeyTipOpeningHandler(Interactive obj, EventHandler<KeyTipOpeningEventArgs> handler)
Parameter | Type | Description |
---|---|---|
obj | Interactive | The object with the handler. |
handler | EventHandler<KeyTipOpeningEventArgs> | The event handler. |
SetIsKeyTipBoundary(AvaloniaObject, bool)
Sets the value of the IsKeyTipBoundary
attached property to the specified object.
public static void SetIsKeyTipBoundary(AvaloniaObject obj, bool value)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object to which the attached property is written. |
value | bool | The value to set. |
SetIsRootKeyTipScope(AvaloniaObject, bool)
Sets the value of the IsRootKeyTipScope
attached property to the specified object.
public static void SetIsRootKeyTipScope(AvaloniaObject obj, bool value)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object to which the attached property is written. |
value | bool | The value to set. |
SetKeyTipText(AvaloniaObject, string?)
Sets the value of the KeyTipText
attached property to the specified object.
public static void SetKeyTipText(AvaloniaObject obj, string? value)
Parameter | Type | Description |
---|---|---|
obj | AvaloniaObject | The object to which the attached property is written. |
value | string | The value to set. |
Fields
AlternateRootKeyTipScopeContainerProperty
Defines the AlternateRootKeyTipScopeContainer
attached property.
public static readonly AttachedProperty<Control?> AlternateRootKeyTipScopeContainerProperty
IsKeyTipBoundaryProperty
Defines the IsKeyTipBoundary
attached property.
public static readonly AttachedProperty<bool> IsKeyTipBoundaryProperty
IsRootKeyTipScopeProperty
Defines the IsRootKeyTipScope
attached property.
public static readonly AttachedProperty<bool> IsRootKeyTipScopeProperty
KeyTipInvokedEvent
Defines the KeyTipInvoked
routed event.
public static readonly RoutedEvent<KeyTipInvokedEventArgs> KeyTipInvokedEvent
KeyTipOpeningEvent
Defines the KeyTipOpening
routed event.
public static readonly RoutedEvent<KeyTipOpeningEventArgs> KeyTipOpeningEvent
KeyTipTextProperty
Defines the KeyTipText
attached property.
public static readonly AttachedProperty<string?> KeyTipTextProperty
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()