Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XPropertyWithState
Description
makes it possible to query information about the state of this object, seen as a property contained in a property set.

This interface provides direct access to operations that are available if the containing property set implements XPropertyState.

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 being used
  • or if the value cannot be determined, due to ambiguity (multi selection with multiple values).

Generally objects that implement this interface also implement XProperty.

Methods' Summary
getStateAsProperty  
setToDefaultAsProperty sets this to its default value.  
getDefaultAsProperty  
Methods' Details
getStateAsProperty
PropertyState
getStateAsProperty();
Returns
the state of this as a property.
setToDefaultAsProperty
void
setToDefaultAsProperty()
raises( ::com::sun::star::lang::WrappedTargetException );
Description
sets this to its default value.

The value depends on the implementation of this interface. If this is a bound property, the value changes before the change events are fired. If this is a constrained property, the vetoable event is fired before the property value changes.

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.
getDefaultAsProperty
::com::sun::star::uno::XInterface
getDefaultAsProperty()
raises( ::com::sun::star::lang::WrappedTargetException );
Returns
an object representing the default state of this object (as a property).

If no default exists, is not known or is void, then the return value is NULL.

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 © 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.

Apache Software Foundation

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.