BringIntoViewOptions Class

Definition

Namespace:

Windows.UI.Xaml

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

public ref class BringIntoViewOptions sealed

/// [Windows.Foundation.Metadata.Activatable(262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BringIntoViewOptions final

[Windows.Foundation.Metadata.Activatable(262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BringIntoViewOptions

Public NotInheritable Class BringIntoViewOptions

Inheritance

Object Platform::Object IInspectable BringIntoViewOptions

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

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()

Initializes a new instance of the BringIntoViewOptions class.

Properties

AnimationDesired	Gets or sets a value that indicates whether to use animation when the element is brought into view.
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	Gets or sets the horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.
TargetRect	Gets or sets the area of an element to bring into view.
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	Gets or sets the vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.