SignDoc SDK (.NET without exceptions)  5.0.0
SignDocChange Class Reference

A single change made to a PDF document after a signature. More...

Public Member Functions

 ~SignDocChange ()
 Destructor. More...
 
 !SignDocChange ()
 Finalizer. More...
 
ChangeType getType ()
 Get the type of the change. More...
 
string getName ()
 Get the name of the changed field, annotation, or attachment. More...
 
int getPage ()
 Get the page number of a change made after this signature. More...
 
FieldType getFieldType ()
 Get the type of the changed field. More...
 
string getAnnotationType ()
 Get the type of the changed annotation. More...
 

Detailed Description

A single change made to a PDF document after a signature.

See also
SignDocSignature.getChange()

Constructor & Destructor Documentation

Destructor.

Finalizer.

Member Function Documentation

string getAnnotationType ( )

Get the type of the changed annotation.

Returns
The annotation type as string, empty if not known (for instance, if the change does not involve an annotation).
FieldType getFieldType ( )

Get the type of the changed field.

Returns
The field type, FieldType.Unknown if not known (for instance, if the change does not involve a field).
string getName ( )

Get the name of the changed field, annotation, or attachment.

For change types ChangeType.FieldAdded, ChangeType.FieldRemoved, ChangeType.FieldModified, ChangeType.AnnotationAdded, ChangeType.AnnotationRemoved, ChangeType.AnnotationModified, ChangeType.AttachmentAdded, ChangeType.AttachmentRemoved, and ChangeType.AttachmentModified, the name of the changed field, annotation, or attachment can be retrieved by calling this function.

Returns
The name of the field, annotation, or attachment; empty if not available. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
getType()
int getPage ( )

Get the page number of a change made after this signature.

Returns
The one-based page number or 0 if not available. For removed items, the page number is in the document "as signed" by the signature described by the SignDocSignature object, for modified and added items, the page number is in the document "as signed" by the next signature (or the current version of the document if the SignDocSignature object describes the last signature).
ChangeType getType ( )

Get the type of the change.

Returns
The type of the change.

The documentation for this class was generated from the following file: