LibreOffice: com::sun::star::text::ReferenceFieldPart Constant Group Reference

LibreOffice LibreOffice 5.1 SDK API Reference

Variables
com::sun::star::text::ReferenceFieldPart Constant Group Referencepublished

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

## Variables
const short | PAGE = 0
| The page number is displayed using Arabic numbers. More...
const short | CHAPTER = 1
| The number of the chapter is displayed. More...
const short | TEXT = 2
| The reference text is displayed. More...
const short | UP_DOWN = 3
| The reference is displayed as one of the (localized) words, "above" or "below". More...
const short | PAGE_DESC = 4
| The page number is displayed using the numbering type defined in the page style of the reference position. More...
const short | CATEGORY_AND_NUMBER = 5
| The category and the number of a caption is displayed. More...
const short | ONLY_CAPTION = 6
| The caption text of a caption is displayed. More...
const short | ONLY_SEQUENCE_NUMBER = 7
| The number of a sequence field is displayed. More...
const short | NUMBER = 8
| The numbering label and depending of the reference field context numbering labels of superior list levels of the reference are displayed. More...
const short | NUMBER_NO_CONTEXT = 9
| The numbering label of the reference is displayed. More...
const short | NUMBER_FULL_CONTEXT = 10
| The numbering label and numbering labels of superior list levels of the reference are displayed. More...

## Detailed Description

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

## Variable Documentation

## § CATEGORY_AND_NUMBER

const short CATEGORY_AND_NUMBER = 5

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.

## § CHAPTER

const short CHAPTER = 1

The number of the chapter is displayed.

## § NUMBER

const short NUMBER = 8

The numbering label and depending of the reference field context numbering labels 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_FULL_CONTEXT

const short NUMBER_FULL_CONTEXT = 10

The numbering label and numbering labels 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

## § NUMBER_NO_CONTEXT

const short NUMBER_NO_CONTEXT = 9

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

## § ONLY_CAPTION

const short ONLY_CAPTION = 6

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

The number of a sequence field is displayed.

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

## § PAGE

const short PAGE = 0

The page number is displayed using Arabic numbers.

## § PAGE_DESC

const short PAGE_DESC = 4

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

## § TEXT

const short TEXT = 2

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

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