Back to Devexpress

PdfViewerControl.AnnotationCreated Event

wpf-devexpress-dot-xpf-dot-pdfviewer-dot-pdfviewercontrol-74466cb7.md

latest5.4 KB
Original Source

PdfViewerControl.AnnotationCreated Event

Occurs after an annotation is created.

Namespace : DevExpress.Xpf.PdfViewer

Assembly : DevExpress.Xpf.PdfViewer.v25.2.dll

NuGet Package : DevExpress.Wpf.PdfViewer

Declaration

csharp
public event PdfAnnotationCreatedEventHandler AnnotationCreated
vb
Public Event AnnotationCreated As PdfAnnotationCreatedEventHandler

Event Data

The AnnotationCreated event's data class is PdfAnnotationCreatedEventArgs. The following properties provide information specific to this event:

PropertyDescription
AnnotationRetrieves the created annotation.
HandledGets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEventGets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
SourceGets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

MethodDescription
InvokeEventHandler(Delegate, Object)When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The PdfAnnotationCreatedEventArgs.Annotation property gets the created annotation. Use the DevExpress.Pdf.PdfViewerAnnotationExtensions class methods to obtain a specific type of annotation.

The code sample below shows how to check whether the specific author created an annotation:

csharp
private void PdfViewer_AnnotationCreated(object sender,
 PdfAnnotationCreatedEventArgs e)
{
    if (e.Annotation.Type == PdfAnnotationType.TextMarkup
     || e.Annotation.Type == PdfAnnotationType.Text)
    {
        IPdfViewerMarkupAnnotation annotation =
         e.Annotation.AsMarkupAnnotation();
        if (annotation.Author == "Brian Zetc")
            MessageBox.Show("The main editor added a new annotation");
    }
}
vb
Private Sub PdfViewer_AnnotationCreated(ByVal sender As Object, ByVal e As PdfAnnotationCreatedEventArgs)
  If e.Annotation.Type = PdfAnnotationType.TextMarkup OrElse e.Annotation.Type = PdfAnnotationType.Text Then
    Dim annotation As IPdfViewerMarkupAnnotation = e.Annotation.AsMarkupAnnotation()
    If annotation.Author = "Brian Zetc" Then
      MessageBox.Show("The main editor added a new annotation")
    End If
  End If
End Sub

See Also

PdfViewerControl Class

PdfViewerControl Members

DevExpress.Xpf.PdfViewer Namespace