In This Article

ScreenTipService Class

A service for managing screen tips.

public class ScreenTipService
Inheritance:
object object

Constructors

ScreenTipService()

Initializes an instance of the class.

public ScreenTipService()

Properties

Current

The instance of ScreenTipService for the current thread.

public static ScreenTipService Current { get; }

Property Value

ScreenTipService

Remarks

The value of this property is thread-specific and should only be accessed from the same thread that created the control which is using the service.

CurrentScreenTip

The currently displayed ScreenTip, or null if one is not displayed.

public ScreenTip? CurrentScreenTip { get; }

Property Value

ScreenTip

Methods

GetScreenTipFooter(AvaloniaObject)

Gets the value of the ScreenTipFooter attached property for the specified object.

public static object? GetScreenTipFooter(AvaloniaObject obj)
Parameter Type Description
obj AvaloniaObject

The object from which the property value is read.

Returns

object

GetScreenTipHeader(AvaloniaObject)

Gets the value of the ScreenTipHeader attached property for the specified object.

public static object? GetScreenTipHeader(AvaloniaObject obj)
Parameter Type Description
obj AvaloniaObject

The object from which the property value is read.

Returns

object

PlaceScreenTip(CustomPopupPlacement)

Adjusts the placement for a ScreenTip.

public static void PlaceScreenTip(CustomPopupPlacement placement)
Parameter Type Description
placement CustomPopupPlacement

The Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacement to update.

SetScreenTipFooter(AvaloniaObject, object?)

Sets the value of the ScreenTipFooter attached property to the specified object.

public static void SetScreenTipFooter(AvaloniaObject obj, object? value)
Parameter Type Description
obj AvaloniaObject

The object to which the attached property is written.

value object

The value to set.

SetScreenTipHeader(AvaloniaObject, object)

Sets the value of the ScreenTipHeader attached property to the specified object.

public static void SetScreenTipHeader(AvaloniaObject obj, object value)
Parameter Type Description
obj AvaloniaObject

The object to which the attached property is written.

value object

The value to set.

Events

ScreenTipOpening

Occurs before a ScreenTip is opened, allowing for customization.

public event EventHandler<CancelRoutedEventArgs>? ScreenTipOpening

Event Type

EventHandler<CancelRoutedEventArgs>

Fields

ScreenTipFooterProperty

Defines the ScreenTipFooterProperty attached property.

public static readonly AttachedProperty<object?> ScreenTipFooterProperty

ScreenTipHeaderProperty

Defines the ScreenTipHeaderProperty attached property.

public static readonly AttachedProperty<object?> ScreenTipHeaderProperty

Inherited Members

Extension Methods