Top   Module   Use   Manual   Index 

com :: sun :: star :: text ::

constants group ReferenceFieldPart


Description
These constants define how the reference position is displayed in reference text fields.


Constants

const short PAGE = = 0;
Description
The page number is displayed using arabic numbers.
const short CHAPTER = = 1;
Description
The number of the chapter is displayed.
const short TEXT = = 2;
Description
The reference text is displayed.

If the source of the reference is a sequence field, then the complete text of the paragraph is displayed. This is useful to reference to captions.

const short UP_DOWN = = 3;
Description
The reference is displayed as one of the (localized) words, "above" or "below".
const short PAGE_DESC = = 4;
Description
The page number is displayed using the numbering type defined in the page style of the reference position.
const short CATEGORY_AND_NUMBER = = 5;
Description
The category and the number of a caption is displayed.

This option is only valid if the source of the reference is a sequence field.

const short ONLY_CAPTION = = 6;
Description
The caption text of a caption is displayed.

This option is only valid if the source of the reference is a sequence field.

const short ONLY_SEQUENCE_NUMBER = = 7;
Description
The number of a sequence field is displayed.

This option is only valid if the source of the reference is a sequence field.

Top of Page