Value options for PDCollectionSplitType.
kCollectionSplitDefault=0x2000 | Default split based on view.
|
kCollectionSplitHorizontal | Split vertical.
|
kCollectionSplitVertical | Split horizontal.
|
kCollectionSplitNone | No split; show the navigator.
|
kCollectionSplitPreview | No split; show the preview.
|
Value options for PDCollectionViewType.
kCollectionViewTile=0x1000 | Tile navigator.
|
kCollectionViewDetails | Details navigator.
|
kCollectionViewCustom | Custom navigator.
|
A PDCollection represents a collection dictionary in a PDF file.
Collection view types and split types are unusual. A straight mapping of the View key and the Split key would result in the key/value of /View/H being part of the view type enumeration, but that would result in ambiguity when setting View to H and Split to N ( /View/H maps to "preview" in Acrobat 8, but /Split/N is documented to map to "no split, show navigator" in Acrobat 9. Because of this, and the fact that /View/H is really interpreted as a kind of split rather than a style of navigator, Preview was moved to the split type enumeration in the API. This interacts with the underlying file as follows: when a /View/H value is read it is mapped to "Tile" and "Preview" for the navigator style and split position. When the Tile/Preview combination is written out, it is recorded back to /View/H for consistency with Acrobat 8.
typedef OPAQUE_64_BITS PDCollection; For value options see PDCollectionSplitTypes.
typedef ASUns16 PDCollectionSplitType; For value options see PDCollectionViewTypes.
typedef ASUns16 PDCollectionViewType; typedef OPAQUE_64_BITS PDNavigator; | |
The size of the
PDCollectionFieldRec. | |
The ID of the field.
| |
The 0-based index of the field in the
PDCollectionSchema. | |
The subtype of the field. For example
/N represents a number and /S represents a string. | |
The name to use in the user interface.
| |
Default visibility.
| |
|
| |
|
| |
The size of the
PDCollectionViewDataRec. | |
The view type of the collection.
| |
The navigator to use with the collection. This is ignored if
view != custom. | |
The split type of the collection.
| |
A percentage from
0-100. It is ignored if the position is not a split view. If the position is a split view,-1 indicates an application-defined position. | |
|
PDFolder PDCollectionCreateFolder(PDCollection collection, ASConstText path); collection | The collection that will be associated with the new folder.
|
path | The path and name of the folder. The path syntax for folders takes the form
and may not end with a |
PDFolder PDCollectionGetFolder(PDCollection collection, ASConstText path); collection | The collection associated with the folder to be obtained.
|
path | The path to the folder. To specify the root folder itself, assign a value of
"/". The path syntax for folders takes the form [parent/]folder, where the mandatory parent/ section may be repeated as necessary to provide a complete path to the new folder. |
ASBool PDCollectionGetInitialStyle(PDCollection collection, ASCab style); collection | The collection object.
|
style | Dictionary to set
|
ASArraySize PDCollectionGetSortOrder(PDCollection collection, PDCollectionSchemaSortPairRec *pairs, ASArraySize arrayLen); collection | The collection object.
|
pairs | The array of pairs. It may be
NULL. |
arrayLen | The length of the pairs array.
|
pairs is NULL, the number of items in the collection sort dictionary is returned; otherwise, the number of items stored in the pairs array is returned. void PDCollectionGetViewData(PDCollection collection, PDCollectionViewDataRec *data); collection | The collection object.
|
data | The collection view data.
|
ASBool PDCollectionIsValid(PDCollection collection); collection | The collection
|
void PDCollectionRemoveFolder(PDCollection collection, ASConstText path); collection | The collection associated with the folder that will be removed.
|
path | The path to the folder.
|
0 if the folder hierarchy was successfully removed; otherwise an error code identifying the failure condition is returned. void PDCollectionRemoveInitialStyle(PDCollection collection); collection | The collection object.
|
void PDCollectionSetInitialStyle(PDCollection collection, ASConstCab style); collection | The collection object.
|
style | Dictionary to fill
|
void PDCollectionSetSortOrder(PDCollection collection, const PDCollectionSchemaSortPairRec *pairs, ASArraySize arrayLen); collection | The collection object.
|
pairs | The array of pairs. If it is
NULL, the collection sort dictionary is removed. |
arrayLen | The length of the
pairs array. |
void PDCollectionSetViewData(PDCollection collection, const PDCollectionViewDataRec *data); collection | The collection object.
|
data | The collection view data.
|