Core SDK
383 functions. Every declaration on the detail pages is extracted from the shipped bindings.
Content Creation
pdfAddHeaderFooter
|
Acrobat-style headers/footers: up to six independent text |
|---|
Conversion
pdfConvertEMFSpool
|
Convert a Windows print-spool EMF file to a new PDF page, |
|---|---|
pdfConvToUnicode
|
Convert an ANSI byte string to Unicode using an explicit |
Core
pdfBalancePageTree
|
Rebalance the PDF page tree (the /Pages node hierarchy) |
|---|---|
pdfBeginLayer
|
Start a marked-content region scoped to a layer or layer group, |
pdfBeginPageTemplate
|
Begin capturing content into a named page template |
pdfBeginTemplate
|
Begin capturing content into a new reusable template (Form |
pdfBeginTemplateEx
|
Begin capturing content into a new reusable template (Form |
pdfBeginTransparencyGroup
|
Begin a template whose Form XObject additionally carries a |
pdfCalcWidthHeight
|
Compute the missing dimension when scaling an object |
pdfChangeJavaScript
|
Replace the script text of a document-level named JavaScript |
pdfChangeJavaScriptAction
|
Replace the script of an existing JS action object (created |
pdfChangeJavaScriptName
|
Rename an entry in the document-level named-JavaScript table. |
pdfChangeNamedDest
|
Rename an existing named destination. |
pdfChangeOCGName
|
Rename an existing layer. |
pdfClearAutoTemplates
|
Clear the list of templates registered for automatic |
pdfClearErrorLog
|
Clear the last-error message. |
pdfClonePages
|
Page-tree structural edits: remove a page, reorder one, |
pdfComputeBBox
|
Compute the current page's bounding box (its MediaBox, per |
pdfCopyChoiceValues
|
Copy a Choice-type form field's (/Ch, listbox/combobox) |
pdfDAGetObjectCount
|
"Direct Access" (DA) variants of pdfGetObjectCount/ |
pdfDAGetObjectToString
|
"Direct Access" (DA) variants of pdfGetObjectCount/ |
pdfDAHidePage
|
Hide a page — per the PDF spec, there is no standard |
pdfDANormalizePage
|
Normalize a page's box/rotation combination (e.g. baking a |
pdfDARemoveUsageRights
|
Read the Adobe Reader "extended usage rights" permission |
pdfDeleteActionFromObj
|
Detach an action from an object's action list — by the |
pdfDeleteActionFromObjEx
|
Detach an action from an object's action list — by the |
pdfDeleteAnalysis
|
Read/delete a stored "analysis" result item — a generic, |
pdfDeleteAppEvents
|
Clear a specific application-event bit (Event) from |
pdfDeleteDPartNode
|
Create/manage the /DPart document-partitioning tree — a |
pdfDeleteJavaScripts
|
Delete every document-level named JavaScript entry. |
pdfDeleteNamedDest
|
Delete a named destination, by name or by index. |
pdfDeleteNamedDestByIndex
|
Delete a named destination, by name or by index. |
pdfDeleteOCGFromAppEvent
|
Remove event/category flags from a layer's automatic-state |
pdfDeleteOCGFromDisplayTree
|
Remove a layer from the viewer's layer panel (/OCProperties |
pdfDeleteOCUINode
|
Walk and prune the layer-panel UI display tree |
pdfDeletePage
|
Page-tree structural edits: remove a page, reorder one, |
pdfDeletePageLabels
|
Read/clear the document's /PageLabels number-tree ranges |
pdfDeletePageLGIDict
|
Manage /LGIDict (geospatial coordinate-system) |
pdfDeletePDF
|
Create a new document handle (pdfNewPDF); destroy one |
pdfDeleteSeparationInfo
|
pdfGetSeparationInfo reads back the first registered |
pdfDeleteSVG
|
The SVG parser-instance API: load an SVG once, inspect |
pdfDeleteTemplate
|
Remove a template — pdfDeleteTemplate by handle, |
pdfDeleteTemplateEx
|
Remove a template — pdfDeleteTemplate by handle, |
pdfDeleteWatermark
|
Tag a template (Form XObject) as a watermark so PDF editors |
pdfDocumentCount
|
LumasPDF-multi-document-session ABI compatibility shims — this |
pdfEditPage
|
Reopen an existing page for further content edits |
pdfEditTemplate
|
Reopen an existing native (previously-drawn) template for |
pdfEditTemplate2
|
Reopen an existing native (previously-drawn) template for |
pdfEnableMutex
|
Arm the per-document lock so pdfLockDocument/pdfUnlockDocument |
pdfEndLayer
|
Close the marked-content region opened by |
pdfEndPage
|
Reopen an existing page for further content edits |
pdfEndTemplate
|
Reopen an existing native (previously-drawn) template for |
pdfExchangePages
|
Page-tree structural edits: remove a page, reorder one, |
pdfExecuteJavaScript
|
Execute a JavaScript snippet against an embedded, real |
pdfFreePDF
|
Create a new document handle (pdfNewPDF); destroy one |
pdfFreeUniBuf
|
Convert between UTF-16 (wchar_t, this platform's native |
pdfHaveDPartRoot
|
Create/manage the /DPart document-partitioning tree — a |
pdfHidePage
|
Hide a page — per the PDF spec, there is no standard |
pdfInitHeaderFooter
|
Acrobat-style headers/footers: up to six independent text |
pdfInitOCGContUsage
|
Initialize a TPDFOCGContUsage record to its "unset" state |
pdfInitStack
|
Zero-initialize a TPDFStack struct (the output shape used |
pdfInsertBMPFromHandle
|
Insert a live GDI HBITMAP handle directly as an image, |
pdfInsertSVG
|
Parse and draw an SVG document onto the current page as real |
pdfInsertSVGEx
|
Parse and draw an SVG document onto the current page as real |
pdfIsEmptyPage
|
Test whether the current page has no drawn content. |
pdfIsLicensed
|
Report whether a valid license key is currently registered. |
pdfIsLinearized
|
Report whether the document is linearized ("fast web view"). |
pdfLoadFDFData
|
Import form-field values from an external FDF (Forms Data |
pdfLoadFDFDataEx
|
Import form-field values from an external FDF (Forms Data |
pdfLoadFromCanvasDC
|
Capture the GDI canvas created by pdfGetCanvasDC into the |
pdfLoadHeaderFooterSettings
|
Acrobat-style headers/footers: up to six independent text |
pdfLoadLayerConfig
|
Apply an alternate configuration's layer visibility to the |
pdfLoadState
|
Restore a previously saved document/engine state snapshot. |
pdfLoadSVG
|
The SVG parser-instance API: load an SVG once, inspect |
pdfLoadSVGFromBuffer
|
The SVG parser-instance API: load an SVG once, inspect |
pdfLockDocument
|
Acquire/release a document-level lock — for coordinating |
pdfLockLayer
|
Mark a layer as locked (its /Locked entry in /OCProperties/D) |
pdfMarkTemplateAsWatermark
|
Tag a template (Form XObject) as a watermark so PDF editors |
pdfMovePage
|
Page-tree structural edits: remove a page, reorder one, |
pdfNewPageFromCanvasDC
|
Capture the GDI canvas created by pdfGetCanvasDC into the |
pdfNewPDF
|
Create a new document handle (pdfNewPDF); destroy one |
pdfNewPostScriptXObject
|
Register a PostScript XObject (/Subtype /PS, a legacy PDF |
pdfNormalizePage
|
Normalize a page's box/rotation combination (e.g. baking a |
pdfOptimize
|
Run document-size optimization (e.g. removing unused objects, |
pdfParseContent
|
Replay the current page's content stream through a table of |
pdfPlaceTemplate
|
Place a template at an explicit position/scale on the |
pdfPlaceTemplateEx
|
Place a template at an explicit position/scale on the |
pdfRemoveStyle
|
Remove a named paragraph/character style (from whatever |
pdfRemoveUsageRights
|
Read the Adobe Reader "extended usage rights" permission |
pdfResetWatermark
|
Configure the document watermark, one typed property at a |
pdfRestoreGraphicState
|
Emit a Q (restore graphics state) operator and pop the |
pdfRetrieveCustomDataToString
|
A generic, key-value custom-data blob store/retrieve |
pdfSaveFDFData
|
Export the document's CURRENT form field values as an FDF |
pdfSelectDocument
|
LumasPDF-multi-document-session ABI compatibility shims — this |
pdfSelectedDocument
|
LumasPDF-multi-document-session ABI compatibility shims — this |
pdfSelfTest
|
Verify core internal invariants of the loaded library. |
pdfStoreCustomDataFromString
|
A generic, key-value custom-data blob store/retrieve |
pdfStrLen
|
Null-terminated string length — a pure utility taking no |
pdfTranslateCoords
|
Concatenate a pure translation onto the current transform — |
pdfUnlockDocument
|
Acquire/release a document-level lock — for coordinating |
pdfUnLockLayer
|
Clear a layer's locked flag. |
pdfUseKerning
|
Look up the kerning adjustment for a specific character |
pdfUTF16ToUTF32
|
Convert between UTF-16 (wchar_t, this platform's native |
pdfUTF16ToUTF32Ex
|
Convert between UTF-16 (wchar_t, this platform's native |
pdfUTF32ToUTF16
|
Convert between UTF-16 (wchar_t, this platform's native |
pdfUTF32ToUTF16Ex
|
Convert between UTF-16 (wchar_t, this platform's native |
Getters
pdfGetActionCount
|
Total number of actions registered on this instance, across all |
|---|---|
pdfGetActionHandle
|
Look up the action handle attached to an object at a given |
pdfGetActionType
|
Get the TActionType of an action by its handle. |
pdfGetActionTypeEx
|
Get the TActionType of the ActIndex-th action attached to |
pdfGetAllocBy
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
pdfGetAllocCount
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
pdfGetAnalysisInfo
|
Read/delete a stored "analysis" result item — a generic, |
pdfGetAscent
|
Read the current font's ascent/descent/cap-height metrics |
pdfGetBaseURL
|
Get/set the document's /URI base-URL catalog entry, used |
pdfGetBBox
|
Set/get one of the current page's 5 box kinds (Media/Crop/ |
pdfGetBidiMode
|
Set/get the bidirectional (RTL/Hebrew/Arabic) text |
pdfGetBorderStyle
|
Set/get a document-global default annotation border style, |
pdfGetCanvasDC
|
Create an in-memory GDI device context sized |
pdfGetCanvasDCEx
|
Create an in-memory GDI device context sized |
pdfGetCapHeight
|
Read the current font's ascent/descent/cap-height metrics |
pdfGetCharacterSpacing
|
Set/get the PDF Tc (character spacing) and Tw (word |
pdfGetCollectionInfo
|
Create a PDF Portable Collection (/Collection catalog |
pdfGetCompressionFilter
|
Set/get the compression filter applied to newly-inserted |
pdfGetCompressionLevel
|
Set/get the Flate/zlib compression level (0..9) used |
pdfGetContent
|
Read/replace the raw content-stream bytes of a page — the |
pdfGetDefBitsPerPixel
|
Set/get a document-global default color bit depth for |
pdfGetDenyAllocAt
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
pdfGetDenyCount
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
pdfGetDescent
|
Read the current font's ascent/descent/cap-height metrics |
pdfGetDeviceNAttributes
|
Read a DeviceN color space's /Attributes dict (process- |
pdfGetDocInfo
|
Read the current in-memory value of one document-info field. |
pdfGetDocInfoCount
|
Number of document-info fields currently set. |
pdfGetDocInfoEx
|
Enumerate document-info entries by index. |
pdfGetDocumentID
|
Return a deterministic 32-bit integer derived from the |
pdfGetDocumentIdentifier
|
Return a full /ID[Part] value as a string, in either |
pdfGetDocumentResourceList
|
Return a human-readable listing of the document's resource |
pdfGetDocUsesTransparency
|
Get/set a document-level "uses transparency" flag consulted |
pdfGetDynaPDFVersion
|
LumasPDF-named alias returning the same version string. |
pdfGetErrLogMessage
|
Read one entry from the accumulating indexed error log. |
pdfGetErrLogMessageCount
|
Number of entries currently in the indexed error log. |
pdfGetErrorMessage
|
Return the single most-recent error message string. |
pdfGetErrorMode
|
Read the current error-mode bitmask. |
pdfGetGoToAction
|
Read back a GoTo action's destination page, type, and view |
pdfGetGoToRAction
|
Read back a GoToR action's target page and destination type. |
pdfGetHideAction
|
Read back a Hide action's hide/show flag. |
pdfGetInBBox
|
Read a page's box from the currently open import file |
pdfGetInDocInfo
|
Read a document-info field from the currently open import |
pdfGetInDocInfoCount
|
Number of entries in the import source's /Info dictionary. |
pdfGetInDocInfoEx
|
Enumerate the import source's document-info entries by index, |
pdfGetInIsCollection
|
Query properties of the currently open import file — a |
pdfGetInIsTaggedPDF
|
Query properties of the currently open import file — a |
pdfGetInkList
|
Read back an Ink annotation's full multi-stroke point data |
pdfGetInMetadata
|
Read the currently open import file's XMP metadata — the |
pdfGetInOrientation
|
Query properties of the currently open import file — a |
pdfGetInPageCount
|
Query properties of the currently open import file — a |
pdfGetInPDFVersion
|
Read the currently open import file's declared PDF |
pdfGetInPDFVersionEx
|
Read the currently open import file's declared PDF |
pdfGetInRepairMode
|
Query properties of the currently open import file — a |
pdfGetIsFixedPitch
|
Read the current font's ascent/descent/cap-height metrics |
pdfGetIsTaggingEnabled
|
Report whether structure-tree tagging is currently active |
pdfGetItalicAngle
|
Set/get a document-global italic-slant-angle value. |
pdfGetJavaScript
|
Read back a document-level named JavaScript's source — by |
pdfGetJavaScriptAction
|
Read the script text of a JS action by handle. |
pdfGetJavaScriptAction2
|
Read the script text and triggering event of the ActIndex-th |
pdfGetJavaScriptActionEx
|
Struct-based alternative to |
pdfGetJavaScriptCount
|
Read back a document-level named JavaScript's source — by |
pdfGetJavaScriptEx
|
Read back a document-level named JavaScript's source — by |
pdfGetJavaScriptName
|
Read back a document-level named JavaScript's source — by |
pdfGetJPEGQuality
|
Set/get the JPEG re-encoding quality applied when this SDK |
pdfGetJSConsole
|
Execute a JavaScript snippet against an embedded, real |
pdfGetKerning
|
Look up the kerning adjustment for a specific character |
pdfGetLanguage
|
Get/set the document's /Lang catalog entry (an |
pdfGetLaunchAction
|
Read back a Launch action's file name and new-window flag. |
pdfGetLayerConfig
|
Read metadata (intent, default flag, name) for one configuration |
pdfGetLayerConfigCount
|
Total number of configurations, including the default. |
pdfGetLeading
|
Set/get the document's explicit line-leading value |
pdfGetLumasPDFVersion
|
Return the product version as a dotted string. |
pdfGetLumasPDFVersionInt
|
Return the version as a single comparable integer. |
pdfGetMaxObjectNumber
|
Low-level PDF object-graph introspection/patching: query the |
pdfGetMeasureObj
|
Read a full /Measure dictionary's structured contents |
pdfGetMetaConvFlags
|
Set/get metafile (EMF/WMF) conversion behavior flags, |
pdfGetMetadata
|
Get/set raw XMP metadata bytes. |
pdfGetMovieAction
|
Read back a movie action's title and operation. |
pdfGetNamedAction
|
Read back a named (viewer-navigation) action's name and type. |
pdfGetNamedDest
|
Enumerate the document's named destinations by 0-based |
pdfGetNamedDestCount
|
Enumerate the document's named destinations by 0-based |
pdfGetNeedAppearance
|
Set/get the AcroForm /NeedAppearances flag — tells the PDF |
pdfGetObjActionCount
|
Number of actions attached to a given (ObjType, ObjHandle). |
pdfGetObjActions
|
Retrieve the full list of actions attached to (ObjType, |
pdfGetObjectCount
|
Low-level PDF object-graph introspection/patching: query the |
pdfGetObjectDecodeError
|
Report whether a specific object of the open import source decodes |
pdfGetObjectToString
|
Low-level PDF object-graph introspection/patching: query the |
pdfGetObjEvent
|
Read one node of a per-object action-event linked list |
pdfGetOCG
|
Read back a layer's handle/name. |
pdfGetOCGContUsage
|
Read back a layer's /Usage dictionary fields. |
pdfGetOCGCount
|
Number of OCGs (layers) registered on this instance. |
pdfGetOCGUsageUserName
|
Enumerate all /User /Name entries registered for a layer (not |
pdfGetOCHandle
|
By name, resolve an optional-content (OCG) object pointer |
pdfGetOCUINode
|
Walk and prune the layer-panel UI display tree |
pdfGetOrientation
|
Set/get page rotation (/Rotate) — via explicit page |
pdfGetPageBBox
|
Set/get a page's box via an explicit page pointer (from |
pdfGetPageCoords
|
Set/get the document's coordinate-system convention |
pdfGetPageCount
|
Total page count in the document; the 1-based number of |
pdfGetPageHeight
|
Get/set the current page's width/height — and, for the |
pdfGetPageLabel
|
Read/clear the document's /PageLabels number-tree ranges |
pdfGetPageLabelCount
|
Read/clear the document's /PageLabels number-tree ranges |
pdfGetPageLayout
|
Get/set the document's /PageLayout (SinglePage/OneColumn/ |
pdfGetPageLGIDictContent
|
Manage /LGIDict (geospatial coordinate-system) |
pdfGetPageLGIDictCount
|
Manage /LGIDict (geospatial coordinate-system) |
pdfGetPageMetricsToString
|
Return a human-readable summary string of a page's |
pdfGetPageMode
|
Get/set the document's /PageLayout (SinglePage/OneColumn/ |
pdfGetPageNum
|
Total page count in the document; the 1-based number of |
pdfGetPageObject
|
Obtain the opaque page object handle (IPGE) for a page, for |
pdfGetPageOrientation
|
Set/get page rotation (/Rotate) — via explicit page |
pdfGetPageWidth
|
Get/set the current page's width/height — and, for the |
pdfGetPDFVersion
|
Get/set the output document's declared PDF version (the |
pdfGetPDFVersionEx
|
Get/set the output document's declared PDF version (the |
pdfGetPtDataArray
|
Read a /PtData (point-data, e.g. geospatial track/cloud |
pdfGetPtDataObj
|
Read a /PtData (point-data, e.g. geospatial track/cloud |
pdfGetResetAction
|
Read back a Reset-form action's field list and exclude flag. |
pdfGetResolution
|
Set/get a document-global default resolution (DPI) value. |
pdfGetSeparationInfo
|
pdfGetSeparationInfo reads back the first registered |
pdfGetStringListCount
|
Read back one of several internal named string lists |
pdfGetStringListItem
|
Read back one of several internal named string lists |
pdfGetSubmitAction
|
Read back a Submit-form action's URL and flags. |
pdfGetSVGSize
|
The SVG parser-instance API: load an SVG once, inspect |
pdfGetSVGSymbolCount
|
The SVG parser-instance API: load an SVG once, inspect |
pdfGetSVGSymbolName
|
The SVG parser-instance API: load an SVG once, inspect |
pdfGetTabLen
|
Set/get how many space-equivalents a tab character (\t) |
pdfGetTabOrderMode
|
Set/get the document's /Tabs page-attribute default (form |
pdfGetTemplCount
|
Total template count; the most-recently-created template's |
pdfGetTemplHandle
|
Total template count; the most-recently-created template's |
pdfGetTemplHeight
|
Total template count; the most-recently-created template's |
pdfGetTemplWidth
|
Total template count; the most-recently-created template's |
pdfGetTypoLeading
|
Set/get the document's explicit line-leading value |
pdfGetURIAction
|
Read back a URI action's target. |
pdfGetUseExactPwd
|
Set/get whether password matching during decryption must be |
pdfGetUserRights
|
Read the Adobe Reader "extended usage rights" permission |
pdfGetUserUnit
|
Set/get the page's /UserUnit catalog entry — a multiplier |
pdfGetUsesTransparency
|
Report whether a specific page uses transparency |
pdfGetUseTransparency
|
Get/set a document-level "uses transparency" flag consulted |
pdfGetUseVisibleCoords
|
Get/set whether "visible" (top-down, GDI-style) coordinates |
pdfGetViewerPreferences
|
Get/set the document's /ViewerPreferences dictionary |
pdfGetViewport
|
Enumerate the viewports registered on an arbitrary page (by |
pdfGetViewportCount
|
Enumerate the viewports registered on an arbitrary page (by |
pdfGetWMFDefExtent
|
Set/get the default logical extent (fallback size) used |
pdfGetWMFPixelPerInch
|
Set/get the pixels-per-inch scale factor used when |
pdfGetWordSpacing
|
Set/get the PDF Tc (character spacing) and Tw (word |
Misc
psrAbort
|
psrAbort marks the context as aborted (refusing further |
|---|---|
psrClearSelection
|
psrAbort marks the context as aborted (refusing further |
psrCreateParserContext
|
Create/destroy a content-parser context — the handle every |
psrDeleteOperator
|
Remove one normalized operator (as indexed in the |
psrDeleteOperatorInObject
|
Remove one normalized operator (as indexed in the |
psrDeleteParserContext
|
Create/destroy a content-parser context — the handle every |
psrGetOpStructSize
|
Return the byte size of a given operator's Param struct — |
psrGetSelBBox
|
Compute the on-page geometry of a text selection — |
psrGetSelBBox2
|
Compute the on-page geometry of a text selection — |
psrIsInvisible
|
Decode the invisible-fill/invisible-stroke bit (bit 28) of |
psrParsePage
|
Parse a page's content stream into the context's operator |
psrReset
|
psrAbort marks the context as aborted (refusing further |
psrTransformOp
|
Apply an affine transform to one content object of the |
tsaBuildRequest
|
Low-level, network-free RFC-3161 timestamp-request building |
tsaParseResponse
|
Low-level, network-free RFC-3161 timestamp-request building |
Object Creation
pdfCreate3DBackground
|
Set a 3D view's background color. |
|---|---|
pdfCreate3DGotoViewAction
|
Create a /GoTo3DView action jumping to a specific view on |
pdfCreate3DProjection
|
Set a 3D view's camera projection (orthographic/perspective, |
pdfCreate3DView
|
Create a new named camera view (/3DView) on an existing 3D |
pdfCreateArticleThread
|
Create a new PDF article thread (/Threads — a legacy |
pdfCreateButton
|
Create a generic push-button form field. |
pdfCreateColItemDate
|
Attach one collection-schema field value (date, number, or |
pdfCreateColItemNumber
|
Attach one collection-schema field value (date, number, or |
pdfCreateColItemString
|
Attach one collection-schema field value (date, number, or |
pdfCreateCollection
|
Create a PDF Portable Collection (/Collection catalog |
pdfCreateDPartRoot
|
Create/manage the /DPart document-partitioning tree — a |
pdfCreateGeospatialMeasure
|
Attach a geospatial (/Subtype /GEO) /Measure dictionary |
pdfCreateGoToAction
|
Create a GoTo action targeting an explicit destination on a page |
pdfCreateGoToActionEx
|
Create a GoTo action targeting a previously created named |
pdfCreateGoToEAction
|
Create a "go to embedded" action that opens a PDF embedded |
pdfCreateGoToRAction
|
Create a "go to remote" action that opens another PDF file and |
pdfCreateGoToRActionEx
|
GoToR variant that targets a named destination in the remote |
pdfCreateGoToRActionExU
|
GoToR-to-named-destination variant with a Unicode file name. |
pdfCreateHideAction
|
Create an action that shows or hides a form field. |
pdfCreateImpDataAction
|
Create an action that imports form-data from an external file |
pdfCreateJSAction
|
Create a JavaScript action object that runs Script when |
pdfCreateLaunchAction
|
Create an action that launches an external application or file. |
pdfCreateLaunchActionEx
|
Create a launch action from just a file name and new-window |
pdfCreateMovieAction
|
Create a movie-control action (play/stop/pause/resume). |
pdfCreateNamedAction
|
Create one of the four standard viewer navigation actions |
pdfCreateNamedDest
|
Register a named destination (a string name mapped to a page + |
pdfCreateNewPDF
|
Open an output file for an already-created document |
pdfCreateOCG
|
Create a new optional-content group (a "layer"). |
pdfCreateOCLayerConfig
|
Create a named alternate optional-content configuration (a |
pdfCreateOCMD
|
Create an optional-content membership dictionary — visibility |
pdfCreateResetAction
|
Create a form-reset action. |
pdfCreateSeparationCS
|
Register a new Separation color space (a single-colorant |
pdfCreateSoftMask
|
Build an ExtGState carrying a real /SMask soft mask |
pdfCreateStructureTree
|
Open the document-root structure element with the default root |
pdfCreateStructureTreeEx
|
Open the document-root structure element with an explicit root |
pdfCreateSubmitAction
|
Create a form-submission action targeting a URL. |
pdfCreateURIAction
|
Create an action that opens a URI (typically a web link). |
pdfCreateViewport
|
Register a new /Viewport entry (a named rectangular |
Setters
pdfSetAllocBy
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
|---|---|
pdfSetAnsiMode
|
Select whether A-suffixed text parameters in the "gap |
pdfSetBaseURL
|
Get/set the document's /URI base-URL catalog entry, used |
pdfSetBBox
|
Set/get one of the current page's 5 box kinds (Media/Crop/ |
pdfSetBidiMode
|
Set/get the bidirectional (RTL/Hebrew/Arabic) text |
pdfSetBlackGenFunction
|
Install real prepress ExtGState functions — /TR2 (transfer |
pdfSetBorderStyle
|
Set/get a document-global default annotation border style, |
pdfSetBreakString
|
Set the string appended at a forced line break in |
pdfSetCapturedPageOptional
|
Retroactively wrap a captured (imported/replayed) page's |
pdfSetCapturedPageTransparencyGroup
|
Retroactively wrap a captured (imported/replayed) page's |
pdfSetCharacterSpacing
|
Set/get the PDF Tc (character spacing) and Tw (word |
pdfSetCharWidth
|
Override a specific character code's advance width for |
pdfSetCompressionFilter
|
Set/get the compression filter applied to newly-inserted |
pdfSetCompressionLevel
|
Set/get the Flate/zlib compression level (0..9) used |
pdfSetContent
|
Read/replace the raw content-stream bytes of a page — the |
pdfSetDecodeMode
|
Control whether pdfGetObjectToString ([Document Lifecycle, Locking, and Object Introspection](E11_DocumentLifecycleLockingAndObjectIntrospection.md)) returns a |
pdfSetDefBitsPerPixel
|
Set/get a document-global default color bit depth for |
pdfSetDenyAllocAt
|
A flat-C-API-compatible memory-allocator debugging/tuning cluster: |
pdfSetDocInfo
|
Set a standard document-info field (Author, Title, Subject, |
pdfSetDocInfoEx
|
Set a document-info field, including (per the reference ABI's |
pdfSetEMFFrameDPI
|
Set the DPI used to interpret an EMF metafile's device-space |
pdfSetErrorMode
|
Choose which error classes are logged and delivered to the |
pdfSetFloatPrecision
|
Set the number of decimal digits used when formatting |
pdfSetGDIPlusOptions
|
Set a GDI+-integration option, keyed by OptionID, for |
pdfSetHalftone
|
Install real prepress ExtGState functions — /TR2 (transfer |
pdfSetItalicAngle
|
Set/get a document-global italic-slant-angle value. |
pdfSetJPEGQuality
|
Set/get the JPEG re-encoding quality applied when this SDK |
pdfSetLanguage
|
Get/set the document's /Lang catalog entry (an |
pdfSetLeading
|
Set/get the document's explicit line-leading value |
pdfSetLicenseKey
|
Register a license key; a valid key suppresses the trial |
pdfSetMaxErrLogMsgCount
|
Cap the number of entries retained in the indexed error log. |
pdfSetMetaConvFlags
|
Set/get metafile (EMF/WMF) conversion behavior flags, |
pdfSetMetadata
|
Get/set raw XMP metadata bytes. |
pdfSetNeedAppearance
|
Set/get the AcroForm /NeedAppearances flag — tells the PDF |
pdfSetObjectFromString
|
Low-level PDF object-graph introspection/patching: query the |
pdfSetOCGContUsage
|
Set the /Usage (application) dictionary fields for a layer — |
pdfSetOnErrorProc
|
Register a callback invoked live for each raised error. |
pdfSetOnPageBreakProc
|
Register a callback invoked whenever flowed/continued text |
pdfSetOrientation
|
Set/get page rotation (/Rotate) — via explicit page |
pdfSetOrientationEx
|
Set/get page rotation (/Rotate) — via explicit page |
pdfSetPageBBox
|
Set/get a page's box via an explicit page pointer (from |
pdfSetPageCoords
|
Set/get the document's coordinate-system convention |
pdfSetPageFooter
|
Set a document-wide running header/footer with independent |
pdfSetPageHeader
|
Set a document-wide running header/footer with independent |
pdfSetPageHeight
|
Get/set the current page's width/height — and, for the |
pdfSetPageLayout
|
Get/set the document's /PageLayout (SinglePage/OneColumn/ |
pdfSetPageMode
|
Get/set the document's /PageLayout (SinglePage/OneColumn/ |
pdfSetPageOrientation
|
Set/get page rotation (/Rotate) — via explicit page |
pdfSetPageThumbnail
|
Generate and attach a /Thumb thumbnail image to the |
pdfSetPageWidth
|
Get/set the current page's width/height — and, for the |
pdfSetPDFVersion
|
Get/set the output document's declared PDF version (the |
pdfSetProgressProc
|
Register callbacks to report long-running-operation progress |
pdfSetResolution
|
Set/get a document-global default resolution (DPI) value. |
pdfSetSeparationInfo
|
pdfGetSeparationInfo reads back the first registered |
pdfSetSpaceWidthFactor
|
Set a document-global multiplier intended to scale the |
pdfSetStructElemID
|
A/W variant of [pdfSetTagID](#api-pdfsettagid). |
pdfSetStructElemTitle
|
Set the /T (Title) attribute on the currently-open structure |
pdfSetTabLen
|
Set/get how many space-equivalents a tab character (\t) |
pdfSetTabOrderMode
|
Set/get the document's /Tabs page-attribute default (form |
pdfSetTagID
|
Set the /ID attribute on the currently-open structure |
pdfSetTemplBBox
|
Change an existing template's bounding box. |
pdfSetTransferFunction
|
Install real prepress ExtGState functions — /TR2 (transfer |
pdfSetTrialMode
|
Opt into stamping a demo/trial watermark on output while the |
pdfSetUseExactPwd
|
Set/get whether password matching during decryption must be |
pdfSetUserUnit
|
Set/get the page's /UserUnit catalog entry — a multiplier |
pdfSetUseTransparency
|
Get/set a document-level "uses transparency" flag consulted |
pdfSetUseVisibleCoords
|
Get/set whether "visible" (top-down, GDI-style) coordinates |
pdfSetViewerPreferences
|
Get/set the document's /ViewerPreferences dictionary |
pdfSetWatermarkClrProperty
|
Configure the document watermark, one typed property at a |
pdfSetWatermarkDblProperty
|
Configure the document watermark, one typed property at a |
pdfSetWatermarkIntProperty
|
Configure the document watermark, one typed property at a |
pdfSetWatermarkStrProperty
|
Configure the document watermark, one typed property at a |
pdfSetWMFDefExtent
|
Set/get the default logical extent (fallback size) used |
pdfSetWMFPixelPerInch
|
Set/get the pixels-per-inch scale factor used when |
pdfSetWordSpacing
|
Set/get the PDF Tc (character spacing) and Tw (word |
Validation
pdfCheckCollection
|
Create a PDF Portable Collection (/Collection catalog |
|---|---|
pdfCheckObjects
|
Run a structural integrity scan over every object in the |
Vector Graphics
pdfDrawHTMLBox
|
Draw HTML markup (the same limited tag subset as |
|---|---|
pdfDrawNGon
|
Draw a regular N-sided polygon centered at (PosX, PosY). |
pdfDrawPostScriptXObject
|
Register a PostScript XObject (/Subtype /PS, a legacy PDF |