A %PDF document may optionally display a document outline on the screen, allowing
the user to navigate interactively from one part of the document to another.
The OCG::Config object represents an optional-content (OC) configuration
structure (see section 4.10.3 in PDF Reference), used to persist a set
of visibility states and other optional-content information in a PDF file
A document has a default configuration, saved in the D entry in the
'OCProperties' dictionary (that can be obtained using pdfdoc.GetOCConfig()),
and can have a list of other configurations, saved as an array in the
'Configs' entry in the OCProperties dictionary.
The OCG::Context object represents an optional-content context in a document, within which
document objects such as words or annotations are visible or hidden.
The ConvertPrinter class contains static member functions for installing and
uninstalling a Windows OS printer for conversion of document formats by
the Convert class.
A destination defines a particular view of a document, consisting of the
following:
- The page of the document to be displayed
- The location of the document window on that page
- The magnification (zoom) factor to use when displaying the page
Destinations may be associated with Bookmarks, Annotations, and Remote Go-To Actions.
This integer list represents the scale type of the Screen annotation
e_Anamorphic - Scale the icon to fill the annotation rectangle
exactly, without regard to its original aspect
ratio (ratio of width to height).
This integer list represents the scale type of the Widget annotation
e_Anamorphic - Scale the icon to fill the annotation rectangle
exactly, without regard to its original aspect
ratio (ratio of width to height).
This integer list represents the Icon type of the RubberStamp annotation
e_Approved - a stamp with the text "Approved"
e_Experimental - a stamp with the text "Experimental"
e_NotApproved - a stamp with the text "NotApproved"
e_AsIs, - a stamp with the text "AsIs"
e_Expired - a stamp with the text "Expired"
e_NotForPublicRelease - a stamp with the text "NotForPublicRelease"
e_Confidential - a stamp with the text "Confidential"
e_Final - a stamp with the text "Final"
e_Sold - a stamp with the text "Sold"
e_Departmental - a stamp with the text "Departmental"
e_ForComment - a stamp with the text "ForComment"
e_TopSecret - a stamp with the text "TopScret"
e_ForPublicRelease - a stamp with the text "ForPublicRelease"
e_Draft - a stamp with the text "Draft"
e_Unknown - User defined or invalid.
e_array -
Static variable in class pdftron.SDF.Obj
e_button -
Static variable in class pdftron.PDF.Field
Interactive forms support the following field types:
- Button fields represent interactive controls on the screen that the user can
manipulate with the mouse.
PageLayout specifies the page layout to be used when the document is
opened:
- e_SinglePage Display one page at a time
- e_OneColumn Display the pages in one-column mode.
This integer list represents the Quad Format of the Redaction annotation
e_LeftJustified - Overlay text is left justified
e_Centered - Overlay text is centered
e_RightJustified - Overlay text is right justified
e_None - No justification to the overlay text.
e_media -
Static variable in class pdftron.PDF.Page
PDF page can define as many as five separate boundaries to control various aspects of the
imaging process (for more details please refer to Section 10.10.1 'Page Boundaries' in PDF
Reference Manual):
- The media box defines the boundaries of the physical medium on which the page is to be
printed.
e_Mic -
Static variable in class pdftron.PDF.Annots.Sound
e_NoIcon -
Static variable in class pdftron.PDF.Annots.Screen
This enum represents the Icon and Caption Relation of the Screen annotation
e_NoIcon - No icon; caption only
e_NoCaption - No caption; icon only
e_CBelowI - Caption below the icon
e_CAboveI - Caption above the icon
e_CRightILeft - Caption to the right of the icon
e_CLeftIRight - Caption to the left of the icon
e_COverlayI - Caption overlaid directly on the icon
Default value: e_NoIcon.
e_NoIcon -
Static variable in class pdftron.PDF.Annots.Widget
This enum represents the Icon and Caption Relation of the Widget annotation
e_NoIcon - No icon; caption only
e_NoCaption - No caption; icon only
e_CBelowI - Caption below the icon
e_CAboveI - Caption above the icon
e_CRightILeft - Caption to the right of the icon
e_CLeftIRight - Caption to the left of the icon
e_COverlayI - Caption overlaid directly on the icon
Default value: e_NoIcon.
e_None -
Static variable in class pdftron.PDF.Annots.Line
The Constant e_None.
e_none -
Static variable in class pdftron.PDF.Annots.Link
This integer list spedifies the Highlighting mode of the Link Annotation
e_none - No highlighting.
e_None -
Static variable in class pdftron.PDF.Annots.Markup
This integer list represents the Border Effect of the Markup annotation
e_None - No effect
e_Cloudy - The border should appear “cloudy”.
e_None -
Static variable in class pdftron.PDF.Annots.Redaction
The Constant e_None.
e_none -
Static variable in class pdftron.PDF.Annots.Widget
This integer list spedifies the Highlighting mode of the Widget Annotation
e_none - No highlighting.
Draw or enumerate optional content that is visible, according to the current state of
Optional Content Groups (OCGs) and Optional Content Membership Dictionaries (OCMDs).
Checks whether the position is within the array bounds and then removes it from the
array and moves each subsequent element to the slot with the next smaller index and
decrements the arrays length by 1.
ErrorReportProc is an interface for a custom handler that
that can be used to report potential rendering errors in PDFViewCtrl,
PDFDraw, or PDFRasterizer.
Executes current action; this will only work for some action types that can be executed
only using the information contained in the action object or the associated PDF doc.
When the current element is a form XObject you have the option to skip form
processing (by not calling FormBegin()) or to open the form stream and
continue Element traversal into the form.
Although PDF is not a programming language it provides several types of function
object that represent parameterized classes of functions, including mathematical
formulas and sampled representations with arbitrary resolution.
The page on which the marked content is drawn, whether directly as part of
page content or indirectly by being in a Form XObject or annotation drawn
on that page.
Get the optional-content membership dictionary's visibility policy, which
determines the visibility of content with respect to the ON-OFF state of
OCGs listed in the dictionary.
GSChangesIterator is an iterator type that can be used to traverse a list
of changes in the graphics state between subsequnet graphical elements on the
page.
Text markup annotations shall appear as highlights, underlines,
strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4)
in the text of a document.
Highlights is used to store the necessary information and perform certain
tasks in accordance with Adobe's Highlight standard, whose details can be
found at:
http://partners.adobe.com/public/developer/en/pdf/HighlightFileFormat.pdf
In a nutshell, the Highlights class maintains a set of highlights.
'pdftron.PDF.HTML2PDF' is an optional PDFNet Add-On utility class that can be
used to convert HTML web pages into PDF documents by using an external
module (html2pdf).
The OCMD object represents an Optional Content Membership Dictionary (OCMD)
that allows the visibility of optional content to depend on the states in a
set of optional-content groups (OCG::Group).
OCMD(Obj) -
Constructor for class pdftron.PDF.OCG.OCMD
Creates a new optional-content group (OCG) object from an existing
SDF/Cos object.
Patterns are quite general, and have many uses; for example, they can be used
to create various graphical textures, such as weaves, brick walls, sunbursts,
and similar geometrical and chromatic effects.
PDFACompliance class is used to validate PDF documents for PDF/A (ISO 19005:1/2/3)
compliance or to convert existing PDF files to PDF/A compliant documents.
Perform PDF/A validation or PDF/A conversion on the input PDF document with default "first_stop" value,
default conformance value and default max_rf_objs number.
Perform PDF/A validation or PDF/A conversion on the input PDF document
which is stored in a memory buffer with default "first_stop" value,
default conformance value and default max_rf_objs number..
Regenerates the appearance stream for every widget annotation in the
document Call this method if you modified field's value and would like to
update field's appearances.
RoleMap is a dictionary that maps the names of structure types used in the
document to their approximate equivalents in the set of standard structure
types.
Search the document and returns upon the following circumstances:
a)Reached the end of the document; b)Reached the end of a page (if set to
return by specifying mode 'e_page_stop' ); c)Found an instance matching
the search pattern.
SDFDoc is a low-level document representing a graph of SDF.Obj nodes that
can be used to build higher-level document models such as PDF (Portable Document
Format) or FDF (Forms Document Format).
Set the optional-content membership dictionary's visibility policy, which
determines the visibility of content with respect to the ON-OFF state of
OCGs listed in the dictionary.
Shading is a class that represents a flat interface around all PDF shading
types:
- In Function-based (type 1) shadings, the color at every point in the domain
is defined by a specified mathematical function.
A sound annotation (PDF 1.2) shall analogous to a text annotation
except that instead of a text note, it contains sound recorded from
the computer’s microphone or imported from a file.
TextMarkup annotations shall appear as highlights, underlines,
strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4)
in the text of a document.
TextMarkup annotations shall appear as highlights, underlines,
strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4)
in the text of a document.
Text markup annotations shall appear as highlights, underlines,
strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4)
in the text of a document.
Text markup annotations shall appear as highlights, underlines,
strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4)
in the text of a document.
A watermark annotation (PDF 1.6) shall be used to represent graphics
that shall be printed at a fixed size and position on a page,
regardless of the dimensions of the printed page.