Back to Devexpress

PdfViewerControl.AnnotationChanging Event

wpf-devexpress-dot-xpf-dot-pdfviewer-dot-pdfviewercontrol-2cfa3920.md

latest5.1 KB
Original Source

PdfViewerControl.AnnotationChanging Event

Fires before an annotation is changed.

Namespace : DevExpress.Xpf.PdfViewer

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

NuGet Package : DevExpress.Wpf.PdfViewer

Declaration

csharp
public event PdfAnnotationChangingEventHandler AnnotationChanging
vb
Public Event AnnotationChanging As PdfAnnotationChangingEventHandler

Event Data

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

PropertyDescription
CancelGets or sets whether the event should be canceled.
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.
NewAnnotationReturns an annotation’s new property values.
OldAnnotationReturns an annotation’s previous property values.
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 code sample below prohibits changing annotations of a specific author:

xaml
<dxpdf:PdfViewerControl x:Name="pdfViewer" 
                        AnnotationChanging="pdfViewer_AnnotationChanging">
csharp
private void pdfViewer_AnnotationChanging(object sender, PdfAnnotationChangingEventArgs e)
{
    if (e.OldAnnotation.Author == "Cardle Anita L") { e.Cancel = true; }
}
vb
Private Sub pdfViewer_AnnotationChanging(ByVal sender As Object, ByVal e As PdfAnnotationChangingEventArgs)
  If e.OldAnnotation.Author = "Cardle Anita L" Then
    e.Cancel = True
  End If
End Sub

See Also

PdfViewerControl Class

PdfViewerControl Members

DevExpress.Xpf.PdfViewer Namespace