ExportXfdf Method

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

'Declaration
 
Public Function ExportXfdf( _
   ByVal options As XfdfOptions _
) As Byte()

'Usage
 
Dim instance As Document
Dim options As XfdfOptions
Dim value() As Byte
 
value = instance.ExportXfdf(options)

public byte[] ExportXfdf( 
   XfdfOptions options
)

public: byte[]* ExportXfdf( 
   XfdfOptions* options
)

public:
array<byte>^ ExportXfdf( 
   XfdfOptions^ options
)

Parameters

options: XfdfOptions object which configures the export operation. Any PDF Annotation that cannot be represented as XFDF, or corresponds to an unsupported XFDF element, is ignored.

Return Value

Encoded XFDF text data.

Exception	Description
System.NullReferenceException	Thrown when there is an attempt to dereference a null object reference.
System.ArgumentException	Thrown if the parameter WhichPage equals XfdfOptions.AllPages and the parameter WhichAnnotation does not equal XfdfOptions.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.

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

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

The XfdfOptions.WhichEncodingName value governs the encoding of the XFDF data emitted.

The XfdfOptions.CanCreateAnnotations value is ignored.

The XfdfOptions.CanModifyAnnotations value is ignored.

The XfdfOptions.CanDeleteAnnotations value is ignored.

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
ExportedAnnotation Event