(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

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

service UserDefinedIndex
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.  
[ readonly ] sequence< XDocumentIndexMark >
DocumentIndexMarks		 contains all index marks that are related to this 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.
DocumentIndexMarks
[ readonly ] sequence< XDocumentIndexMark > DocumentIndexMarks;
Description
contains all index marks that are related to this index.

 Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.