Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: beans ::
interface XMultiPropertyStates
Description makes it possible to query information about the state of one or more properties. The state of a property contains information about the source of the value, e.g. the object itself, a default or a stylesheet. For more information see PropertyState.

Methods' Summary
getPropertyStates |
setAllPropertiesToDefault | sets all properties to their default values.
setPropertiesToDefault | sets the specified properties to their default values.
getPropertyDefaults |

Methods' Details
getPropertyStates
sequence< PropertyState >
getPropertyStates( | [in] sequence< string > | aPropertyName )
raises( | 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 aPropertyName specifies the names of the properties. All names must be unique. This sequence must be alphabetically sorted.
setAllPropertiesToDefault
void
setAllPropertiesToDefault();
Description sets all properties to their default values. Each 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.
setPropertiesToDefault
void
setPropertiesToDefault( | [in] sequence< string > | aPropertyNames )
raises( | UnknownPropertyException );
Description sets the specified properties to their default values. Each 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 names of the properties. All names must be unique. This sequence must be alphabetically sorted. Throws UnknownPropertyException if one of the properties does not exist.
getPropertyDefaults
sequence< any >
getPropertyDefaults( | [in] sequence< string > | aPropertyNames )
raises( | UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException );
Returns the default values of the propertes with the specified names. If no default exists, is not known, or is void, then the return type at the corresponding position in the sequence returned is `void`. Parameter aPropertyName specifies the names of the properties. All names must be unique. This sequence must be alphabetically sorted. Throws UnknownPropertyException if one of the propertes 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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.