constants group ReferenceFieldPart in module com::sun::star::text::

(Global Index)

Syntax

constants group ReferenceFieldPart;

Description

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

Constants Summary

PAGE The page number is displayed using arabic numbers.

CHAPTER The number of the chapter is displayed.

TEXT The reference text is displayed.

UP_DOWN The reference is displayed as one of the (localized) words, "above" or "below".

PAGE_DESC The page number is displayed using the numbering type defined in the page style of the reference position.

CATEGORY_AND_NUMBER The category and the number of a caption is displayed.

ONLY_CAPTION The caption text of a caption is displayed.

ONLY_SEQUENCE_NUMBER The number of a sequence field is displayed.

Field Details



PAGE

Syntax

const short  PAGE = 0;

Description

The page number is displayed using arabic numbers.


CHAPTER

Syntax

const short  CHAPTER = 1;

Description

The number of the chapter is displayed.


TEXT

Syntax

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.


UP_DOWN

Syntax

const short  UP_DOWN = 3;

Description

The reference is displayed as one of the (localized) words, "above" or "below".


PAGE_DESC

Syntax

const short  PAGE_DESC = 4;

Description

The page number is displayed using the numbering type defined in the page style of the reference position.


CATEGORY_AND_NUMBER

Syntax

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.


ONLY_CAPTION

Syntax

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.


ONLY_SEQUENCE_NUMBER

Syntax

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