Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » text

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 © 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.

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.