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

(Global Index)

Syntax

service BaseIndex;

Description

specifies the basic service of different indexes within a document.

See also

DocumentIndex

See also

ContentIndex

See also

UserDefinedIndex

See also

IllustrationsIndex

See also

TableIndex

See also

ObjectIndex

Exported Interfaces

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

Description

This is the main interface for a document index.


Property Summary

Title contains the title of the index.

IsProtected determins if the index is protected.

ParaStyleHeading contains the name of the paragraph style that is applied to the heading.

ParaStyleLevel1 contains the name of the paragraph style that is applied to the 1st level.

ParaStyleLevel2 contains the name of the paragraph style that is applied to the 2nd level.

ParaStyleLevel3 contains the name of the paragraph style that is applied to the 3rd level.

ParaStyleLevel4 contains the name of the paragraph style that is applied to the 4th level.

ParaStyleLevel5 contains the name of the paragraph style that is applied to the 5th level.

ParaStyleLevel6 contains the name of the paragraph style that is applied to the 6th level.

ParaStyleLevel7 contains the name of the paragraph style that is applied to the 7th level.

ParaStyleLevel8 contains the name of the paragraph style that is applied to the 8th level.

ParaStyleLevel9 contains the name of the paragraph style that is applied to the 9th level.

ParaStyleLevel10 contains the name of the paragraph style that is applied to the 10th level.

ParaStyleSeparator contains the name of the paragraph style that is applied to the separator level.

TextColumns contains the column interface.

BackGraphicURL contains the URL of a graphic file that is displayed as background graphic

BackGraphicFilter contains the name of the filter of the graphic file that is displayed as background graphic

BackGraphicLocation determines the position of the background graphic.

BackTransparent specifies the color of the background. [property] long BackColor; / ** If true , the background color value in "BackColor" is not visible.

LevelFormat returns the interface of the level format of the index.

CreateFromChapter determins if the content of the document index is created from the complete document content or from the current chapter only.

ContentSection the text section containing the content of the index

HeaderSection the text section containing the header of the index

Property Details



Title

Syntax

string Title;

Description

contains the title of the index.


IsProtected

Syntax

boolean IsProtected;

Description

determins if the index is protected.


ParaStyleHeading

Syntax

string ParaStyleHeading;

Description

contains the name of the paragraph style that is applied to the heading.


ParaStyleLevel1

Syntax

string ParaStyleLevel1;

Description

contains the name of the paragraph style that is applied to the 1st level.


ParaStyleLevel2 [ O P T I O N A L ]

Syntax

string ParaStyleLevel2;

Description

contains the name of the paragraph style that is applied to the 2nd level.


ParaStyleLevel3 [ O P T I O N A L ]

Syntax

string ParaStyleLevel3;

Description

contains the name of the paragraph style that is applied to the 3rd level.


ParaStyleLevel4 [ O P T I O N A L ]

Syntax

string ParaStyleLevel4;

Description

contains the name of the paragraph style that is applied to the 4th level.


ParaStyleLevel5 [ O P T I O N A L ]

Syntax

string ParaStyleLevel5;

Description

contains the name of the paragraph style that is applied to the 5th level.


ParaStyleLevel6 [ O P T I O N A L ]

Syntax

string ParaStyleLevel6;

Description

contains the name of the paragraph style that is applied to the 6th level.


ParaStyleLevel7 [ O P T I O N A L ]

Syntax

string ParaStyleLevel7;

Description

contains the name of the paragraph style that is applied to the 7th level.


ParaStyleLevel8 [ O P T I O N A L ]

Syntax

string ParaStyleLevel8;

Description

contains the name of the paragraph style that is applied to the 8th level.


ParaStyleLevel9 [ O P T I O N A L ]

Syntax

string ParaStyleLevel9;

Description

contains the name of the paragraph style that is applied to the 9th level.


ParaStyleLevel10 [ O P T I O N A L ]

Syntax

string ParaStyleLevel10;

Description

contains the name of the paragraph style that is applied to the 10th level.


ParaStyleSeparator [ O P T I O N A L ]

Syntax

string ParaStyleSeparator;

Description

contains the name of the paragraph style that is applied to the separator level.


TextColumns

Syntax

com::sun::star::text::XTextColumns TextColumns;

Description

contains the column interface.


BackGraphicURL

Syntax

string BackGraphicURL;

Description

contains the URL of a graphic file that is displayed as background graphic


BackGraphicFilter

Syntax

string BackGraphicFilter;

Description

contains the name of the filter of the graphic file that is displayed as background graphic


BackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation BackGraphicLocation;

Description

determines the position of the background graphic.

See also

GraphicLocation

BackTransparent

Syntax

boolean BackTransparent;

Description

specifies the color of the background. [property] long BackColor; / ** If true , the background color value in "BackColor" is not visible.


LevelFormat [ O P T I O N A L ]

Syntax

com::sun::star::container::XIndexReplace LevelFormat;

Description

returns the interface of the level format of the index.

The description of the format of the levels depends on the type of the document index.

See also

DocumentIndexLevelFormat

CreateFromChapter [ O P T I O N A L ]

Syntax

boolean CreateFromChapter;

Description

determins if the content of the document index is created from the complete document content or from the current chapter only.

It is not available in the bibliography


ContentSection

Syntax

com::sun::star::text::XTextSection ContentSection;

Description

the text section containing the content of the index


HeaderSection

Syntax

com::sun::star::text::XTextSection HeaderSection;

Description

the text section containing the header of the index

Top of Page