UIElement.StartBringIntoView Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
| StartBringIntoView() |
Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within. |
| StartBringIntoView(BringIntoViewOptions) |
Initiates a request to the XAML framework to bring the element into view using the specified options. |
Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.
public:
virtual void StartBringIntoView() = StartBringIntoView;/// [Windows.Foundation.Metadata.Overload("StartBringIntoView")]
void StartBringIntoView();[Windows.Foundation.Metadata.Overload("StartBringIntoView")]
public void StartBringIntoView();function startBringIntoView()Public Sub StartBringIntoView ()- Attributes
Windows requirements
| Device family |
Windows 10 Creators Update (introduced in 10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v4.0)
|
Remarks
The request is fulfilled asynchronously as the framework initiates changes to the view of ScrollViewers that contain the element. The HorizontalOffset and VerticalOffset of those ScrollViewers may not be updated immediately upon returning from the call. However, in the process of servicing the request a ScrollViewer's ViewChanging and ViewChanged events will fire. If you use the signature that does not specify any options, then the entire element size (its RenderSize) will be made visible and any changes to the viewports will be animated. The StartBringIntoView method does not transmit any information about success or failure. Reasons for failure can include the element settings, such as Visibility being some value other than Visible.
See also
Applies to
WinRT Build 26100 and other versions
| Product | Versions |
|---|---|
| WinRT | Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100 |
Initiates a request to the XAML framework to bring the element into view using the specified options.
public:
virtual void StartBringIntoView(BringIntoViewOptions ^ options) = StartBringIntoView;/// [Windows.Foundation.Metadata.Overload("StartBringIntoViewWithOptions")]
void StartBringIntoView(BringIntoViewOptions const& options);[Windows.Foundation.Metadata.Overload("StartBringIntoViewWithOptions")]
public void StartBringIntoView(BringIntoViewOptions options);function startBringIntoView(options)Public Sub StartBringIntoView (options As BringIntoViewOptions)Parameters
- options
- BringIntoViewOptions
An instance of BringIntoViewOptions.
- Attributes
Windows requirements
| Device family |
Windows 10 Creators Update (introduced in 10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v4.0)
|
Applies to
WinRT Build 26100 and other versions
| Product | Versions |
|---|---|
| WinRT | Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100 |