Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: beans ::

interface XPropertyContainer
Description
makes it possible to add and remove properties to or from an object.

Some scripting engines cannot access properties directly when the property set is changed. Please use XPropertySet::getPropertyValue etc. in this case.

Developers Guide
UCB - Services and Interfaces

Methods' Summary
addProperty adds a property to the object.  
removeProperty removes a property from the object.  
Methods' Details
addProperty
void
addProperty( [in] string  Name,
[in] short  Attributes,
[in] any  DefaultValue )
raises( PropertyExistException,
IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );

Description
adds a property to the object.
Parameter aName
specifies the name of the new property.
Parameter Attributes
specifies the property attributes, see PropertyAttribute.
Parameter DefaultValue
specifies the type of the new property and a potential default value.
Throws
PropertyExistException if a property with the same name already exists.
Throws
IllegalTypeException if the specified type is not allowed.
removeProperty
void
removeProperty( [in] string  Name )
raises( UnknownPropertyException,
NotRemoveableException );

Description
removes a property from the object.
Parameter aName
specified the name of the property.
Throws
UnknownPropertyException if the property does not exist.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.