Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service NumberingLevel

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


Properties' Summary

Adjust adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)
ParentNumbering [ OPTIONAL ]
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 [ OPTIONAL ]
Name of the character style that is used for the numbering symbol.
BulletId [ DEPRECATED ]
[ OPTIONAL ]
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 [ OPTIONAL ]
contains the vertical orientation of a graphic.
StartWith [ OPTIONAL ]
specifies the start value for the numbering.
LeftMargin specifies the left margin of the numbering
SymbolTextDistance [ OPTIONAL ]
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 [ OPTIONAL ]
contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .
BulletRelSize [ OPTIONAL ]
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 .

Properties' Details

Adjust
 
short Adjust;
Description
adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

ParentNumbering
 
short ParentNumbering;
[ OPTIONAL ]
Description
number of upper levels that are included in the current numbering symbol.
Prefix
 
string Prefix;
Description
the prefix of the numbering symbol.
Suffix
 
string Suffix;
Description
the suffix of the numbering symbol.
CharStyleName
 
string CharStyleName;
[ OPTIONAL ]
Description
Name of the character style that is used for the numbering symbol.
BulletId
 
short BulletId;
[ DEPRECATED ]
[ OPTIONAL ]
Description
the ID of the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .
BulletChar
 
string BulletChar;
Description
contains the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .
BulletFontName
 
string BulletFontName;
Description
the name of the font for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .
GraphicURL
 
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
 
short VertOrient;
[ OPTIONAL ]
Description
contains the vertical orientation of a graphic.

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

StartWith
 
short StartWith;
[ OPTIONAL ]
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
 
long LeftMargin;
Description
specifies the left margin of the numbering
SymbolTextDistance
 
long SymbolTextDistance;
[ OPTIONAL ]
Description
specifies the distance between the numbering symbol and the text of the paragraph.
FirstLineOffset
 
long FirstLineOffset;
Description
specifies the offset between the beginning of the first line and the beginning of the following lines of the paragraph.
NumberingType
 
short NumberingType;
Description
specifies the type of numbering.
HeadingStyleName
 
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
 
long BulletColor;
[ OPTIONAL ]
Description
contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL .
BulletRelSize
 
short BulletRelSize;
[ OPTIONAL ]
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