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 » document

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: document ::

deprecated interface XDocumentInfo

Usage Restrictions deprecated Deprecation Info Use XDocumentProperties instead. Description provides access to the user fields for the information regarding the document These fields are special one of the set of available document properties. Other ones are accessed as properties (by using the interface ::com::sun::star::beans::XPropertySet) of service DocumentInfo. See also DocumentInfo, StandaloneDocumentInfo, ::com::sun::star::beans::XPropertySet

---

Methods' Summary
getUserFieldCount	provides information about count of available fields
getUserFieldName	returns the name of an user field
getUserFieldValue	returns the value of an user field
setUserFieldName	changes the name of one of the user fields
setUserFieldValue	changes the value of one of the user fields

Methods' Details

getUserFieldCount short getUserFieldCount(); Description provides information about count of available fields This count marks the top range of possible requests for get/set any of these fields. Range = [0..count-1] Returns current count

getUserFieldName string getUserFieldName( [in] short  Index ) raises( ::com::sun::star::lang::ArrayIndexOutOfBoundsException ); Description returns the name of an user field Parameter Index specifies the position of requested field Range = [0..count-1] Returns the name of the requested field Throws com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]

getUserFieldValue string getUserFieldValue( [in] short  Index ) raises( ::com::sun::star::lang::ArrayIndexOutOfBoundsException ); Description returns the value of an user field Parameter Index specifies the position of requested field Range = [0..count-1] Returns the value of the requested field Throws com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]

setUserFieldName void setUserFieldName( [in] short  Index, [in] string  Name ) raises( ::com::sun::star::lang::ArrayIndexOutOfBoundsException ); Description changes the name of one of the user fields Parameter Index specifies the position of requested field Range = [0..count-1] Parameter Name the new name for this field to be set Throws com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]

setUserFieldValue void setUserFieldValue( [in] short  Index, [in] string  Value ) raises( ::com::sun::star::lang::ArrayIndexOutOfBoundsException ); Description changes the value of one of the user fields Parameter Index specifies the position of requested field Range = [0..count-1] Parameter Value the new value for this field to be set Throws com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]

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.