BringIntoViewRequestedEventArgs Class

Definition

Namespace:
Windows.UI.Xaml
Edit

Provides data for the UIElement.BringIntoViewRequested event.

Equivalent WinUI class: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.

public ref class BringIntoViewRequestedEventArgs sealed : RoutedEventArgs
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class BringIntoViewRequestedEventArgs final : RoutedEventArgs
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class BringIntoViewRequestedEventArgs : RoutedEventArgs
Public NotInheritable Class BringIntoViewRequestedEventArgs
Inherits RoutedEventArgs
Inheritance
Object
RoutedEventArgs
BringIntoViewRequestedEventArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute WebHostHiddenAttribute

Windows 10 requirements

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

Properties

AnimationDesired

Gets or sets a value that specifies whether the scrolling should be animated.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.AnimationDesired.
Handled

Gets or sets a value that marks the routed event as handled. A true value prevents most handlers along the event route from handling the same event again.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.Handled.
HorizontalAlignmentRatio

Gets the requested horizontal alignment ratio which controls the alignment of the vertical axis of the TargetRect with respect to the vertical axis of the viewport.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.HorizontalAlignmentRatio.
HorizontalOffset

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

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.HorizontalOffset.
OriginalSource

Gets a reference to the object that raised the event. This is often a template part of a control rather than an element that was declared in your app UI.

Equivalent WinUI property: Microsoft.UI.Xaml.RoutedEventArgs.OriginalSource.

(Inherited from RoutedEventArgs)
TargetElement

Gets or sets the element that should be made visible in response to the event.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.TargetElement.
TargetRect

Gets or sets the Rect in the TargetElement’s coordinate space to bring into view.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.TargetRect.
VerticalAlignmentRatio

Gets the requested vertical alignment ratio which controls the alignment of the horizontal axis of the TargetRect with respect to the horizontal axis of the viewport.

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.VerticalAlignmentRatio.
VerticalOffset

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

Equivalent WinUI property: Microsoft.UI.Xaml.BringIntoViewRequestedEventArgs.VerticalOffset.

Applies to