:: com :: sun :: star :: text ::
|
constants group ReferenceFieldPart |
- Description
- These constants define how the reference position is displayed in
reference text fields.
|
Constants |
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.
|
NUMBER |
The numbering label and depending of the reference field context numbering lables of
superior list levels of the reference are displayed.
|
NUMBER_NO_CONTEXT |
The numbering label of the reference is displayed.
|
NUMBER_FULL_CONTEXT |
The numbering label and numbering lables of superior list levels of the reference are displayed.
|
Constants' Details |
PAGE
const short PAGE = 0;
- Description
- The page number is displayed using arabic numbers.
|
|
CHAPTER
const short CHAPTER = 1;
- Description
- The number of the chapter is displayed.
|
|
TEXT
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
const short UP_DOWN = 3;
- Description
- The reference is displayed as one of the (localized) words, "above" or "below".
|
|
PAGE_DESC
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
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
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
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.
|
|
NUMBER
const short NUMBER = 8;
- Description
- The numbering label and depending of the reference field context numbering lables of
superior list levels of the reference are displayed.
This option is only valid, if the source of the reference is a bookmark or a set reference.
The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts - named "referenced item" in the following - is displayed. To unambiguous
identify the referenced item at the document position of the reference text field, the content
of all needed superior levels are added in front. The needed superior levels of the referenced
item are the ones, which differ from the superior levels of the document position of the reference
text field.
Additional condition, which suppresses the addition of a superior level's list label content:
The list label of the referenced item can already contain numbers of a superior levels. Assume X
be the level of the most superior level, then no list label content of superior levels greater or
equal than X are added.
If the referenced item isn't numbered, nothing is displayed.
- Since
- OOo 3.0
|
|
NUMBER_NO_CONTEXT
const short NUMBER_NO_CONTEXT = 9;
- Description
- The numbering label of the reference is displayed.
This option is only valid, if the source of the reference is a bookmark or a set reference.
The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.
- Since
- OOo 3.0
|
|
NUMBER_FULL_CONTEXT
const short NUMBER_FULL_CONTEXT = 10;
- Description
- The numbering label and numbering lables of superior list levels of the reference are displayed.
This option is only valid, if the source of the reference is a bookmark or a set reference.
The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts - named "referenced item" in the following - is displayed and the contents
of all list labels of superior levels are added in front of it.
Additional condition, which suppresses the addition of a superior level's list label content:
The list label of the referenced item can already contain numbers of a superior levels. Assume X
be the level of the most superior level, then no list label content of superior levels greater or
equal than X are added.
If the referenced item is numbered nothing is displayed.
- Since
- OOo 3.0
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.