Loading...
Searching...
No Matches
pdftron::PDF Namespace Reference

## Namespaces
namespace | Annots
namespace | OCG
namespace | PDFA
namespace | PDFUA
namespace | Struct

## Classes
class | Action
class | ActionParameter
class | AdvancedImagingConvertOptions
class | AdvancedImagingModule
class | Annot
class | Appearance
class | BarcodeModule
class | BarcodeOptions
class | BitmapInfo
class | Bookmark
class | BorderStyle
class | CADConvertOptions
class | CADModule
struct | CharRange
class | CMSSignatureOptions
class | ColorPt
class | ColorSpace
class | ContentEdit
class | ContentReplacer
class | CubicCurveBuilder
class | DataExtractionModule
class | DataExtractionOptions
class | Date
class | Destination
class | DiffOptions
class | DigitalSignatureField
class | DisallowedChange
class | DocumentConversion
class | DocumentPreviewCache
class | Element
class | ElementBuilder
class | ElementReader
class | ElementWriter
class | EmbeddedTimestampVerificationResult
class | ExternalAnnotManager
class | Field
class | FileSpec
class | FindReplace
class | FindReplaceOptions
class | Flattener
class | Font
class | Function
class | GeometryCollection
class | GState
struct | Highlight
class | Highlights
class | HTML2PDF
class | HTTPRequestOptions
class | Image
class | Image2RGB
class | Image2RGBA
class | ImageSettings
class | JobRequest
class | KeyStrokeActionResult
class | KeyStrokeEventData
class | Line
class | LinkInfo
class | MarkdownToPDFOptions
class | MergeXFDFOptions
class | MonoImageSettings
class | OCRModule
class | OCROptions
class | OfficeLocaleOverrides
class | OfficeToPDFOptions
class | Optimizer
class | OptimizerSettings
class | OptionsBase
class | Page
class | PageLabel
class | PageSet
class | PathData
class | PatternColor
class | PDF2HtmlReflowParagraphsModule
class | PDF2WordModule
class | PDFDoc
class | PDFDocGenerator
class | PDFDocInfo
class | PDFDocViewPrefs
class | PDFDraw
class | PDFNetInternalTools
class | PDFRasterizer
class | PDFView
class | PDFViewCtrl
class | Point
class | Print
class | PrinterMode
class | PrintToPdfModule
class | PrintToPdfOptions
class | Proxy
class | QuadPoint
class | Rect
class | RectCollection
class | Redaction
class | Redactor
class | Reflow
class | ReflowProcessor
class | RefreshOptions
class | SearchResult
class | Selection
class | Separation
class | Shading
class | ShapedText
class | Stamper
class | StructuredOutputModule
class | Style
class | SVGConvertOptions
class | TaggingOptions
class | TemplateDocument
class | TextDiffOptions
class | TextExtractor
class | TextRange
class | TextSearch
class | TextSettings
class | TimestampingConfiguration
class | TimestampingResult
class | TOCSettings
class | TransPDF
class | TransPDFOptions
class | TrustVerificationResult
class | VerificationOptions
class | VerificationResult
class | ViewChangeCollection
class | ViewerOptimizedOptions
class | WebFontDownloader
class | WebPageSettings
class | Word
class | WordToPDFOptions

## Typedefs
typedef Common::Iterator< TRN_CharData > | CharIterator
typedef Common::Iterator< int > | GSChangesIterator
typedef TRN_CharData | CharData
typedef Common::Iterator< Page > | PageIterator
typedef Common::Iterator< Field > | FieldIterator
typedef Common::Iterator< DigitalSignatureField > | DigitalSignatureFieldIterator
typedef void(* | DownloadReportHandler) (DownloadedType type, PDFDoc *doc, int page_num, int obj_num, const char *message, void *data)

## Enumerations
enum | DownloadedType { e_downloadedtype_page = 0 , e_downloadedtype_thumb , e_downloadedtype_named_dests , e_downloadedtype_outline , e_downloadedtype_finished , e_downloadedtype_failed , e_downloadedtype_opened }

## Typedef Documentation

## ◆ CharData

typedef TRN_CharData pdftron::PDF::CharData

Definition at line 27 of file ElementReader.h.

## ◆ CharIterator

typedef Common::Iterator<TRN_CharData> pdftron::PDF::CharIterator

CharIterator is an iterator type that can be used to traverse CharData in the current e_text element. For a sample use case, please take a look at ElementReaderAdv sample project.

CharData is a data structure returned by CharIterator that is used to provide extra information about a character within a text run. The extra information includes positioning information, the character data and a number of bytes taken by the character.

char_code := for SimpleFonts char_code := char_data[0], for composite fonts char_code is the numeric value of data stored in char_data buffer.

(x, y) is a virtual point (x, y), located on the baseline. This point is called the pen position, and is used to position glyphs. The pen position has already taken into account the effects of any inter-character adjustments due to properties such as font size, text rise, character spacing, word spacing and positioning adjustments on 'TJ' elements.

char_data is a pointer to the buffer containing character data. For simple fonts each character is represented by a single byte. For multibyte (CID or Type0) fonts each character may take more than one byte.

bytes - the number of bytes representing this character in char_data buffer. For simple fonts 'bytes' will equal 1. For multibyte (CID or Type0) fonts 'bytes may be larger than 1.

Definition at line 41 of file CharData.h.

## ◆ DigitalSignatureFieldIterator

typedef Common::Iterator<DigitalSignatureField> pdftron::PDF::DigitalSignatureFieldIterator

DigitalSignatureFieldIterator is an iterator type that can be used to traverse a list of digital signature form fields in a PDF document.

Definition at line 53 of file PDFDoc.h.

## ◆ DownloadReportHandler

typedef void(* pdftron::PDF::DownloadReportHandler) (DownloadedType type, PDFDoc *doc, int page_num, int obj_num, const char *message, void *data)

Download event handling. A type of callback function (or a delegate in .NET terminology) that is called during download events triggered by calling OpenURLAsync.

Definition at line 44 of file PDFRasterizer.h.

## ◆ FieldIterator

typedef Common::Iterator<Field> pdftron::PDF::FieldIterator

FieldIterator is an iterator type that can be used to traverse a list of form fields in a PDF document. For more information, please PDFDoc::GetFieldIterator().

Definition at line 47 of file PDFDoc.h.

## ◆ GSChangesIterator

typedef Common::Iterator<int> pdftron::PDF::GSChangesIterator

GSChangesIterator is an iterator type that can be used to traverse a list of changes in the graphics state between subsequent graphical elements on the page. For a sample use case, please see ElementReaderAdv sample project.

Definition at line 24 of file ElementReader.h.

## ◆ PageIterator

typedef Common::Iterator<Page> pdftron::PDF::PageIterator

PageIterator is an iterator type that can be used to traverse a list of pages in a PDF document. For more information, please PDFDoc::GetPageIterator().

Definition at line 41 of file PDFDoc.h.

## Enumeration Type Documentation

## ◆ DownloadedType

enum pdftron::PDF::DownloadedType

DownloadedType lists the events triggered by calling OpenURLAsync.

Enumerator
e_downloadedtype_page | A new page has been downloaded.
e_downloadedtype_thumb | A thumbnail has been downloaded.
e_downloadedtype_named_dests | The named destinations have been downloaded. These may be necessary for link activation.
e_downloadedtype_outline | The document outline (bookmarks) has been downloaded.
e_downloadedtype_finished | The entire document has been downloaded.
e_downloadedtype_failed | An error has occurred while downloading and downloading has stopped.
e_downloadedtype_opened | The initial document information is available and it is now ok to query for document information.

Definition at line 20 of file PDFRasterizer.h.