Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

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

Properties' Summary
short
Adjust
adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)  
short
ParentNumbering
[ OPTIONAL ]
number of upper levels that are included in the current numbering symbol.  
string
Prefix
the prefix of the numbering symbol.  
string
Suffix
the suffix of the numbering symbol.  
string
CharStyleName
[ OPTIONAL ]
Name of the character style that is used for the numbering symbol.  
short
BulletId
[ DEPRECATED ]
[ OPTIONAL ]
the ID of the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL.  
string
BulletChar
contains the symbol in the given font. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL.  
string
BulletFontName
the name of the font for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL.  
::com::sun::star::awt::FontDescriptor
BulletFont
[ OPTIONAL ]
the font used to paint the bullet.  
string
GraphicURL
the URL of the graphic file that is used as the numbering symbol.  
::com::sun::star::awt::XBitmap
GraphicBitmap
[ OPTIONAL ]
the bitmap containing the bullet.  
::com::sun::star::awt::Size
GraphicSize
[ OPTIONAL ]
size of the graphic that is used as bullet.  
short
VertOrient
[ OPTIONAL ]
contains the vertical orientation of a graphic.  
short
StartWith
[ OPTIONAL ]
specifies the start value for the numbering.  
long
LeftMargin
specifies the left margin of the numbering  
long
SymbolTextDistance
[ OPTIONAL ]
specifies the distance between the numbering symbol and the text of the paragraph.  
long
FirstLineOffset
specifies the offset between the beginning of the first line and the beginning of the following lines of the paragraph.  
short
NumberingType
specifies the type of numbering.  
string
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.  
::com::sun::star::util::Color
BulletColor
[ OPTIONAL ]
contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL.  
short
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.  
short
PositionAndSpaceMode
[ OPTIONAL ]
position and space mode  
short
LabelFollowedBy
[ OPTIONAL ]
character following the list label  
long
ListtabStopPosition
[ OPTIONAL ]
list tab position  
long
FirstLineIndent
[ OPTIONAL ]
additional line indent for the first text line  
long
IndentAt
[ OPTIONAL ]
indentation of the text lines  
Properties' Details
Adjust
short Adjust;
Description
adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

ParentNumbering
short ParentNumbering;
Usage Restrictions
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;
Usage Restrictions
optional
Description
Name of the character style that is used for the numbering symbol.
BulletId
short BulletId;
Usage Restrictions
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.
BulletFont
::com::sun::star::awt::FontDescriptor BulletFont;
Usage Restrictions
optional
Description
the font used to paint the bullet.
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.

GraphicBitmap
::com::sun::star::awt::XBitmap GraphicBitmap;
Usage Restrictions
optional
Description
the bitmap containing the bullet.
GraphicSize
::com::sun::star::awt::Size GraphicSize;
Usage Restrictions
optional
Description
size of the graphic that is used as bullet.
VertOrient
short VertOrient;
Usage Restrictions
optional
Description
contains the vertical orientation of a graphic.

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

StartWith
short StartWith;
Usage Restrictions
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;
Usage Restrictions
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
::com::sun::star::util::Color BulletColor;
Usage Restrictions
optional
Description
contains the color for the symbol. This is only valid if the numbering type is NumberingType::CHAR_SPECIAL.
BulletRelSize
short BulletRelSize;
Usage Restrictions
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.
PositionAndSpaceMode
short PositionAndSpaceMode;
Usage Restrictions
optional
Description
position and space mode

Specifies the position and space mode of the numbering level. For valid values see com::sun::star::text::PositionAndSpaceMode. If it equals LABEL_WIDTH_AND_POSITION, properties Adjust, LeftMargin, SymbolTextDistance and FirstLineOffset are used. If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy, ListtabStopPosition, FirstLineIndent, IndentAt are used.

Since
OOo 3.0
LabelFollowedBy
short LabelFollowedBy;
Usage Restrictions
optional
Description
character following the list label

Specifies the character following the list label. For valid values see com::sun::star::text::LabelFollow. Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.

Since
OOo 3.0
ListtabStopPosition
long ListtabStopPosition;
Usage Restrictions
optional
Description
list tab position

Specifies the position of the list tab stop - only non-negative values are allowed. Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT and LabelFollowedBy equal LABELFOLLOW_LISTTAB

Since
OOo 3.0
FirstLineIndent
long FirstLineIndent;
Usage Restrictions
optional
Description
additional line indent for the first text line

Specifies the first line indent. Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.

Since
OOo 3.0
IndentAt
long IndentAt;
Usage Restrictions
optional
Description
indentation of the text lines

Specifies the indent of the text lines Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.

Since
OOo 3.0

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.