:: ooo :: vba ::

interface XDocumentProperties
Base Interfaces
XDocumentPropertiesXCollectionXHelperInterface
   ┃ ┗ ::com::sun::star::lang::XServiceInfo
   ┣ ::com::sun::star::script::XDefaultMethod
   ┗ ::com::sun::star::container::XEnumerationAccess
      ┗ ::com::sun::star::container::XElementAccess

XCollection

Methods' Summary
Add Creates a new custom document property. * You can only add a new document property to the custom DocumentProperties collection. Depending on value of * boolean LinkSource, either (False) Value or (True) LinkSource must be provided. *  
Methods' Details
Add
XDocumentProperty
Add( [in] string  Name,
[in] boolean  LinkToContent,
[in] byte  Type,
[in] any  Value,
[in] any  LinkSource )
raises( ::com::sun::star::script::BasicErrorException );

Description
Creates a new custom document property. * You can only add a new document property to the custom DocumentProperties collection. Depending on value of * boolean LinkSource, either (False) Value or (True) LinkSource must be provided. *
Parameter Name
(Required String. The name of the property. *
Parameter LinkToContent
Specifies whether the property is linked to the contents of the container document. If this argument is True, the LinkSource argument is required; if it's False, the value argument is required. *
Parameter Type
The data type of the property. Can be one of the following MsoDocProperties constants: * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber, or msoPropertyTypeString. *
Parameter Value
The value of the property, if it's not linked to the contents of the container document. * The value is converted to match the data type specified by the type argument, if it can't be converted, an error occurs. * If LinkToContent is True, the Value argument is ignored and the new document property is assigned a default value * until the linked property values are updated by the container application (usually when the document is saved). *
Parameter LinkSource
Ignored if LinkToContent is False. The source of the linked property. The container application determines * what types of source linking you can use.
Top of Page