AnnotationService.Enable(AnnotationStore) Method

Definition

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

public:
 void Enable(System::Windows::Annotations::Storage::AnnotationStore ^ annotationStore);
public void Enable (System.Windows.Annotations.Storage.AnnotationStore annotationStore);
member this.Enable : System.Windows.Annotations.Storage.AnnotationStore -> unit
Public Sub Enable (annotationStore As AnnotationStore)

Parameters

annotationStore
AnnotationStore

The annotation store to use for reading, writing, and displaying annotations.

Exceptions

annotationStore is null.

Examples

The following example shows how to use the Enable method when you 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()
' ------------------------ StartAnnotations --------------------------
''' <summary>
'''   Enables annotations and displays all that are viewable.</summary>
Private Sub StartAnnotations()
    ' If there is no AnnotationService yet, create one.
    If _annotService Is Nothing Then
        ' docViewer is a document viewing control named in Window1.xaml.
        _annotService = New AnnotationService(docViewer)
    End If

    ' If the AnnotationService is currently enabled, disable it.
    If _annotService.IsEnabled = True Then
        _annotService.Disable()
    End If

    ' 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 Sub

Remarks

When Enable is called all annotations in the viewer control window are displayed. (The viewer control associated with the annotation service is specified in the parameter to the AnnotationService constructor.)

Applies to

See also