Layer | PD_Layer |
Object | PDAnnot |
This is the abstract superclass for all annotations (see Section 8.4, Annotations, in the PDF Reference). Acrobat has two built-in annotation classes: PDTextAnnot and PDLinkAnnot. Plug-ins add movie, Widget (form field), and other annotation types. You can define new annotation subtypes by creating new annotation handlers (see Developing Plug-ins and Applications). There are no objects of type PDAnnot, but you can use PDAnnot methods on any subclass of PDAnnot.
The Acrobat SDK provides three useful macros to cast among PDAnnot and its text annotation and link annotation subclasses (see PDExpT.h). These are:
Define | ||
---|---|---|
CastToPDAnnot
Casts a link annotation or a text annotation to a generic annotation.
|
||
pdAnnotHidden
The annotation is not visible and does not print.
|
||
PDAnnotIgnorePerms
Allows modifying this annotation type in a write-protected document.
|
||
PDAnnotInfoInit | ||
pdAnnotInvisible
If there is no annotation handler, the annotation is invisible.
|
||
pdAnnotLock
The annotation does not move or resize with the view. Currently only form fields respect this flag. If the annotation is locked, the user cannot delete, move or change its associated form field's properties.
|
||
pdAnnotLockContents
If the annotation is content-locked, the user can not change its content key.
|
||
PDAnnotMaxDashes | ||
pdAnnotNoRotate
The annotation does not rotate with the page.
|
||
pdAnnotNoView
The annotation does not view but can print.
|
||
pdAnnotNoZoom
The annotation does not zoom with the view.
|
||
PDAnnotOperationAll
All operations are allowed.
|
||
PDAnnotOperationFilter
It is okay to filter annotations.
|
||
PDAnnotOperationFlatten
When creating a flattened page include this annot
|
||
PDAnnotOperationManager
It is okay to manage annotations.
|
||
PDAnnotOperationSummarize
It is okay to summarize annotations.
|
||
pdAnnotPrint
The annotation prints.
|
||
pdAnnotReadOnly
The annotation does not interact with the user.
|
||
pdAnnotSequenceAdjust
A place holder used only at runtime. Do not set this bit in PDF/FDF files.
|
||
pdAnnotToggleNoView
A mouse-over or selection causes the noView bit to toggle.
|
Typedef | ||
---|---|---|
PDAnnot
An annotation on a page in a PDF file. Acrobat viewers have two built-in annotation types: PDTextAnnot and PDLinkAnnot. Physical attributes of the annotation can be set and queried. Plug-ins add movie and Widget (form field) annotations. Developers can define new annotation subtypes by creating new annotation handlers.
|
||
PDAnnotArray | ||
PDAnnotArrayRec | ||
PDAnnotClipboardData
Used to store PDAnnot data for copy and paste operations.
|
||
PDAnnotInfo | ||
PDAnnotInfoRec |
Enumeration | ||
---|---|---|
PDAnnotPrintOp
PDAnnotPrintOp is passed to the PDAnnotHandlerGetPrintAppearanceProc() callback to specify the type of print operation being performed.
|
Structure | ||
---|---|---|
_PDAnnotInfoRec
Information associated with an annotation.
|
||
_s_PDAnnotArray
Used by PDDocExportSomeNotes(). It represents an array of PDAnnot objects.
|
Callback | ||
---|---|---|
PDAnnotWillPrintProc
A callback for PDAnnotHandler. This method is called to determine whether an annotation is printed.
|
Method | ||
---|---|---|
Tests whether the data from an annotation on a given page can be copied to a clipboard for pasting. This depends on whether there is a PDAnnotHandler with copy and paste support for the annotation, and whether copying is allowed by document permissions.
|
||
Tests whether data from an annotation that has been copied to a clipboard can be pasted to a location on a page. Pasting can be disallowed by document permissions, or because the annotation cannot be accurately reproduced in the destination document.
|
||
Copies action object data to a clipboard structure, from which it can be pasted.
|
||
void PDAnnotDestroyClipboardData(PDAnnotClipboardData data)
Destroys data that has been copied from an annotation object into a clipboard. Use this method after successfully pasting the data to a new document.
|
||
An annotation changed in the specified way.
|
||
Tests whether two annotations are identical.
|
||
PDAnnot PDAnnotFromCosObj(CosObj obj)
Converts a dictionary Cos object to an annotation. This method does not copy the object, but is instead the logical equivalent of a type cast.
|
||
Gets a note or link annotation's color. If the annotation does not specify an explicit color, a default color is returned. Text annotations return default yellow; all others return black. Only RGB color specifications are currently supported.
|
||
CosObj PDAnnotGetCosObj(PDAnnot annot)
Gets the Cos object corresponding to an annotation. This method does not copy the object, but is instead the logical equivalent of a type cast.
|
||
Gets an annotation's date.
|
||
ASUns32 PDAnnotGetFlags(PDAnnot anAnnot)
Gets an annotation's flags.
|
||
PDOCMD PDAnnotGetOCMD(PDAnnot annot)
Gets an optional-content membership dictionary (OCMD) object associated with the annotation.
|
||
Gets the size and location of an annotation on its page.
|
||
ASAtom PDAnnotGetSubtype(PDAnnot anAnnot)
Gets an annotation's subtype.
|
||
Gets an annotation's label text.
|
||
Gets an annotation's label text as an ASText object.
|
||
Tests whether an annotation with an OC entry is visible in a given optional-content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.
|
||
ASBool PDAnnotIsValid(PDAnnot anAnnot)
Tests whether an annotation is valid. This is intended only to ensure that the annotation has not been deleted, not to ensure that all necessary information is present and valid.
|
||
Broadcasts a PDAnnotDidChange() notification. Clients must call this method after making any change to a custom annotation.
|
||
Broadcasts a PDAnnotWillChange() notification. Clients must call this method before making any change to a custom annotation.
|
||
Pastes copied annotation data from a clipboard structure to a new annotation object in a specified document. After successfully pasting the data, use PDAnnotDestroyClipboardData() to free the associated memory.
|
||
void PDAnnotRemoveOCMD(PDAnnot annot)
Dissociates any optional-content membership dictionary (OCMD) object from the annotation.
|
||
Sets a note or link annotation's color. Only RGB color specifications are currently supported.
|
||
Sets an annotation's date.
|
||
Sets an annotation's flags.
|
||
Associates an optional-content membership dictionary (OCMD) object with the annotation, making it optionally visible according to the OCMD's visibility policy. If the annotation already has a dictionary, the method replaces it.
|
||
Sets the size and location of an annotation on its page.
|
||
Sets an annotation's label text.
|
||
Sets an annotation's label text.
|
||
An annotation was created.
|
||
An annotation will change in the specified way.
|
CastToPDAnnot |
Product availability: All |
Platform availability: All |
#define CastToPDAnnot *(PDAnnot *)&(a)
Casts a link annotation or a text annotation to a generic annotation.
See Also
File: PDExpT.h |
Line: 427 |
pdAnnotHidden |
Product availability: All |
Platform availability: All |
#define pdAnnotHidden 0x02
The annotation is not visible and does not print.
File: PDExpT.h |
Line: 371 |
PDAnnotIgnorePerms |
Product availability: All |
Platform availability: All |
#define PDAnnotIgnorePerms 0x0008
Allows modifying this annotation type in a write-protected document.
File: PDExpT.h |
Line: 465 |
PDAnnotInfoInit |
Product availability: All |
Platform availability: All |
#define PDAnnotInfoInit do { \ ASmemset(x, 0, sizeof(PDAnnotInfoRec)); \ x->size = sizeof(PDAnnotInfoRec); \ x->fxLayer = fixedTwo; \ } while (0)
File: PDExpT.h |
Line: 514 |
pdAnnotInvisible |
Product availability: All |
Platform availability: All |
#define pdAnnotInvisible 0x01
If there is no annotation handler, the annotation is invisible.
File: PDExpT.h |
Line: 366 |
pdAnnotLock |
Product availability: All |
Platform availability: All |
#define pdAnnotLock 0x80
The annotation does not move or resize with the view. Currently only form fields respect this flag. If the annotation is locked, the user cannot delete, move or change its associated form field's properties.
File: PDExpT.h |
Line: 402 |
pdAnnotLockContents |
Product availability: All |
Platform availability: All |
#define pdAnnotLockContents 0x200
If the annotation is content-locked, the user can not change its content key.
File: PDExpT.h |
Line: 412 |
PDAnnotMaxDashes |
Product availability: All |
Platform availability: All |
#define PDAnnotMaxDashes 10
File: PDExpT.h |
Line: 1021 |
pdAnnotNoRotate |
Product availability: All |
Platform availability: All |
#define pdAnnotNoRotate 0x10
The annotation does not rotate with the page.
File: PDExpT.h |
Line: 386 |
pdAnnotNoView |
Product availability: All |
Platform availability: All |
#define pdAnnotNoView 0x20
The annotation does not view but can print.
File: PDExpT.h |
Line: 391 |
pdAnnotNoZoom |
Product availability: All |
Platform availability: All |
#define pdAnnotNoZoom 0x08
The annotation does not zoom with the view.
File: PDExpT.h |
Line: 381 |
PDAnnotOperationAll |
Product availability: All |
Platform availability: All |
#define PDAnnotOperationAll 0xFFFF
All operations are allowed.
File: PDExpT.h |
Line: 475 |
PDAnnotOperationFilter |
Product availability: All |
Platform availability: All |
#define PDAnnotOperationFilter 0x0002
It is okay to filter annotations.
File: PDExpT.h |
Line: 455 |
PDAnnotOperationFlatten |
Product availability: All |
Platform availability: All |
#define PDAnnotOperationFlatten 0x0010
When creating a flattened page include this annot
File: PDExpT.h |
Line: 470 |
PDAnnotOperationManager |
Product availability: All |
Platform availability: All |
#define PDAnnotOperationManager 0x0004
It is okay to manage annotations.
File: PDExpT.h |
Line: 460 |
PDAnnotOperationSummarize |
Product availability: All |
Platform availability: All |
#define PDAnnotOperationSummarize 0x0001
It is okay to summarize annotations.
File: PDExpT.h |
Line: 450 |
pdAnnotPrint |
Product availability: All |
Platform availability: All |
#define pdAnnotPrint 0x04
The annotation prints.
File: PDExpT.h |
Line: 376 |
pdAnnotReadOnly |
Product availability: All |
Platform availability: All |
#define pdAnnotReadOnly 0x40
The annotation does not interact with the user.
File: PDExpT.h |
Line: 396 |
pdAnnotSequenceAdjust |
Product availability: All |
Platform availability: All |
#define pdAnnotSequenceAdjust 0x80000000
A place holder used only at runtime. Do not set this bit in PDF/FDF files.
File: PDExpT.h |
Line: 417 |
pdAnnotToggleNoView |
Product availability: All |
Platform availability: All |
#define pdAnnotToggleNoView 0x100
A mouse-over or selection causes the noView
bit to toggle.
File: PDExpT.h |
Line: 407 |
PDAnnot |
Product availability: All |
Platform availability: All |
typedef OPAQUE_64_BITS PDAnnot;
An annotation on a page in a PDF file. Acrobat viewers have two built-in annotation types: PDTextAnnot and PDLinkAnnot. Physical attributes of the annotation can be set and queried. Plug-ins add movie and Widget (form field) annotations. Developers can define new annotation subtypes by creating new annotation handlers.
See Also
File: PDExpT.h |
Line: 318 |
PDAnnotArray |
Product availability: All |
Platform availability: All |
typedef _s_PDAnnotArray PDAnnotArray;
File: PDExpT.h |
Line: 6259 |
PDAnnotArrayRec |
Product availability: All |
Platform availability: All |
typedef _s_PDAnnotArray PDAnnotArrayRec;
File: PDExpT.h |
Line: 6259 |
PDAnnotClipboardData |
Product availability: All |
Platform availability: All |
typedef struct _t_PDAnnotClipboardData* PDAnnotClipboardData;
Used to store PDAnnot data for copy and paste operations.
See Also
File: PDExpT.h |
Line: 537 |
PDAnnotInfo |
Product availability: All |
Platform availability: All |
typedef _PDAnnotInfoRec PDAnnotInfo;
File: PDExpT.h |
Line: 503 |
PDAnnotInfoRec |
Product availability: All |
Platform availability: All |
typedef _PDAnnotInfoRec PDAnnotInfoRec;
File: PDExpT.h |
Line: 503 |
PDAnnotPrintOp |
Product availability: All |
Platform availability: All |
enum PDAnnotPrintOp {
kPDAnnotPrintStandard = 1,
kPDAnnotPrintVariableData
}
See Also
File: PDExpT.h |
Line: 548 |
kPDAnnotPrintStandard | A standard print operation. |
|
kPDAnnotPrintVariableData | The user selected Form Fields Only. |
_PDAnnotInfoRec |
Product availability: All |
Platform availability: All |
struct _PDAnnotInfoRec {
ASSize_t size;
ASFlagBits nOperationFlags;
unsigned char* cAuthor;
unsigned char* cContents;
unsigned char* cDate;
ASFixed fxLayer;
}
Information associated with an annotation.
See Also
File: PDExpT.h |
Line: 483 |
size | The size of the data structure. It must be set to |
|
nOperationFlags | The allowed operations. |
|
cAuthor | The author of this annotation. |
|
cContents | The associated text for this annotation. |
|
cDate | The modification date of this annotation. |
|
fxLayer | The layer of this annotation. |
_s_PDAnnotArray |
Product availability: All |
Platform availability: All |
struct _s_PDAnnotArray {
ASTArraySize annotCount;
PDAnnot annots;
}
Used by PDDocExportSomeNotes(). It represents an array of PDAnnot objects.
See Also
File: PDExpT.h |
Line: 6252 |
annotCount | The annotation count. |
|
annots | A pointer to an array of PDAnnots. |
PDAnnotWillPrintProc |
Product availability: All |
Platform availability: All |
ASBool (*PDAnnotWillPrintProc)(PDAnnotHandler pdanh, PDAnnot annot)
A callback for PDAnnotHandler. This method is called to determine whether an annotation is printed.
See Also
File: PDExpT.h |
Line: 656 |
PDAnnotCanCopy | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
Tests whether the data from an annotation on a given page can be copied to a clipboard for pasting. This depends on whether there is a PDAnnotHandler with copy and paste support for the annotation, and whether copying is allowed by document permissions.
Parameters
sourcePage — | The page containing the annotation to test. It can be |
|
annot — | The annotation to test. |
|
See Also
Since
File: PDProcs.h |
Line: 10758 |
PDAnnotCanPaste | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
ASBool PDAnnotCanPaste(PDPage destPage, const ASFixedPoint* center, PDAnnotClipboardData data)
Tests whether data from an annotation that has been copied to a clipboard can be pasted to a location on a page. Pasting can be disallowed by document permissions, or because the annotation cannot be accurately reproduced in the destination document.
Parameters
destPage — | The page to which the annotation would be pasted. |
|
center — | The location for the center of the annotation on the destination page, or a |
|
data — | The copied annotation data to test. |
|
See Also
Since
File: PDProcs.h |
Line: 10796 |
PDAnnotCopy | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
PDAnnotClipboardData PDAnnotCopy(PDPage sourcePage, PDAnnot annot)
Copies action object data to a clipboard structure, from which it can be pasted.
Parameters
sourcePage — | The page containing the annotation to copy. It can be |
|
annot — | The annotation to copy. |
The annotation clipboard data object. |
See Also
Since
File: PDProcs.h |
Line: 10774 |
PDAnnotDestroyClipboardData | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
void PDAnnotDestroyClipboardData(PDAnnotClipboardData data)
Destroys data that has been copied from an annotation object into a clipboard. Use this method after successfully pasting the data to a new document.
Parameters
data — | The clipboard annotation data to destroy. |
See Also
Since
File: PDProcs.h |
Line: 10831 |
PDAnnotDidChange | () |
Product availability: All |
Platform availability: All |
An annotation changed in the specified way.
Parameters
annot — | The annotation that changed. |
|
key — | The |
|
error — | The error code. |
|
clientData — | A pointer to a block of user-supplied data that was passed when the client registered for this notification using |
See Also
Notifications
File: PIPokes.h |
Line: 993 |
PDAnnotEqual | () |
Product availability: All |
Platform availability: All |
Tests whether two annotations are identical.
Parameters
anAnnot — | The first annotation to compare. |
|
annot2 — | The second annotation to compare. |
|
See Also
Exceptions
Since
File: PDProcs.h |
Line: 380 |
PDAnnotFromCosObj | () |
Product availability: All |
Platform availability: All |
Converts a dictionary Cos object to an annotation. This method does not copy the object, but is instead the logical equivalent of a type cast.
Parameters
obj — | The dictionary Cos object whose annotation is obtained. |
The PDAnnot corresponding to the Cos object. |
See Also
Exceptions
Since
File: PDProcs.h |
Line: 561 |
PDAnnotGetColor | () |
Product availability: All |
Platform availability: All |
ASBool PDAnnotGetColor(PDAnnot anAnnot, PDColorValue color)
Gets a note or link annotation's color. If the annotation does not specify an explicit color, a default color is returned. Text annotations return default yellow; all others return black. Only RGB color specifications are currently supported.
Parameters
anAnnot — | The note or link annotation whose color is obtained. |
|||||||||||
color — | (Filled by the method) The annotation's color, which is used as follows:
|
|
See Also
Since
File: PDProcs.h |
Line: 410 |
PDAnnotGetCosObj | () |
Product availability: All |
Platform availability: All |
Gets the Cos object corresponding to an annotation. This method does not copy the object, but is instead the logical equivalent of a type cast.
Parameters
annot — | IN/OUT The annotation whose Cos object is obtained. |
The dictionary Cos object for the annotation. The contents of the dictionary can be enumerated using CosObjEnum(). It returns a |
See Also
Since
File: PDProcs.h |
Line: 547 |
PDAnnotGetDate | () |
Product availability: All |
Platform availability: All |
ASBool PDAnnotGetDate(PDAnnot anAnnot, ASTimeRecP date)
Gets an annotation's date.
Parameters
anAnnot — | The annotation whose date is obtained. |
|
date — | (Filled by the method) The annotation's time and date. |
|
See Also
Exceptions
date
is NULL
. Since
File: PDProcs.h |
Line: 517 |
PDAnnotGetFlags | () |
Product availability: All |
Platform availability: All |
Gets an annotation's flags.
Parameters
anAnnot — | IN/OUT The annotation whose flags are obtained. |
The flags, or |
See Also
Since
File: PDProcs.h |
Line: 717 |
PDAnnotGetOCMD | () |
Product availability: All |
Platform availability: All |
Gets an optional-content membership dictionary (OCMD) object associated with the annotation.
Parameters
annot — | The annotation from which the dictionary is obtained. |
The dictionary object, or |
See Also
Since
File: PDProcs.h |
Line: 9223 |
PDAnnotGetRect | () |
Product availability: All |
Platform availability: All |
void PDAnnotGetRect(PDAnnot anAnnot, ASFixedRect* boxP)
Gets the size and location of an annotation on its page.
Parameters
anAnnot — | IN/OUT The annotation whose location and size are set. |
|
boxP — | IN/OUT (Filled by the method) A pointer to a rectangle that specifies the annotation's bounding rectangle, specified in user space coordinates. |
See Also
Exceptions
Since
File: PDProcs.h |
Line: 348 |
PDAnnotGetSubtype | () |
Product availability: All |
Platform availability: All |
Gets an annotation's subtype.
Parameters
anAnnot — | The annotation whose subtype is obtained. |
The ASAtom for the annotation's subtype. This can be converted to a string using ASAtomGetString(). The storage pointed to by the return value is owned by the Acrobat viewer and should be assumed to be valid only until the next call into any client API method; it should be immediately copied by the client if the client wants to reference it later. ASAtomNull if the annotation does not have a Subtype key or its value is not a name object. |
Exceptions
Since
File: PDProcs.h |
Line: 330 |
PDAnnotGetTitle | () |
Product availability: All |
Platform availability: All |
Gets an annotation's label text.
Parameters
anAnnot — | IN/OUT The annotation whose label is obtained. |
|
buffer — | IN/OUT (Filled by the method) The string into which the annotation's label string is copied. If the string is non- |
|
bufSize — | IN/OUT The buffer size in bytes. Up to |
If the string is non- |
See Also
Exceptions
Since
File: PDProcs.h |
Line: 470 |
PDAnnotGetTitleASText | () |
Product availability: All |
Platform availability: All |
Gets an annotation's label text as an ASText object.
Parameters
anAnnot — | The annotation whose label is obtained. |
|
title — | (Filled by the method) The text object containing the annotation's label string. The client must pass a valid ASText object title. The routine does not allocate it. |
See Also
Exceptions
Since
File: PDProcs.h |
Line: 11312 |
PDAnnotIsCurrentlyVisible | () |
Product availability: All |
Platform availability: All |
ASBool PDAnnotIsCurrentlyVisible(PDAnnot annot, PDOCContext ocContext)
Tests whether an annotation with an OC entry is visible in a given optional-content context, considering the current ON-OFF
states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.
Parameters
annot — | The annotation to test. |
|
ocContext — | The optional-content context in which the visibility is tested. |
|
See Also
Since
File: PDProcs.h |
Line: 9289 |
PDAnnotIsValid | () |
Product availability: All |
Platform availability: All |
Tests whether an annotation is valid. This is intended only to ensure that the annotation has not been deleted, not to ensure that all necessary information is present and valid.
Parameters
anAnnot — | The annotation whose validity is tested. |
|
See Also
Since
File: PDProcs.h |
Line: 313 |
PDAnnotNotifyDidChange | () |
Product availability: All |
Platform availability: All |
Broadcasts a PDAnnotDidChange() notification. Clients must call this method after making any change to a custom annotation.
Parameters
annot — | The annotation that has changed. |
|
key — | The ASAtom corresponding to the name of the key in the annotation's Cos dictionary that is changing. |
|
err — | An error code to pass to any method registered to receive the PDAnnotDidChange() notification. Pass zero if the annotation was changed successfully. Pass a nonzero value if an error occurred while changing the annotation. |
See Also
Notifications
Since
File: PDProcs.h |
Line: 260 |
PDAnnotNotifyWillChange | () |
Product availability: All |
Platform availability: All |
Broadcasts a PDAnnotWillChange() notification. Clients must call this method before making any change to a custom annotation.
Parameters
annot — | The annotation that has changed. |
|
key — | The ASAtom corresponding to the name of the key in the annotation's Cos dictionary that is changing. |
See Also
Notifications
Since
File: PDProcs.h |
Line: 241 |
PDAnnotPaste | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
PDAnnot PDAnnotPaste(PDPage destPage, const ASFixedPoint* center, PDAnnotClipboardData data)
Pastes copied annotation data from a clipboard structure to a new annotation object in a specified document. After successfully pasting the data, use PDAnnotDestroyClipboardData() to free the associated memory.
Parameters
destPage — | The page to which the annotation is pasted. |
|
center — | The location for the center of the annotation on the destination page, or a |
|
data — | The copied annotation data to paste. |
A newly created annotation object associated with the specified document, containing the same data as the copied annotation. |
See Also
Since
File: PDProcs.h |
Line: 10818 |
PDAnnotRemoveOCMD | () |
Product availability: All |
Platform availability: All |
void PDAnnotRemoveOCMD(PDAnnot annot)
Dissociates any optional-content membership dictionary (OCMD) object from the annotation.
Parameters
annot — | The annotation for which to remove the dictionary. |
See Also
Since
File: PDProcs.h |
Line: 9234 |
PDAnnotSetColor | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
void PDAnnotSetColor(PDAnnot anAnnot, const PDColorValue color)
Sets a note or link annotation's color. Only RGB color specifications are currently supported.
Parameters
anAnnot — | IN/OUT The note or link annotation whose color is set. |
|||||||||||
color — | IN/OUT The annotation's color, which is used as follows:
|
See Also
Notifications
Since
File: PDProcs.h |
Line: 436 |
PDAnnotSetDate | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
void PDAnnotSetDate(PDAnnot anAnnot, const ASTimeRecP date)
Sets an annotation's date.
Parameters
anAnnot — | IN/OUT The annotation whose date is set. |
|
date — | IN/OUT The annotation's time and date. |
See Also
Notifications
Since
File: PDProcs.h |
Line: 532 |
PDAnnotSetFlags | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
Sets an annotation's flags.
Parameters
anAnnot — | IN/OUT The annotation whose flags are set. |
|
flags — | IN/OUT An |
See Also
Notifications
Since
File: PDProcs.h |
Line: 732 |
PDAnnotSetOCMD | () |
Product availability: All |
Platform availability: All |
Associates an optional-content membership dictionary (OCMD) object with the annotation, making it optionally visible according to the OCMD's visibility policy. If the annotation already has a dictionary, the method replaces it.
Parameters
annot — | The annotation for which to set the dictionary. |
|
pdocmd — | The new dictionary. |
See Also
Since
File: PDProcs.h |
Line: 9208 |
PDAnnotSetRect | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
void PDAnnotSetRect(PDAnnot anAnnot, const ASFixedRect* newBox)
Sets the size and location of an annotation on its page.
Parameters
anAnnot — | IN/OUT The annotation whose location and size are set. |
|
newBox — | IN/OUT A pointer to a rectangle that specifies the annotation's bounding rectangle, specified in user space coordinates. |
See Also
Notifications
Since
File: PDProcs.h |
Line: 367 |
PDAnnotSetTitle | () |
Product availability: Acrobat, PDFL |
Platform availability: Macintosh, Windows, UNIX |
Sets an annotation's label text.
Parameters
anAnnot — | IN/OUT The annotation whose label is set. |
|
str — | IN/OUT The string containing the label to set. |
|
nBytes — | IN/OUT The length of the label. The first |
See Also
Notifications
Since
File: PDProcs.h |
Line: 496 |
PDAnnotSetTitleASText | () |
Product availability: All |
Platform availability: All |
Sets an annotation's label text.
Parameters
anAnnot — | The annotation whose label is set. |
|
title — |
See Also
Notifications
Since
File: PDProcs.h |
Line: 11331 |
PDAnnotWasCreated | () |
Product availability: All |
Platform availability: All |
An annotation was created.
Parameters
annot — | The annotation that was created. |
|
page — | The page to which the annotation was added. |
|
clientData — | A pointer to a block of user-supplied data that was passed when the client registered for this notification using |
See Also
Notifications
File: PIPokes.h |
Line: 940 |
PDAnnotWillChange | () |
Product availability: All |
Platform availability: All |
An annotation will change in the specified way.
Parameters
annot — | The annotation that will change. |
|
key — | The |
|
clientData — | A pointer to a block of user-supplied data that was passed when the client registered for this notification using |
See Also
Notifications
File: PIPokes.h |
Line: 965 |