CDDOCUMENT - Defines the attributes of a form. ----------------------------------------------------------------------------------------------------------
#include <editods.h>
Definition :
typedef struct {
BSIG Header;
WORD PaperColor; /* Color of the paper being used */
WORD FormFlags; /* Form Flags */
WORD NotePrivileges; /* Privs for notes created when
using form */ /* WARNING!!! Fields below this comment were not zeroed in builds
prior to 100. A mechanism has been set up to use them however.
dload checks the TPL_FLAG_SPARESOK bit in the flags word. If it
is not set, all of the storage after this comment is zeroed. On
save, dsave makes sure the unused storage is zero and sets the bit. */ WORD FormFlags2; /* more Form Flags */
WORD InherFieldNameLength; /* Length of the name, which follows this struct */
WORD PaperColorExt; /* Palette Color of the paper being used. Index into 240 color table. New in V4. */
COLOR_VALUE PaperColorValue; /* Paper Color: As of v5.0 stored as RGB, other formats possible */ WORD FormFlags3;
WORD Spare[1];
/* ... now the Inherit Field Name string */
/* ... now the Text Field Name string indicating which field to append version number to */
} CDDOCUMENT;
Description :
This defines the structure of the document information field in a form note. A document information field is an item with name $INFO (ITEM_NAME_DOCUMENT) and data type TYPE_COMPOSITE. The document information field defines attributes of documents created with that form.
Header: Defines this composite data item as a CDDOCUMENT item.
PaperColor: Background color of document:
0 black
1 white
2 gray
3 lt. green
4 green
5 lt. yellow
6 yellow
7 cyan
8 lt. cyan
9 red
10 green
11 blue
12 magenta
13 yellow
14 cyan
15 dk read
16 dk green
17 dk blue
18 dk magenta
19 dk yellow
20 dk cyan
21 - 240 palette color table index
FormFlags: Defines various attributes. See TPL_FLAG_xxx for details.
NotePrivileges: Privileges for notes created with this form.
FormFlags2: Defines various attributes. See TPL_FLAG_xxx for details.
InherFieldNameLength:
PaperColorExt: PaperColor value overrides PaperColorExt.
PaperColorValue: RGB 3 Component Color value (Please see COLOR_VALUE).
FormFlags3: Defines various attributes. See TPL_FLAG_xxx for details.
Since this field is of type TYPE_COMPOSITE, API programs that run on non-Intel architecture platforms must perform host/canonical conversion when accessing a CDDOCUMENT structure in a document information field item.