BringIntoViewOptions BringIntoViewOptions BringIntoViewOptions BringIntoViewOptions Class

Definition

Represents the options that can be applied when an element is brought into view.

public : sealed class BringIntoViewOptions
struct winrt::Windows::UI::Xaml::BringIntoViewOptions
public sealed class BringIntoViewOptions
Public NotInheritable Class BringIntoViewOptions
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

For more info, see the UIElement.StartBringIntoView method.

Version history

Windows version SDK version Value added
1803 17134 HorizontalAlignmentRatio
1803 17134 HorizontalOffset
1803 17134 VerticalAlignmentRatio
1803 17134 VerticalOffset

Constructors

BringIntoViewOptions() BringIntoViewOptions() BringIntoViewOptions() BringIntoViewOptions()

Initializes a new instance of the BringIntoViewOptions class.

Properties

AnimationDesired AnimationDesired AnimationDesired AnimationDesired

Gets or sets a value that indicates whether to use animation when the element is brought into view.

HorizontalAlignmentRatio HorizontalAlignmentRatio HorizontalAlignmentRatio HorizontalAlignmentRatio

Controls the positioning of the vertical axis of the TargetRect with respect to the vertical axis of the viewport. The value is clamped from 0.0f to 1.0f with 0.0f representing the left vertical edge and 1.0f representing the right vertical edge. By default this is set to 0.0f.

HorizontalOffset HorizontalOffset HorizontalOffset HorizontalOffset

Gets or sets the horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.

TargetRect TargetRect TargetRect TargetRect

Gets or sets the area of an element to bring into view.

VerticalAlignmentRatio VerticalAlignmentRatio VerticalAlignmentRatio VerticalAlignmentRatio

Controls the positioning of the horizontal axis of the TargetRect with respect to the horizontal axis of the viewport. The value is clamped from 0.0f to 1.0f with 0.0f representing the top horizontal edge and 1.0f representing the bottom horizontal edge. By default this is set to 0.0f.

VerticalOffset VerticalOffset VerticalOffset VerticalOffset

Gets or sets the vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.