AnnotationHelper.GetAnchorInfo Method

Returns an IAnchorInfo object that provides anchoring information, such as the anchor location, about the specified annotation.

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

'Declaration
Public Shared Function GetAnchorInfo ( _
	service As AnnotationService, _
	annotation As Annotation _
) As IAnchorInfo
'Usage
Dim service As AnnotationService 
Dim annotation As Annotation 
Dim returnValue As IAnchorInfo 

returnValue = AnnotationHelper.GetAnchorInfo(service, _
	annotation)
You cannot use methods in XAML.

Parameters

service
Type: System.Windows.Annotations.AnnotationService

The annotation service to use for this operation.

annotation
Type: System.Windows.Annotations.Annotation

The annotation to get anchoring information for.

Return Value

Type: System.Windows.Annotations.IAnchorInfo
An IAnchorInfo object that provides anchoring information about the specified annotation, or Nothing if it cannot be resolved.

GetAnchorInfo is introduced in the Microsoft .NET Framework version 3.5. For more information, see .NET Framework 3.5 Architecture.

Consider a simple document reader application that has a comments pane. The comments pane might be a list box that displays the text from a list of annotations that are anchored to a document. If the user selects an item in the list box, then the application brings into view the paragraph in the document that the corresponding annotation object is anchored to.

The following example demonstrates how to implement the event handler of such a list box that serves as the comments pane.

void annotationsListBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
{

    Annotation comment = (sender as ListBox).SelectedItem as Annotation;
    if (comment != null)
    {
        // IAnchorInfo info; 
        // service is an AnnotationService object 
        // comment is an Annotation object
        info = AnnotationHelper.GetAnchorInfo(this.service, comment);
        TextAnchor resolvedAnchor = info.ResolvedAnchor as TextAnchor;
        TextPointer textPointer = (TextPointer)resolvedAnchor.BoundingStart;
        textPointer.Paragraph.BringIntoView();
    }
}

For the complete example, see Annotated Document Viewer with Comments Pane Sample.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft