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 BaseIndex

Description specifies the basic service of different indexes within a document. See also DocumentIndex, ContentIndex, UserDefinedIndex, com::sun::star::text::IllustrationIndex, TableIndex, ObjectIndex Developers Guide Text - Indexes and Index Marks

---

Exported Interfaces - Summary
XDocumentIndex	(referenced entity's summary:) This is the main interface for a document index.

Properties' Summary
string Title	contains the title of the index.
boolean IsProtected	determins if the index is protected.
string ParaStyleHeading	contains the name of the paragraph style that is applied to the heading.
string ParaStyleLevel1	contains the name of the paragraph style that is applied to the 1st level.
string ParaStyleLevel2	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 2nd level.
string ParaStyleLevel3	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 3rd level.
string ParaStyleLevel4	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 4th level.
string ParaStyleLevel5	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 5th level.
string ParaStyleLevel6	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 6th level.
string ParaStyleLevel7	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 7th level.
string ParaStyleLevel8	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 8th level.
string ParaStyleLevel9	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 9th level.
string ParaStyleLevel10	[ OPTIONAL ] contains the name of the paragraph style that is applied to the 10th level.
string ParaStyleSeparator	[ OPTIONAL ] contains the name of the paragraph style that is applied to the separator level.
XTextColumns TextColumns	contains the column interface.
string BackGraphicURL	contains the URL of a graphic file that is displayed as background graphic
string BackGraphicFilter	contains the name of the filter of the graphic file that is displayed as background graphic
::com::sun::star::style::GraphicLocation BackGraphicLocation	determines the position of the background graphic.
::com::sun::star::util::Color BackColor	specifies the color of the background.
boolean BackTransparent	If true, the background color value in "BackColor" is not visible.
::com::sun::star::container::XIndexReplace LevelFormat	[ OPTIONAL ] returns the interface of the level format of the index.
boolean CreateFromChapter	[ OPTIONAL ] determins if the content of the document index is created from the complete document content or from the current chapter only.
XTextSection ContentSection	the text section containing the content of the index
XTextSection HeaderSection	the text section containing the header of the index

Exported Interfaces - Details

XDocumentIndex (referenced entity's summary:) This is the main interface for a document 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; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 2nd level.

ParaStyleLevel3 string ParaStyleLevel3; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 3rd level.

ParaStyleLevel4 string ParaStyleLevel4; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 4th level.

ParaStyleLevel5 string ParaStyleLevel5; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 5th level.

ParaStyleLevel6 string ParaStyleLevel6; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 6th level.

ParaStyleLevel7 string ParaStyleLevel7; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 7th level.

ParaStyleLevel8 string ParaStyleLevel8; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 8th level.

ParaStyleLevel9 string ParaStyleLevel9; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 9th level.

ParaStyleLevel10 string ParaStyleLevel10; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the 10th level.

ParaStyleSeparator string ParaStyleSeparator; Usage Restrictions optional Description contains the name of the paragraph style that is applied to the separator level.

TextColumns 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

BackColor ::com::sun::star::util::Color BackColor; Description specifies the color of the background.

BackTransparent boolean BackTransparent; Description If true, the background color value in "BackColor" is not visible.

LevelFormat ::com::sun::star::container::XIndexReplace LevelFormat; Usage Restrictions 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; Usage Restrictions 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 XTextSection ContentSection; Description the text section containing the content of the index

HeaderSection XTextSection HeaderSection; Description the text section containing the header of the 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.