ScrollViewer.ReduceViewportForCoreInputViewOcclusions Property

Definition

Gets or sets a value that indicates whether the ScrollViewer should try to adjust its content to keep it visible when a docked CoreInputView occludes part of it.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.ScrollViewer.ReduceViewportForCoreInputViewOcclusions.

public:
 property bool ReduceViewportForCoreInputViewOcclusions { bool get(); void set(bool value); };
bool ReduceViewportForCoreInputViewOcclusions();

void ReduceViewportForCoreInputViewOcclusions(bool value);
public bool ReduceViewportForCoreInputViewOcclusions { get; set; }
var boolean = scrollViewer.reduceViewportForCoreInputViewOcclusions;
scrollViewer.reduceViewportForCoreInputViewOcclusions = boolean;
Public Property ReduceViewportForCoreInputViewOcclusions As Boolean

Property Value

Boolean

true if the ScrollViewer should try to adjust its content; otherwise, false. The default is false.

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 this feature is enabled and a docked CoreInputView covers part of the ScrollViewer control, the ScrollViewer reduces the space available to its content according to the size and location of the CoreInputView. Then the ScrollViewer, as in any other case where the content is constrained, allows the user to pan/scroll the content. Also, any time a text edit control gets focus, it automatically brings itself into view, so the user isn't required to manually pan.

This property defaults to false, and it's typically not necessary for you to set it in your app. XAML maintains a ScrollViewer internally with this feature enabled, and your window content is displayed in this ScrollViewer. That is, Window.Current.Content is automatically parented to a ScrollViewer that has this feature enabled.

Applies to