LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
NumberingLevel Service Referencepublished

These properties describe the numbering of a paragraph. More...

import"NumberingLevel.idl";

Inheritance diagram for NumberingLevel:
NumberingRule ChapterNumberingRule

Public Attributes

short NumberingType
 specifies the type of numbering. More...
 
short ParentNumbering
 specifies the number of higher numbering levels that are included in the representation of the current number. More...
 
string Prefix
 This prefix is inserted in front of the numbering symbol(s). More...
 
string Suffix
 This suffix is inserted after the numbering symbol(s). More...
 
string CharStyleName
 This is the name of the character style that is used for the symbol(s). More...
 
short BulletId
 The bullet symbol with this code in the assigned font is used. More...
 
string BulletFontName
 This is the name of the font that is used for the bullet. More...
 
string GraphicURL
 This is the URL of a graphic file to use as a symbol. More...
 
short StartWith
 This specifies the start value for the numbering. More...
 
com::sun::star::awt::XBitmap GraphicBitmap
 This is the graphic bitmap to use as a symbol. More...
 
string ListFormat
 Format string used to generate actual numbering. More...
 
boolean IsLegal
 Specifies if this level should use Arabic numbers for all levels. More...
 

Detailed Description

These properties describe the numbering of a paragraph.

NumberType determines the type of the numbering symbol. Depending on this setting, some of the following values will be ignored.

Member Data Documentation

◆ BulletFontName

string BulletFontName
property

This is the name of the font that is used for the bullet.

◆ BulletId

short BulletId
property

The bullet symbol with this code in the assigned font is used.

◆ CharStyleName

string CharStyleName
property

This is the name of the character style that is used for the symbol(s).

◆ GraphicBitmap

com::sun::star::awt::XBitmap GraphicBitmap
optionalproperty

This is the graphic bitmap to use as a symbol.

Since
LibreOffice 6.1

◆ GraphicURL

string GraphicURL
property

This is the URL of a graphic file to use as a symbol.

Deprecated:
as of LibreOffice 6.1, use Graphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the GraphicBitmap property.

◆ IsLegal

boolean IsLegal
optionalproperty

Specifies if this level should use Arabic numbers for all levels.

Since
LibreOffice 24.2

◆ ListFormat

string ListFormat
optionalproperty

Format string used to generate actual numbering.

It contains placeholders (like %1%, %2%, etc) where corresponding level numberings are inserted.

This is more flexible way to provide multilevel numbering with complex format string. This property is a replacement for Prefix and Suffix: if ListFormat is provided, they are not used anymore.

Example: ListFormat "(%1% %2%.%3%)" can be resolved to numbering in actual multilevel list like "(4 1.3)".

Since
LibreOffice 7.2

◆ NumberingType

short NumberingType
property

specifies the type of numbering.

See also
NumberingType

◆ ParentNumbering

short ParentNumbering
property

specifies the number of higher numbering levels that are included in the representation of the current number.

◆ Prefix

string Prefix
property

This prefix is inserted in front of the numbering symbol(s).

Deprecated:
as of LibreOffice 7.2, use ListFormat instead

◆ StartWith

short StartWith
property

This specifies the start value for the numbering.

◆ Suffix

string Suffix
property

This suffix is inserted after the numbering symbol(s).

Deprecated:
as of LibreOffice 7.2, use ListFormat instead

The documentation for this service was generated from the following file: