Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

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

service UserIndex
Description
specifies service of user defined indexes within a document.
See also
BaseIndex
Included Services - Summary
BaseIndex
(referenced entity's summary:)
specifies the basic service of different indexes within a document.
Properties' Summary
::com::sun::star::container::XIndexReplace
LevelParagraphStyles		 [ OPTIONAL ]
contains the interface to access the paragraph style names that are included in this index.  
boolean
CreateFromMarks		 [ OPTIONAL ]
determins if the document index marks are included in this index.  
boolean
UseLevelFromSource		 [ OPTIONAL ]
determins if the outline level of the location of the indexed object is used as index level of the index entry. 
boolean
CreateFromTables		 [ OPTIONAL ]
determins if tables are included in the index.  
boolean
CreateFromTextFrames		 [ OPTIONAL ]
determins if text frames are included in the index.  
boolean
CreateFromGraphicObjects		 [ OPTIONAL ]
determins if graphic objects are included in the index.  
boolean
CreateFromEmbeddedObjects		 [ OPTIONAL ]
determins if embedded objects are included in the index.  
string
UserIndexName		 contains the name of the user index.  
Included Services - Details
BaseIndex
(referenced entity's summary:)
specifies the basic service of different indexes within a document.
Properties' Details
LevelParagraphStyles
::com::sun::star::container::XIndexReplace LevelParagraphStyles;
Usage Restrictions
optional
Description
contains the interface to access the paragraph style names that are included in this index.
See also
DocumentIndexParagraphStyles
CreateFromMarks
boolean CreateFromMarks;
Usage Restrictions
optional
Description
determins if the document index marks are included in this index.
UseLevelFromSource
boolean UseLevelFromSource;
Usage Restrictions
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;
Usage Restrictions
optional
Description
determins if tables are included in the index.
CreateFromTextFrames
boolean CreateFromTextFrames;
Usage Restrictions
optional
Description
determins if text frames are included in the index.
CreateFromGraphicObjects
boolean CreateFromGraphicObjects;
Usage Restrictions
optional
Description
determins if graphic objects are included in the index.
CreateFromEmbeddedObjects
boolean CreateFromEmbeddedObjects;
Usage Restrictions
optional
Description
determins if embedded objects are included in the index.
UserIndexName
string UserIndexName;
Description
contains the name of the user index.

 Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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