Accusoft.PdfXpress5.Net
Document Class Members
See Also  Properties  Methods  Events Send Feedback
Accusoft.PdfXpressSdk Namespace : Document Class

Glossary Item Box

The following tables list the members exposed by Document.

Public Constructors

 NameDescription
Public ConstructorDocument ConstructorOverloaded. Creates a PDF document from an existing PDF file (on disk or in memory) or creates a new PDF.  
Top

Public Properties

 NameDescription
Public PropertyDocumentMetadataGets a reference to the DocumentMetadata object of a Document. The DocumentMetadata object represents the document's metadata, which includes general information, such as the document's title, author, and creation and modification dates.  
Public PropertyIsPortfolioRead-only, specifies whether the document is a portfolio.  
Public PropertyLinearizedThe PDF document is linearized.  
Public PropertyPageCountThe number of pages in the PDF document  
Public PropertyVersionSpecifies the version of the PDF standard the document adheres to.  
Top

Public Methods

 NameDescription
Public MethodAddAttachmentAdds the attachment to the document.  
Public MethodAddBookmarkChildOverloaded. Adds a new child bookmark context to the parent bookmark context.  
Public MethodAddBookmarkSiblingOverloaded. Adds a new next sibling bookmark context to the parent bookmark context.  
Public MethodAddHyperlinkAdds a hyperlink to the specified page.  
Public MethodAddImageOverloaded. Adds raw or compressed image data to an existing page in a PDF document.  
Public MethodAddTextAdds text to a document using specified formatting and rendering data.  
Public MethodAddWatermarkAdds a watermark into the current Document from another Document.  
Public MethodConvertToPdfA

Apply ISO 19005-1:2005 restrictions and prohibitions to convert a candidate PDF document to PDF/A.

If the candidate PDF document violates a restriction or prohibition, PDF Xpress may attempt to apply an automatic fix-up to satisfy compliance. If a detected violation is not fixed, then the conversion process will raise an exception that describes the nature of the failure.

PDF Xpress PDF/A conversion support is limited to new image-only PDFs. Image-only PDFs lack searchable text content, but require only honoring a subset of PDF/A-1b compliance rules. Consequently, converting a candidate PDF document to PDF/A-1b is guaranteed to fail if any of the following is true—

The candidate was opened from the file system or from memory.
Pages from another PDF document are inserted into the candidate.
XFDF is imported into the candidate.
A watermark is added to the candidate.

PDF/A compliance is not guaranteed if changes are made to the PDF document after conversion has succeeded.

Refer to ISO 19005-1:2005 Document management — Electronic document file format for long-term preservation — Part 1: Use of PDF 1.4 (PDF/A-1)

Specify a well-formed ICC profile using either a filename or a local memory buffer. The ICC profile filename will be ignored if a local memory buffer is provided.

 
Public MethodCopyPageToDesigned to make passing image data between different Accusoft components easier, this method makes a copy of the page's image data (rendering) and gives the new image data to another object which can be defined in a different Accusoft assembly. When finished, both this object and the destination object will contain separate copies of the same image data.  
Public MethodCreateBookmarkThis method creates a BookmarkContext object destined to be added to the document.  
Public MethodCreatePageAdds a new empty page to a PDF document.  
Public MethodCreateThumbnailOverloaded. Adds raw or compressed image data as a thumbnail to an existing page in a PDF document.  
Public MethodDeleteAnnotationRemoves the annotation at the specified annotation index from the specified page.  
Public MethodDeleteAttachmentDeletes the attachment specified by the index.  
Public MethodDeleteHyperlinkRemoves the hyperlink at the specified index from the specified page.  
Public MethodDeletePageDeletes an existing page by the given page number, from a PDF document.  
Public MethodDeleteThumbnailDeletes the thumbnail image for the selected page, if one exists.  
Public MethodDeleteWatermarkDeletes a watermark(s) from the Document's page.  
Public MethodDisposeDispose implemented for IDisposable interface.  
Public MethodExportXfdfExports PDF Annotations to XFDF text data.  
Public MethodExtractImagesExtracts the images on the page specified by the page number using the options specified.  
Public MethodExtractPagesExtracts pages from the document according to the page extraction options.  
Public MethodExtractThumbnailExtracts the thumbnail image on the page specified by the page number.  
Public MethodGetAnnotationCountReports the number of PDF Annotations on a specific page in the PDF document.  
Public MethodGetAnnotationNameReports the name of a PDF Annotation.  
Public MethodGetAnnotationSubtypeGets the subtype of the annotation at the specified annotation index from the specified page.  
Public MethodGetAttachmentReturns the attachment at the specified index.  
Public MethodGetAttachmentCountReturns the number of attachments in the document.  
Public MethodGetBookmarkChildGets the child bookmark context of the given parent bookmark context.  
Public MethodGetBookmarkRootGets the root bookmark context.  
Public MethodGetBookmarkSiblingGets the next sibling bookmark context of the parent bookmark context.  
Public MethodGetExtractedImageGets the extracted image from previously calling ExtractImages().  
Public MethodGetHyperlinkGets the hyperlink at the specified page and index.  
Public MethodGetHyperlinkCountReturns the number of hyperlinks on the specified page.  
Public MethodGetInfoGets information about an existing page in a PDF document.  
Public MethodGetTextFinderGets a TextFinder object for a page of the current document.  
Public MethodImportXfdfImports XFDF text data to PDF Annotations.  
Public MethodInsertPagesInserts pages into the current Document from another Document.  
Public MethodIsStrictlyDeviceGrayDetermines if the page strictly uses the color space DeviceGray for visible graphics.  
Public MethodMovePageMoves a page from one index location in the Document to another.  
Public MethodRemoveBookmarkRemoves the given bookmark context.  
Public MethodRenderPageToBitmapOverloaded. Generates a bitmap of an existing page using the current screen resolution.  
Public MethodRenderPageToDeviceContext

Draw a PDF page to a Windows GDI+ device context.

The PdfXpress event PageRendering is raised periodically while drawing.

The PdfXpress event PageRendered is raised upon successful completion.

 
Public MethodRenderPageToDibOverloaded. Renders a page to a Device-Independent-Bitmap at screen resolution.  
Public MethodRenderPageToEpsRenders a page to Encapsulated PostScript text.  
Public MethodRenderPageToImageDataRenders a page to an ImageDataInfo object.  
Public MethodSaveSave a PDF document containing at least one page to a PDF file  
Public MethodSaveToBuffer

Saves a PDF Document into a new local memory buffer.

 
Public MethodSaveToHandle

Saves a PDF Document into a new global memory buffer, accessed using a global handle.

 
Top

Public Events

 NameDescription
Public EventCancelInsertPagesEvent which is fired after each page is inserted to allow the user to cancel the current process.  
Public EventContinueExportCalled to interrupt an export operation.  
Public EventContinueImportCalled to interrupt an import operation.  
Public EventExportedAnnotationAn event that is raised for each PDF annotation successfully exported.  
Top

See Also

©2012. Accusoft Corporation. All Rights Reserved.