actions.h File Reference

Action API. More...

#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/attachments.h>
#include <pdfsdk/core/optional_content.h>
#include <pdfsdk/core/types.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>

Go to the source code of this file.

Typedefs
typedef PDErrCode(PDFSDK_CALLCONV *	PDDocLevelJSEnumProc) (const wchar_t *name, PDAction action, void *clientData)

Enumerations
enum	PDDestType {   kPDDestUnknown , kPDDestXYZ , kPDDestFit , kPDDestFitH ,   kPDDestFitV , kPDDestFitR , kPDDestFitB , kPDDestFitBH ,   kPDDestFitBV }
	Defines a specific location (destination) within a PDF document that can be directly referenced or linked to. More...
enum	PDActionHideItemType { kPDActionHideItemAnnot , kPDActionHideItemFieldName }
	Defines actions that can hide or show specific elements within a PDF document. More...

Functions
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocSetOpenAction (PDDoc doc, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetOpenAction (PDDoc doc, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocSetOpenDestination (PDDoc doc, PDDest destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetOpenDestination (PDDoc doc, PDDest *destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocEnumDocLevelJSActions (PDDoc doc, PDDocLevelJSEnumProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetDocLevelJSAction (PDDoc doc, const wchar_t *name, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocRemoveDocLevelJS (PDDoc doc)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageSetOpenAction (PDPage page, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageGetOpenAction (PDPage page, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageSetCloseAction (PDPage page, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageGetCloseAction (PDPage page, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateURI (PDDoc doc, const char *uri, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateGoTo (PDDoc doc, PDDest destination, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateJavaScript (PDDoc doc, const wchar_t *jscode, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateSubmitForm (PDDoc doc, const char *serverUri, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateResetForm (PDDoc doc, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateHide (PDDoc doc, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCreateNamed (PDDoc doc, PDAtom name, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateActionFromPDObject (PDObject object, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGetPDObject (PDAction action, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionCopy (PDDoc doc, PDAction from, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSetNext (PDAction action, PDAction next)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSetNextArray (PDAction action, const PDAction *pNext, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGetType (PDAction action, PDAtom *actionType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGetNext (PDAction action, size_t index, PDAction *pNext)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGetNextLength (PDAction action, size_t *length)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToGetDest (PDAction action, PDDest *destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToSetDest (PDAction action, PDDest destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRGetFileSpec (PDAction action, PDFileSpec *fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRSetFileSpec (PDAction action, PDFileSpec fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRGetDest (PDAction action, PDDest *destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRSetDest (PDAction action, PDDest destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRGetNewWindow (PDAction action, bool *pNewWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToRSetNewWindow (PDAction action, bool newWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToEGetFileName (PDAction action, wchar_t *buffer, size_t size, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToESetFileName (PDAction action, const wchar_t *fileName, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToEGetTarget (PDAction action, PDObject *pDictionary)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToESetTarget (PDAction action, PDObject pDictionary)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToEGetFileSpec (PDAction action, PDFileSpec *fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToESetFileSpec (PDAction action, PDFileSpec fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToEGetDest (PDAction action, PDDest *destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToESetDest (PDAction action, PDDest destination)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToEGetNewWindow (PDAction action, bool *pNewWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionGoToESetNewWindow (PDAction action, bool newWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionLaunchGetFileSpec (PDAction action, PDFileSpec *fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionLaunchSetFileSpec (PDAction action, PDFileSpec fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionLaunchGetNewWindow (PDAction action, bool *pNewWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionLaunchSetNewWindow (PDAction action, bool newWindow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionURIGetURI (PDAction action, char *buffer, size_t size, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionURISetURI (PDAction action, const char *uri, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionURIGetIsMap (PDAction action, bool *isMap)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionURISetIsMap (PDAction action, bool isMap)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideGetNumItems (PDAction action, size_t *pNumItems)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideRemoveItem (PDAction action, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideGetItemType (PDAction action, size_t index, PDActionHideItemType *ptype)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideGetItemAnnot (PDAction action, size_t index, PDAnnot *pAnnot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideGetItemFieldName (PDAction action, size_t index, wchar_t *buffer, size_t size, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideAddItemAnnot (PDAction action, PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideAddItemFieldName (PDAction action, const wchar_t *name, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideIsHiding (PDAction action, bool *pHiding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionHideSetHiding (PDAction action, bool hiding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionNamedGetName (PDAction action, PDAtom *pName)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionNamedSetName (PDAction action, PDAtom name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionJavaScriptGetScript (PDAction action, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionJavaScriptSetScript (PDAction action, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestCreate (PDDoc doc, PDDestType type, bool remote, size_t pageIndex, const float *params, PDDest *pDest)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestCreateFromPDObject (PDObject obj, PDDest *pDest)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestGetPDObject (PDDest dest, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestCopy (PDDest srcDest, PDDest *dest)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestGetType (PDDest dest, PDDestType *type)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestGetPageIndex (PDDest dest, size_t *pageIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDestGetParams (PDDest dest, float *params)

Detailed Description

Action API.

Enumeration Type Documentation

PDActionHideItemType

enum PDActionHideItemType

Defines actions that can hide or show specific elements within a PDF document.

Enumerator
kPDActionHideItemAnnot	Hides an annotation within a PDF document.
kPDActionHideItemFieldName	Hides a field name within a PDF document.

PDDestType

enum PDDestType

Defines a specific location (destination) within a PDF document that can be directly referenced or linked to.

This enumeration specifies the way navigation within a document is handled and how it is displayed. This can include jumping to a particular page, a specific section, or a bookmarked location while also zooming in a specified way.

For more information you can refer to section 12.3.2.2 - Explicit destinations, table 149 - Destination syntax in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDDestUnknown	Destination isn't defined or is outside the recognized options.
kPDDestXYZ	Specifies a destination using the upper-left corner point(XY) and a zoom factor (Z).
kPDDestFit	Fits the entire page into the window.
kPDDestFitH	Fits the width of the page into the window.
kPDDestFitV	Fits the height of the page into the window.
kPDDestFitR	Fits a rectangle specified by its upper-left and lower-right corner points into the window.
kPDDestFitB	Fits the rectangle containing all visible elements on the page (B-bounding box) into the window.
kPDDestFitBH	Fits the width of the bounding box into the window.
kPDDestFitBV	Fits the height of the bounding box into the window.