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

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

service BaseIndex

Description
specifies the basic service of different indexes within a document.
See also
com::sun::star::text::DocumentIndex
See also
com::sun::star::text::ContentIndex
See also
com::sun::star::text::UserDefinedIndex
See also
com::sun::star::text::IllustrationsIndex
See also
com::sun::star::text::TableIndex
See also
com::sun::star::text::ObjectIndex


Exported Interfaces

com::sun::star::text::XDocumentIndex
Description
This is the main interface for a document index.

Properties' 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 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 2nd level.
ParaStyleLevel3 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 3rd level.
ParaStyleLevel4 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 4th level.
ParaStyleLevel5 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 5th level.
ParaStyleLevel6 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 6th level.
ParaStyleLevel7 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 7th level.
ParaStyleLevel8 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 8th level.
ParaStyleLevel9 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 9th level.
ParaStyleLevel10 [ OPTIONAL ]
contains the name of the paragraph style that is applied to the 10th level.
ParaStyleSeparator [ OPTIONAL ]
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 [ OPTIONAL ]
returns the interface of the level format of the index.
CreateFromChapter [ OPTIONAL ]
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

Properties' Details

Title
 
string Title;
Description
contains the title of the index.
IsProtected
 
boolean IsProtected;
Description
determins if the index is protected.
ParaStyleHeading
 
string ParaStyleHeading;
Description
contains the name of the paragraph style that is applied to the heading.
ParaStyleLevel1
 
string ParaStyleLevel1;
Description
contains the name of the paragraph style that is applied to the 1st level.
ParaStyleLevel2
 
string ParaStyleLevel2;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 2nd level.
ParaStyleLevel3
 
string ParaStyleLevel3;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 3rd level.
ParaStyleLevel4
 
string ParaStyleLevel4;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 4th level.
ParaStyleLevel5
 
string ParaStyleLevel5;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 5th level.
ParaStyleLevel6
 
string ParaStyleLevel6;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 6th level.
ParaStyleLevel7
 
string ParaStyleLevel7;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 7th level.
ParaStyleLevel8
 
string ParaStyleLevel8;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 8th level.
ParaStyleLevel9
 
string ParaStyleLevel9;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 9th level.
ParaStyleLevel10
 
string ParaStyleLevel10;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the 10th level.
ParaStyleSeparator
 
string ParaStyleSeparator;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is applied to the separator level.
TextColumns
 
com::sun::star::text::XTextColumns TextColumns;
Description
contains the column interface.
BackGraphicURL
 
string BackGraphicURL;
Description
contains the URL of a graphic file that is displayed as background graphic
BackGraphicFilter
 
string BackGraphicFilter;
Description
contains the name of the filter of the graphic file that is displayed as background graphic
BackGraphicLocation
 
com::sun::star::style::GraphicLocation BackGraphicLocation;
Description
determines the position of the background graphic.
See also
GraphicLocation
BackTransparent
 
boolean BackTransparent;
Description
specifies the color of the background. [property] long BackColor; / ** If true , the background color value in "BackColor" is not visible.
LevelFormat
 
com::sun::star::container::XIndexReplace LevelFormat;
[ OPTIONAL ]
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
 
boolean CreateFromChapter;
[ OPTIONAL ]
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
 
com::sun::star::text::XTextSection ContentSection;
Description
the text section containing the content of the index
HeaderSection
 
com::sun::star::text::XTextSection HeaderSection;
Description
the text section containing the header of the index

Top of Page