FrameworkElement.BringIntoView Method (System.Windows)

Switch View :
ScriptFree
.NET Framework Class Library
FrameworkElement.BringIntoView Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Attempts to bring this element into view, within any scrollable regions it is contained within.

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)
Syntax

Visual Basic
Public Sub BringIntoView
C#
public void BringIntoView()
Visual C++
public:
void BringIntoView()
F#
member BringIntoView : unit -> unit 

Remarks

By calling this method, you raise a RequestBringIntoView event that originates from the current element. This event is raised so that it can be handled by a ScrollViewer, or a derived or similar class. The expected behavior is that the event is handled by the parent element, marked handled in the event data, and the source of the event is brought into view through the logic embedded in the ScrollViewer control. Neither the RequestBringIntoView event nor the BringIntoView method transmit any information about success or failure, other than that the event is typically marked handled on success. Reasons for failure can include the element settings, such as Visibility being some value other than Visible.

If you use the signature that does not specify a targetRectangle, then the entire element size (its RenderSize) will be made visible.

By calling this method, you potentially will call MakeVisible on any parent scrollable area that contains the element. If this element is not contained in a scrollable area, the RequestBringIntoView event is still raised, but there will be no effect because there are no event listeners.

Examples

The following example implements a handler for an application navigation event that responds whenever the uniform resource identifier (URI) being navigated to includes a fragment. The fragment is named in the URI following the hash sign (#), and the implemented behavior causes the element to scroll into view within the frame. BringIntoView and RequestBringIntoView request that scrolling behavior in the example.

Visual Basic

    Private Sub browserFrame_FragmentNavigation(ByVal sender As Object, ByVal e As FragmentNavigationEventArgs)
        Dim element As FrameworkElement = TryCast(LogicalTreeHelper.FindLogicalNode(DirectCast(DirectCast(e.Navigator, ContentControl).Content, DependencyObject), e.Fragment), FrameworkElement)
        If (element Is Nothing) Then
            ' Redirect to error page
            ' Note - You can't navigate from within a FragmentNavigation event handler,
            '        hence creation of an async dispatcher work item
            Dim callback As New DispatcherOperationCallback(AddressOf Me.FragmentNotFoundNavigationRedirect)
            Me.Dispatcher.BeginInvoke(DispatcherPriority.Normal, callback, Nothing)
        End If
        e.Handled = True
    End Sub

    Function FragmentNotFoundNavigationRedirect(ByVal unused As Object) As Object
        Me.browserFrame.Navigate(New Uri("FragmentNotFoundPage.xaml", UriKind.Relative))
        Return Nothing
    End Function



C#

void browserFrame_FragmentNavigation(object sender, FragmentNavigationEventArgs e)
{
    object content = ((ContentControl)e.Navigator).Content;
    FrameworkElement fragmentElement = LogicalTreeHelper.FindLogicalNode((DependencyObject)content, e.Fragment) as FrameworkElement;
    if (fragmentElement == null)
    {
        // Redirect to error page
        // Note - You can't navigate from within a FragmentNavigation event handler,
        //        hence creation of an async dispatcher work item
        this.Dispatcher.BeginInvoke(
            DispatcherPriority.Send,
            (DispatcherOperationCallback) delegate(object unused) 
            {
                this.browserFrame.Navigate(new Uri("FragmentNotFoundPage.xaml", UriKind.Relative));
                return null;
            },
            null);
        e.Handled = true;
    }
}


Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

See Also

Reference