ScrollViewer.RegisterAnchorCandidate(UIElement) ScrollViewer.RegisterAnchorCandidate(UIElement) ScrollViewer.RegisterAnchorCandidate(UIElement) ScrollViewer.RegisterAnchorCandidate(UIElement) Method

Definition

Registers a UIElement as a potential scroll anchor.

public : void RegisterAnchorCandidate(UIElement element)
void RegisterAnchorCandidate(UIElement element) const;
public void RegisterAnchorCandidate(UIElement element)
Public Sub RegisterAnchorCandidate(element As UIElement)

Parameters

element
UIElement UIElement

A UIElement within the subtree of the ScrollViewer.

Additional features and requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Remarks

When an element has CanBeScrollAnchor set to true the framework locates the first IScrollAnchorProvider in that element's chain of ancestors and automatically calls its RegisterAnchorCandidate method. This occurs both when the property is set on an existing element or an element is added to the live tree with the property already set.

Similarly, when the property is set to false (or an element is removed from the visual tree with the property set to true), the framework calls the UnregisterAnchorCandidate on the first IScrollAnchorProvider.

See also

  • T:Windows.UI.Xaml.Controls.IScrollAnchorProvider * M:Windows.UI.Xaml.Controls.IScrollAnchorProvider.UnregisterAnchorCandidate(Windows.UI.Xaml.UIElement) * P:Windows.UI.Xaml.UIElement.CanBeScrollAnchor