ImportXfdf Method

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Sub ImportXfdf( _
   ByVal options As XfdfOptions, _
   ByVal xfdf() As Byte _
)

'Usage
 
Dim instance As Document
Dim options As XfdfOptions
Dim xfdf() As Byte
 
instance.ImportXfdf(options, xfdf)

public void ImportXfdf( 
   XfdfOptions options,
   byte[] xfdf
)

public: void ImportXfdf( 
   XfdfOptions* options,
   byte[]* xfdf
)

public:
void ImportXfdf( 
   XfdfOptions^ options,
   array<byte>^ xfdf
)

Parameters

options: XfdfOptions which contains information to configure the import operation.
xfdf: A byte array which contains the source XFDF data to import.

Exception	Description
System.NullReferenceException	Thrown when there is an attempt to dereference a null object reference.
System.ArgumentException	Thrown if XfdfOptions.WhichPage equals AllPages and XfdfOptions.WhichAnnotation does not equal AllAnnotations.
OperationStoppedException	Thrown if the method was stopped before it completed.
PdfXpressLibraryException	Thrown for various conditions including: The password used to open the PDF Document does not grant required privledges.
PdfXpressNotIntializedException	Thrown if invoked before PDF Xpress is initialized.
PdfXpressLicensingException	Thrown if this feature is unavailable for the current license edition.
PdfXpressException	Thrown when there is a PDF Xpress exception.

Any PDF Annotation that cannot be represented as XFDF, or corresponds to an unsupported XFDF element, is ignored.

The parameter whichPage value governs which page participates in the import operation. If equal to AllPages, then all pages in the PDF Document are eligible.

The parameter whichAnnotation value governs which PDF Annotation participates in the import operation. If equal to AllAnnotations, then all PDF Annotations on a page are eligible.

The parameter whichEncodingName value is ignored.

The parameter canCreateAnnotations value permits PDF Annotation creation. If true, then supported annotations described in the XFDF text data that are missing from the PDF Document will be added. If false, then supported annotations described in the XFDF text data that are missing from the PDF Document will be ignored.

The parameter canModifyAnnotations value permits PDF Annotation modification. If true, then existing PDF Annotations can be updated with values described in the XFDF text data for supported annotations. If false, then existing PDF Annotations will not be updated with values described in the XFDF text data for supported annotations.

The parameter canDeleteAnnotations value permits PDF Annotation deletion. Only PDF Annotation types corresponding to supported XFDF annotations are eligible; all other PDF Annotation types are ignored. If true, then existing PDF Annotations missing from the XFDF text data can be removed. If false, then existing PDF Annotations missing from the XFDF text data will not be removed.

The following XFDF 2.0 Draft annotations are supported -

caret
circle
freetext
highlight
ink
line
polygon
polyline
square
squiggly
strikeout
text
line
underline

The following XFDF 2.0 Draft annotations are not supported -

fileattachment
sound
stamp

Reference

Document Class
Document Members
Initialize Method
Initialize(String,String) Method
Licensing Property