service NumberingLevel in module com::sun::star::text::

(Global Index)

Syntax

service NumberingLevel;

Description

provides access to a numbering level as part of the Numbering Rules.

Property Summary

Adjust adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

ParentNumbering number of upper levels that are included in the current numbering symbol.

Prefix the prefix of the numbering symbol.

Suffix the suffix of the numbering symbol.

CharStyleName Name of the character style that is used for the numbering symbol.

BulletId the ID of the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

BulletChar contains the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

BulletFontName the name of the font for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

GraphicURL the URL of the graphic file that is used as the numbering symbol.

VertOrient contains the vertical orientation of a graphic.

StartWith specifies the start value for the numbering.

LeftMargin specifies the left margin of the numbering

SymbolTextDistance specifies the distance between the numbering symbol and the text of the paragraph.

FirstLineOffset specifies the offset between the beginning of the first line and the beginning of the following lines of the paragraph.

NumberingType specifies the type of numbering.

HeadingStyleName contains the name of the paragraph style that is interpreted as the header of this level. It is only contained in the levels of chapter numbering rules.

BulletColor contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

BulletRelSize contains the size of the symbol relative to the high of the paragraph. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

Property Details



Adjust

Syntax

short Adjust;

Description

adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)


ParentNumbering [ O P T I O N A L ]

Syntax

short ParentNumbering;

Description

number of upper levels that are included in the current numbering symbol.


Prefix

Syntax

string Prefix;

Description

the prefix of the numbering symbol.


Suffix

Syntax

string Suffix;

Description

the suffix of the numbering symbol.


CharStyleName [ O P T I O N A L ]

Syntax

string CharStyleName;

Description

Name of the character style that is used for the numbering symbol.


BulletId [ O P T I O N A L ]

[ DEPRECATED ]

Syntax

short BulletId;

Description

the ID of the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .


BulletChar

Syntax

string BulletChar;

Description

contains the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .


BulletFontName

Syntax

string BulletFontName;

Description

the name of the font for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .


GraphicURL

Syntax

string GraphicURL;

Description

the URL of the graphic file that is used as the numbering symbol.

This is only valid if the numbering type is NumberingType::BITMAP .


VertOrient [ O P T I O N A L ]

Syntax

short VertOrient;

Description

contains the vertical orientation of a graphic.

It is set using com::sun::star::text::VertOrientation.


StartWith [ O P T I O N A L ]

Syntax

short StartWith;

Description

specifies the start value for the numbering.

This property is only valid if the numbering type is not NumberingType::BITMAP or NumberingType::CHAR_SPECIAL .


LeftMargin

Syntax

long LeftMargin;

Description

specifies the left margin of the numbering


SymbolTextDistance [ O P T I O N A L ]

Syntax

long SymbolTextDistance;

Description

specifies the distance between the numbering symbol and the text of the paragraph.


FirstLineOffset

Syntax

long FirstLineOffset;

Description

specifies the offset between the beginning of the first line and the beginning of the following lines of the paragraph.


NumberingType

Syntax

short NumberingType;

Description

specifies the type of numbering.


HeadingStyleName

Syntax

string HeadingStyleName;

Description

contains the name of the paragraph style that is interpreted as the header of this level. It is only contained in the levels of chapter numbering rules.


BulletColor [ O P T I O N A L ]

Syntax

long BulletColor;

Description

contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .


BulletRelSize [ O P T I O N A L ]

Syntax

short BulletRelSize;

Description

contains the size of the symbol relative to the high of the paragraph. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .

Top of Page