VisualExtensions Class

Definition

Namespace:Avalonia.VisualTree

Assembly:Avalonia.Base

Package:Avalonia

Source:VisualExtensions.cs

Provides extension methods for working with the visual tree.

public class VisualExtensions

Inheritance: object -> VisualExtensions

Methods

Name	Description
CalculateDistanceFromAncestor	Calculates the distance from a visual's ancestor.
CalculateDistanceFromRoot	Calculates the distance from a visual's root.
FindAncestorOfType (2 overloads)	No summary available.
FindCommonVisualAncestor	Tries to get the first common ancestor of two visuals.
FindDescendantOfType (2 overloads)	No summary available.
GetLayoutManager	Gets the layout manager for the visual's presentation source, or null if the visual is not attached to a visual root.
GetPlatformSettings	Attempts to obtain platform settings from the visual's root. This will return null if the visual is not attached to a visual root.
GetPresentationSource	No summary available.
GetSelfAndVisualAncestors	Enumerates an Avalonia.Visual and its ancestors in the visual tree.
GetSelfAndVisualDescendants	Enumerates an Avalonia.Visual and its descendants in the visual tree.
GetTransformedBounds	No summary available.
GetVisualAncestors	Enumerates the ancestors of an Avalonia.Visual in the visual tree.
GetVisualAt (2 overloads)	Gets the first visual in the visual tree whose bounds contain a point.
GetVisualChildren	Enumerates the children of an Avalonia.Visual in the visual tree.
GetVisualDescendants	Enumerates the descendants of an Avalonia.Visual in the visual tree.
GetVisualParent	Gets the visual parent of an Avalonia.Visual.
GetVisualsAt (2 overloads)	Enumerates the visible visuals in the visual tree whose bounds contain a point.
IsAttachedToVisualTree	Returns a value indicating whether this control is attached to a visual root.
IsVisualAncestorOf	Tests whether an Avalonia.Visual is an ancestor of another visual.
SortByZIndex	No summary available.

CalculateDistanceFromAncestor Method

Calculates the distance from a visual's ancestor.

public int CalculateDistanceFromAncestor(Avalonia.Visual visual, Avalonia.Visual ancestor)

Parameters

visual Avalonia.Visual

The visual.

ancestor Avalonia.Visual

The ancestor visual.

Returns

int

The number of steps from the visual to the ancestor or -1 if visual is not a descendent of ancestor.

CalculateDistanceFromRoot Method

Calculates the distance from a visual's root.

public int CalculateDistanceFromRoot(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

int

The number of steps from the visual to the root.

FindAncestorOfType overloads

FindAncestorOfType Method

public T FindAncestorOfType<T>(Avalonia.Visual visual, bool includeSelf)

Parameters

visual Avalonia.Visual

includeSelf bool

Type Parameters

T

Returns

T

FindAncestorOfType Method

public T FindAncestorOfType<T>(Avalonia.Visual visual, bool includeSelf, Predicate<T> predicate)

Parameters

visual Avalonia.Visual

includeSelf bool

predicate Predicate<T>

Type Parameters

T

Returns

T

FindCommonVisualAncestor Method

Tries to get the first common ancestor of two visuals.

public Avalonia.Visual FindCommonVisualAncestor(Avalonia.Visual visual, Avalonia.Visual target)

Parameters

visual Avalonia.Visual

The first visual.

target Avalonia.Visual

The second visual.

Returns

Avalonia.Visual

The common ancestor, or null if not found.

FindDescendantOfType overloads

FindDescendantOfType Method

public T FindDescendantOfType<T>(Avalonia.Visual visual, bool includeSelf)

Parameters

visual Avalonia.Visual

includeSelf bool

Type Parameters

T

Returns

T

FindDescendantOfType Method

public T FindDescendantOfType<T>(Avalonia.Visual visual, bool includeSelf, Predicate<T> predicate)

Parameters

visual Avalonia.Visual

includeSelf bool

predicate Predicate<T>

Type Parameters

T

Returns

T

GetLayoutManager Method

Gets the layout manager for the visual's presentation source, or null if the visual is not attached to a visual root.

public Avalonia.Layout.ILayoutManager GetLayoutManager(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

Avalonia.Layout.ILayoutManager

GetPlatformSettings Method

Attempts to obtain platform settings from the visual's root. This will return null if the visual is not attached to a visual root.

public Avalonia.Platform.IPlatformSettings GetPlatformSettings(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

Avalonia.Platform.IPlatformSettings

GetPresentationSource Method

public Avalonia.Rendering.IPresentationSource GetPresentationSource(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

Avalonia.Rendering.IPresentationSource

GetSelfAndVisualAncestors Method

Enumerates an Avalonia.Visual and its ancestors in the visual tree.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetSelfAndVisualAncestors(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visual and its ancestors.

GetSelfAndVisualDescendants Method

Enumerates an Avalonia.Visual and its descendants in the visual tree.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetSelfAndVisualDescendants(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visual and its ancestors.

GetTransformedBounds Method

public Nullable<Avalonia.VisualTree.TransformedBounds> GetTransformedBounds(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

Nullable<Avalonia.VisualTree.TransformedBounds>

GetVisualAncestors Method

Enumerates the ancestors of an Avalonia.Visual in the visual tree.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetVisualAncestors(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visual's ancestors.

GetVisualAt overloads

GetVisualAt Method

Gets the first visual in the visual tree whose bounds contain a point.

public Avalonia.Visual GetVisualAt(Avalonia.Visual visual, Avalonia.Point p)

Parameters

visual Avalonia.Visual

The root visual to test.

p Avalonia.Point

The point.

Returns

Avalonia.Visual

The visual at the requested point.

GetVisualAt Method

public Avalonia.Visual GetVisualAt(Avalonia.Visual visual, Avalonia.Point p, Func<Avalonia.Visual, bool> filter)

Parameters

visual Avalonia.Visual

p Avalonia.Point

filter Func<Avalonia.Visual, bool>

Returns

Avalonia.Visual

GetVisualChildren Method

Enumerates the children of an Avalonia.Visual in the visual tree.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetVisualChildren(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visual children.

GetVisualDescendants Method

Enumerates the descendants of an Avalonia.Visual in the visual tree.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetVisualDescendants(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visual's ancestors.

GetVisualParent Method

Gets the visual parent of an Avalonia.Visual.

public T GetVisualParent<T>(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual.

Returns

Avalonia.Visual

The parent, or null if the visual is unparented.

GetVisualsAt overloads

GetVisualsAt Method

Enumerates the visible visuals in the visual tree whose bounds contain a point.

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetVisualsAt(Avalonia.Visual visual, Avalonia.Point p)

Parameters

visual Avalonia.Visual

The root visual to test.

p Avalonia.Point

The point.

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

The visuals at the requested point.

GetVisualsAt Method

public System.Collections.Generic.IEnumerable<Avalonia.Visual> GetVisualsAt(Avalonia.Visual visual, Avalonia.Point p, Func<Avalonia.Visual, bool> filter)

Parameters

visual Avalonia.Visual

p Avalonia.Point

filter Func<Avalonia.Visual, bool>

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>

IsAttachedToVisualTree Method

Returns a value indicating whether this control is attached to a visual root.

public bool IsAttachedToVisualTree(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

bool

IsVisualAncestorOf Method

Tests whether an Avalonia.Visual is an ancestor of another visual.

public bool IsVisualAncestorOf(Avalonia.Visual visual, Avalonia.Visual target)

Parameters

visual Avalonia.Visual

The visual.

target Avalonia.Visual

The potential descendant.

Returns

bool

True if visual is an ancestor of target; otherwise false.

SortByZIndex Method

public System.Collections.Generic.IEnumerable<Avalonia.Visual> SortByZIndex(System.Collections.Generic.IEnumerable<Avalonia.Visual> elements)

Parameters

elements System.Collections.Generic.IEnumerable<Avalonia.Visual>

Returns

System.Collections.Generic.IEnumerable<Avalonia.Visual>