ScrollViewer.UnregisterAnchorCandidate(UIElement) Method

Definition

Unregisters a UIElement as a potential scroll anchor.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.ScrollViewer.UnregisterAnchorCandidate.

public:
 virtual void UnregisterAnchorCandidate(UIElement ^ element) = UnregisterAnchorCandidate;
void UnregisterAnchorCandidate(UIElement const & element);
public void UnregisterAnchorCandidate(UIElement element);
function unregisterAnchorCandidate(element)
Public Sub UnregisterAnchorCandidate (element As UIElement)

Parameters

element
UIElement

A UIElement within the subtree of the ScrollViewer.

Implements

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Remarks

When an element's CanBeScrollAnchor property changes to false (or the element is removed from the visual tree), the framework locates the first IScrollAnchorProvider in that element's chain of ancestors and automatically calls its UnregisterAnchorCandidate method.

Applies to

See also