Overview

The Annotation interface represents a single annotation on a given page.

To obtain this interface, call the Page.GetFirstAnnotation, Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Represents the base class for Link actions.

Represents a goto action that scrolls to a specified location in the document.

Represents a goto remote action that opens another document.

Represents a named action that can be executed.

Represents a URI action that opens another document.

Optional appearance data that controls how the annotation is rendered. Appearance streams enable the annotation to be presented visually in different ways to reflect its interactions with the user. Each appearance stream is a byte stream of a Document Filters supported image format. See Supported Formats, Raster image and Vector image for a list of supported formats. Please note only the SVG format is preserved as an SVG when creating appearance streams. All other formats will be rasterized.

Appearance streams are currently for writing only and are not read from PDFs.

Represents the appearance streams for an annotation.

Represents an Aztec barcode annotation.

Implements Annotation Interface. Represents the base class for all barcode annotations.

Represents the border appearance of the annotation.

Represents a Code128 barcode annotation.

Represents a Code39 barcode annotation.

Represents a DataMatrix barcode annotation.

Represents the default appearance values for the annotation, independent of any specific appearance stream.

A circle or ellipse annotation displays an ellipse on the page. When opened, it displays a pop-up window containing the text of the associated note.

A free text annotation displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.

Represents a GS1-128 barcode annotation.

Highlight annotations are used to highlight text content on a page.

An ink annotation represents a freehand "scribble" composed of one or more disjoint paths. When opened, it displays a pop-up window containing the text of the associated note.

A line annotation displays a single straight line on the page. When opened, it displays a pop-up window containing the text of the associated note.

Represents the line ending of the annotation.

A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Represents a named destination in the document.

Represents the base class for note annotations.

A list of AnnotationNote objects.

Represents a PDF417 barcode annotation.

A single point in the document's user space units. For .NET instead see System.Drawing.Point.

A list of AnnotationPoint objects.

A list containing AnnotationPointList objects.

Polygon annotations display closed polygons on the page. Such polygons may have any number of vertices connected by straight lines. Polyline annotations are similar to polygons, except that the first and last vertex are not implicitly connected.

Polygon annotations display closed polygons on the page. Such polygons may have any number of vertices connected by straight lines. Polyline annotations are similar to polygons, except that the first and last vertex are not implicitly connected.

A pop-up annotation displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent’s text.

It has no appearance stream or associated actions of its own.

Represents a QR code barcode annotation.

The AnnotationRect interface represents an annotation’s bounding box.

A rectangle annotation displays a rectangle on the page. When opened, it displays a pop-up window containing the text of the associated note.

Squiggly annotations are used to underline text content on a page with a squiggly line.

A rubber stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. When opened, it displays a pop-up window containing the text of the associated note.

A text annotation represents a "sticky note" attached to a point in the document. When closed, the annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in a font and size chosen by the viewer application.Text annotations do not scale and rotate with the page; they behave as if the NoZoom and NoRotate annotation flags were always set.

Strikeout annotations are used to strike through text content on a page.

Represents the base class for text markup annotations.

Underline annotations are used to underline text content on a page.

The Bookmark interface allows for the extraction of the hierarchical navigation data for a document. Bookmarks are either extracted directly from the document, or generated from the heading style information

To obtain this interface, call the Extractor.GetRootBookmark method.

The Canvas interface allows rendering of pages to a variety of output devices, including HD HTML, PNG, and PDF.

The Canvas object also allows post-processing / image manipulation of output such as annotations, redaction, bates stamping, or general drawing.

To obtain this interface, call the DocumentFilters.MakeOutputCanvas or DocumentFilters.MakeOutputCanvasOnStream methods.

Note The drawing API is available for bitmap and PDF outputs only.

The CompareDocumentSettings controls the compare settings for a document.

The CompareDocumentSource interface is used when comparing two documents, allowing you to set an extractor and provide optional settings.

The CompareResultDifference represents a single diff in a document or page comparison.

The CompareResultDifferenceDetail interface contains information about the words that make up a CompareResultDifference, including the text, page index and bounding box.

The CompareResults interface is the returned object from a call to Extractor::Compare or Page::Compare and is used to enumerate the differences between the two entities.

The CompareSettings instance allows you to set the comparison type and flags when comparing documents or pages.

DocumentFilters (formerly IFileReaders) is the primary factory object in the Document Filters Object Library. You will need to create and initialize an instance of this object to start using the API. It is recommended to define the object in the application scope and create and initialize it only once.

The samples for each method are provided in JScript and assume a global instance of the DocumentFilters factory object that is already created and initialized.

The Extractor interface allows you to extract the content of a document and/or enumerate its sub-documents, such as email attachments and ZIP archives.

To obtain this interface, call the DocumentFilters.GetExtractor method. The Extractor interface contains the following methods and properties.

The FormElement interface represents a single form control for a given page. FormElements are currently supported for static PDF documents.

The FormElement interface represents a single form control for a given page. FormElements are currently support for static PDF documents.

The FormKeyValue interface is used to provided updated values for Forms.

This interface can be created directly.

The Hyperlink interface represents a single hyperlink on a given page.

To obtain this interface, call the Page.GetNextHyperlink method.

Represents a file-type as returned by GetSupportedFormats.

Represents a configuration option as returned by GetAvailableOptions.

The Page interface represents a single page in an image laid-out document. The page allows access to the words on a page, as well as the ability to render it onto a canvas such as TIFF, PNG, or PDF.

To obtain this interface, call the Extractor::GetPage.

Represents a page element in a document.

The RenderPageProperties interface provides additional information for rendering a page to a canvas.

This interface can be created directly.

The SubFile interface is a descendant of Extractor, allowing work with sub-documents, extracted from a parent document, by calling the parent’s Extractor::GetFirstSubFile and Extractor::GetNextSubFile methods.

Open the sub-document associated with an instance of SubFile, in the same way as described for Extractor, allowing processing of sub-documents to any depth. This means that text can be extracted and/or sub-documents contained in this SubFile maybe enumerated.

The Word interface allows extraction of words and their bounding boxes when in paginated image mode.

To obtain this interface, call the Page.GetFirstWord, Page.GetNextWord methods, or Page.Words property.