DynaPDF Manual - Page 362
Previous Page 361 Index Next Page 363
Function Reference
Page 362 of 839
atNamed,
// Named action
atRendition,
// Rendition action
atReset,
// Reset form action
atSetOCGState,
// Set OCG (optional content group) action
atSound,
// Sound action
atSubmit,
// Submit form action
atThread,
// Thread action
atTransition,
// Transition action
atURI
// URI action
atGoTo3DView,
// Go-to 3D view action
atGoToE,
// Go-to embedded file action
atRichMediaExec // Rich Media Execution, PDF 1.7 Extension Level 3
}TActionType;
The function returns the type of an annotation. The parameter ActHandle must be a valid action
handle. To determine the used action types of a specific object use GetActionTypeEx() instead.
Return values:
If the function succeeds the return value is the type of the annotation (make a type cast to
TActionType to determine the action type). If the function fails the return value is a negative error
code.
GetActionTypeEx
Syntax:
SI32 pdfGetActionTypeEx(
const PPDF* IPDF, // Instance pointer
TObjType ObjType, // Object type
UI32 ObjHandle,
// Object handle
UI32 ActIndex)
// Action index
typedef enum
{
otAction,
otAnnotation,
otBookmark,
otCatalog,
otField,
otPage,
otPageLink
}TObjType;
The function returns the action type of an action used by a specific PDF object. The parameter
ObjType specifies the type of object that identifies the parameter ObjHandle. If the object type is a
page use the page number as handle.
The parameter ActIndex is an index into the objects action array. Use the function
GetObjActionCount() to get the number of actions used by the object. This number can be used in a
for statement to loop over the object actions. See DeleteActionFormObj() for an example application.
Return values:
If the function succeeds the return value is the type of the annotation (make a type cast to
TActionType to determine the action type). If the function fails the return value is a negative error
code.
Previous topic: GetActionCount, GetActionHandle, GetActionType
Next topic: GetActiveFont, GetAllocBy, GetAnnot (obsolete)