Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: beans ::
interface XPropertyState
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XPropertyState
Description makes it possible to query information about the state of one or more properties. The state contains the information if: a value is available or void the value is stored in the object itself, or if a default value is to be used and if the value cannot be determined, due to ambiguity (multi selection with multiple values). Developers Guide 13.4.1 Forms - Form Components - Basics - Control Models 3.3.4 Professional UNO - UNO Concepts - Properties

Methods' Summary
getPropertyState |
getPropertyStates |
setPropertyToDefault | Sets the property to default value.
getPropertyDefault |

Methods' Details
getPropertyState
PropertyState getPropertyState( | [in] string raises( | PropertyName ) UnknownPropertyException );
Returns the state of the property. Parameter aPropertyName specifies the name of the property. Throws UnknownPropertyException if the property does not exist.
getPropertyStates
sequence< PropertyState > getPropertyStates( | [in] sequence< string > raises( | aPropertyName ) UnknownPropertyException );
Returns a sequence of the states of the properties which are specified by their names. The order of the states is correlating to the order of the given property names. Parameter aPropertyNames contains the sequence of property names. Throws UnknownPropertyException if one property does not exist.
setPropertyToDefault
void setPropertyToDefault( | [in] string raises( | PropertyName ) UnknownPropertyException );
Description Sets the property to default value. The value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value. Parameter aPropertyname specifies the name of the property. Throws UnknownPropertyException if the property does not exist.
getPropertyDefault
any getPropertyDefault( | [in] string raises( | aPropertyName ) UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException );
Returns the default value of the property with the name PropertyName. If no default exists, is not known or is void, then the return type is`void` . Parameter aPropertyName specifies the name of the property. Throws UnknownPropertyException if the property does not exist. Throws com::sun::star::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that ::com::sun::star::lang::WrappedTargetException .

Top of Page

Copyright © 2003 Sun Microsystems, Inc.