ASBool PDPageLabelEqual(PDPageLabel pdlOne, PDPageLabel pdlTwo); pdlOne | A page label.
|
pdlTwo | Another page label.
|
PDPageLabel PDPageLabelFromCosObj(CosObj cosLabel); cosLabel | IN/OUT The Cos object level representation of a page label.
|
cosLabel. is raised if
cosLabel is not a valid page label. |
CosObj PDPageLabelGetCosObj(PDPageLabel pdl); pdl | IN/OUT A PDPageLabel representation of a page label.
|
const char *PDPageLabelGetPrefix(PDPageLabel pgLabel, ASInt32 *prefixLen); pgLabel | The label for the page whose prefix is desired.
|
prefixLen | (Filled by the method) The length, in bytes, of the prefix string. It is zero if the page label is not valid.
|
NULL if none is specified. void PDPageLabelGetPrefixASText(PDPageLabel pgLabel, ASText prefix); pgLabel | The label for the page whose prefix is desired.
|
prefix | (Filled by the method) The text object containing the prefix string. The client must pass a valid ASText object title. The routine does not allocate it.
|
ASInt32 PDPageLabelGetStart(PDPageLabel pgLabel); pgLabel | The page label for the page whose starting number is desired.
|
1 if the page label is not valid or unknown. Returns an ASAtom for the style of the label.
It raises an exception if storage is exhausted or file access fails.
ASAtom PDPageLabelGetStyle(PDPageLabel pgLabel); pgLabel | IN/OUT The page label whose style is desired.
|
Determines whether a page label is valid.
A page label is valid if its values correspond to the specification for page label dictionaries. See the description of Page labels in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 12.4.2, page 374.
You can find this document on the web store of the International Standards Organization (ISO).
It raises an exception if storage is exhausted or file access fails.
ASBool PDPageLabelIsValid(PDPageLabel pgLabel); pgLabel | The page label whose validity is determined.
|
PDPageLabel PDPageLabelNew(PDDoc pdDoc, ASAtom style, const char *prefix, ASInt32 prefixLen, ASInt32 startAt); pdDoc | The document that contains the new page label.
|
style | The numbering system to use for the numeric portion of each label in this range of pages. The possible values are
D for decimal numbers, R for upper-case Roman numbers, r for lower-case Roman numbers, A for upper-case alphabetic numbers, or a for lower-case alphabetic numbers. If it is None, the labels for this range will not have a numeric portion. None is specified by providing ASAtomFromString("None") as the style parameter. |
prefix | A string to prefix to the numeric portion of the page label. It may be a
NULL string. |
prefixLen | The length in bytes of the prefix string.
|
startAt | The value to use when generating the numeric portion of the first label in this range; it must be greater than or equal to
1. |
is raised if the base pages object is missing or invalid.
|
PDPageLabel PDPageLabelNewASText(PDDoc pdDoc, ASAtom style, const ASText prefix, ASInt32 startAt); pdDoc | The document that contains the new page label.
| ||||||||||||
style | The numbering system to use for the numeric portion of each label in this range of pages. The possible values are:
If it is | ||||||||||||
prefix | The text object containing the string to prefix to the numeric portion of the page label.
| ||||||||||||
startAt | The value to use when generating the numeric portion of the first label in this range; it must be greater than or equal to
1. |
is raised if the base pages object is missing or invalid.
|