AnnotationService Class

 

Provides core services of the Microsoft Annotations Framework to manage and display user annotations.

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

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Annotations.AnnotationService

public sealed class AnnotationService : DispatcherObject

NameDescription
System_CAPS_pubmethodAnnotationService(DocumentViewerBase)

Initializes a new instance of the AnnotationService class for use with a specified DocumentViewer or FlowDocumentPageViewer control.

System_CAPS_pubmethodAnnotationService(FlowDocumentReader)

Initializes a new instance of the AnnotationService class for use with a specified FlowDocumentReader control.

System_CAPS_pubmethodAnnotationService(FlowDocumentScrollViewer)

Initializes a new instance of the AnnotationService class for use with a specified FlowDocumentScrollViewer control.

NameDescription
System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyIsEnabled

Gets a value that indicates whether the AnnotationService is enabled.

System_CAPS_pubpropertyStore

Gets the AnnotationStore used by this AnnotationService.

NameDescription
System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodDisable()

Disables annotations processing and hides all visible annotations.

System_CAPS_pubmethodEnable(AnnotationStore)

Enables the AnnotationService for use with a given AnnotationStore and displays all visible annotations.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetService(DocumentViewerBase)

Returns the AnnotationService instance associated with a specified document viewing control.

System_CAPS_pubmethodSystem_CAPS_staticGetService(FlowDocumentReader)

Returns the AnnotationService associated with a specified FlowDocumentReader.

System_CAPS_pubmethodSystem_CAPS_staticGetService(FlowDocumentScrollViewer)

Returns the AnnotationService associated with a specified FlowDocumentScrollViewer.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticClearHighlightsCommand

Represents the command to clear highlight annotations from the current selection.

System_CAPS_pubfieldSystem_CAPS_staticCreateHighlightCommand

Represents the command to create a highlight annotation on the current selection.

System_CAPS_pubfieldSystem_CAPS_staticCreateInkStickyNoteCommand

Represents the command to create an ink-note annotation on the current selection.

System_CAPS_pubfieldSystem_CAPS_staticCreateTextStickyNoteCommand

Represents the command to create a text-note annotation on the current selection.

System_CAPS_pubfieldSystem_CAPS_staticDeleteAnnotationsCommand

Represents the command to delete all ink-note, text-note, and highlight annotations in the current selection.

System_CAPS_pubfieldSystem_CAPS_staticDeleteStickyNotesCommand

Represents the command to delete all ink-note and text-note annotations in the current selection.

The following example shows how to create and start an AnnotationService.

// ------------------------ StartAnnotations --------------------------
/// <summary>
///   Enables annotations and displays all that are viewable.</summary>
private void StartAnnotations()
{
    // If there is no AnnotationService yet, create one.
    if (_annotService == null)
        // docViewer is a document viewing control named in Window1.xaml.
        _annotService = new AnnotationService(docViewer);

    // If the AnnotationService is currently enabled, disable it.
    if (_annotService.IsEnabled == true)
        _annotService.Disable();

    // Open a stream to the file for storing annotations.
    _annotStream = new FileStream(
        _annotStorePath, FileMode.OpenOrCreate, FileAccess.ReadWrite);

    // Create an AnnotationStore using the file stream.
    _annotStore = new XmlStreamStore(_annotStream);

    // Enable the AnnotationService using the new store.
    _annotService.Enable(_annotStore);
}// end:StartAnnotations()

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: