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

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

service UserDefinedIndex

Description
specifies service of user defined indexes within a document.
See also
com::sun::star::text::BaseIndex


Included Services

com::sun::star::text::BaseIndex
Description
specifies the basic service of different indexes within a document.

Properties' Summary

LevelParagraphStyles [ OPTIONAL ]
contains the interface to access the paragraph style names that are included in this index.
CreateFromMarks [ OPTIONAL ]
determins if the document index marks are included in this index.
UseLevelFromSource [ OPTIONAL ]
determins if the outline level of the location of the indexed object is used as index level of the index entry.
CreateFromTables [ OPTIONAL ]
determins if tables are included in the index.
CreateFromTextFrames [ OPTIONAL ]
determins if text frames are included in the index.
CreateFromGraphicObjects [ OPTIONAL ]
determins if graphic objects are included in the index.
CreateFromEmbeddedObjects [ OPTIONAL ]
determins if embedded objects are included in the index.
DocumentIndexMarks contains all index marks that are related to this index.

Properties' Details

LevelParagraphStyles
 
com::sun::star::container::XIndexReplace LevelParagraphStyles;
[ OPTIONAL ]
Description
contains the interface to access the paragraph style names that are included in this index.
See also
DocumentIndexParagraphStyles
CreateFromMarks
 
boolean CreateFromMarks;
[ OPTIONAL ]
Description
determins if the document index marks are included in this index.
UseLevelFromSource
 
boolean UseLevelFromSource;
[ OPTIONAL ]
Description
determins if the outline level of the location of the indexed object is used as index level of the index entry.
CreateFromTables
 
boolean CreateFromTables;
[ OPTIONAL ]
Description
determins if tables are included in the index.
CreateFromTextFrames
 
boolean CreateFromTextFrames;
[ OPTIONAL ]
Description
determins if text frames are included in the index.
CreateFromGraphicObjects
 
boolean CreateFromGraphicObjects;
[ OPTIONAL ]
Description
determins if graphic objects are included in the index.
CreateFromEmbeddedObjects
 
boolean CreateFromEmbeddedObjects;
[ OPTIONAL ]
Description
determins if embedded objects are included in the index.
DocumentIndexMarks
 
[ readonly ] sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks;
Description
contains all index marks that are related to this index.

Top of Page