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 :: form :: binding ::

unpublished interface XValueBinding
Usage Restrictions
not published
Description
specifies a binding to a value which can be read and written.
Developers Guide
Forms - Value Bindings

Methods' Summary
getSupportedValueTypes determines the types which are supported by this binding for value exchange  
supportsType determines whether a given type is supported by this binding for value exchange  
getValue retrieves the current value  
setValue sets the current value  
Methods' Details
getSupportedValueTypes
sequence< type >
getSupportedValueTypes();

Description
determines the types which are supported by this binding for value exchange
See also
supportsType
supportsType
boolean
supportsType( [in] type  aType );

Description
determines whether a given type is supported by this binding for value exchange

Calling this method is equal to calling getSupportedValueTypes, and looking up the given type in the resulting type sequence.

See also
getSupportedValueTypes
getValue
any
getValue( [in] type  aType )
raises( IncompatibleTypesException );

Description
retrieves the current value
Throws
IncompatibleTypesException if the requested value type is not supported by the binding
See also
getSupportedValueTypes, supportsType
setValue
void
setValue( [in] any  aValue )
raises( IncompatibleTypesException,
InvalidBindingStateException,
::com::sun::star::lang::NoSupportException );

Description
sets the current value
Throws
IncompatibleTypesException if the given value type is not supported by the binding
Throws
InvalidBindingStateException if the value currently cannot be changed, since the binding is not fully operational. Possible reasons for this include the binding being readonly, or the target of the binding not being present.
Throws
::com::sun::star::lang::NoSupportException if the binding in general does not support write access to it's binding
See also
getSupportedValueTypes, supportsType, ValueBinding
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.