UIElement.RegisterAsScrollPort(UIElement) Method

Definition

Registers an element as representing a scrollable viewport.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.RegisterAsScrollPort.

public:
 static void RegisterAsScrollPort(UIElement ^ element);
 static void RegisterAsScrollPort(UIElement const & element);
public static void RegisterAsScrollPort(UIElement element);
function registerAsScrollPort(element)
Public Shared Sub RegisterAsScrollPort (element As UIElement)

Parameters

element
UIElement

The element to register as a scrollable viewport.

Windows 10 requirements

Device family
Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v6.0)

Remarks

This method informs the framework that the element's applied clip (either due to layout or an explicitly assigned Clip ) is acting as a viewport and should receive special consideration.

This method is intended for use by custom controls that do not use the platform's native controls to display a scrollable area. For example, a custom scrolling control could be built using InteractionTracker.

Effective Viewport

The Clip of the registered element is recognized by the framework as the bounds of a viewport, which will be used in calculating the property values for the EffectiveViewportChanged event.

System Focus Visuals

By default, the focus visual is fully rendered around the outside of the focused element taking into account all clips. When an element is only partially visible within a viewport the framework needs to disambiguate which clip in the element's ancestor chain represents the viewport. The framework uses this knowledge to correctly apply the viewport clip to the rendered focus visual.

Applies to

See also