<html>
<head>
<title>Interface XPropertySet</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XPropertySet-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">beans</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XPropertySet</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides information about and access to the
properties from an implementation.
</dd>
<dd><p>There are three types of properties: </p>
<ul>
<li>bound properties </li>
<li>constrained properties </li>
<li>free properties </li>
</ul>
<p>You can listen to changes of bound properties with the
<a href="XPropertyChangeListener.html">XPropertyChangeListener</a> and you can veto changes
of constrained properties with the <a href="XVetoableChangeListener.html">XVetoableChangeListener</a>. </p>
<p>To implement inaccurate name access, you must support the
interface <a href="XExactName.html">XExactName</a>. </p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XExactName.html">XExactName</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/FirstSteps/Using_Services#Using_Properties">FirstSteps - Using Services - Using Properties</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Properties">ProUNO - Properties</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPropertySetInfo">getPropertySetInfo</a></td>
<td class="imsum_right"> </td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPropertyValue">setPropertyValue</a></td>
<td class="imsum_right">sets the value of the property with the specified name.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPropertyValue">getPropertyValue</a></td>
<td class="imsum_right"> </td>
</tr>
<tr>
<td class="imsum_left"><a href="#addPropertyChangeListener">addPropertyChangeListener</a></td>
<td class="imsum_right">adds an <a href="XPropertyChangeListener.html">XPropertyChangeListener</a> to the specified property.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removePropertyChangeListener">removePropertyChangeListener</a></td>
<td class="imsum_right">removes an <a href="XPropertyChangeListener.html">XPropertyChangeListener</a> from
the listener list.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addVetoableChangeListener">addVetoableChangeListener</a></td>
<td class="imsum_right">adds an <a href="XVetoableChangeListener.html">XVetoableChangeListener</a> to the specified
property with the name PropertyName.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeVetoableChangeListener">removeVetoableChangeListener</a></td>
<td class="imsum_right">removes an <a href="XVetoableChangeListener.html">XVetoableChangeListener</a> from the
listener list.
</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getPropertySetInfo" class="membertitle">getPropertySetInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XPropertySetInfo.html">XPropertySetInfo</a></td>
</tr>
<tr>
<td valign="top"><b>getPropertySetInfo</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the <a href="XPropertySetInfo.html">XPropertySetInfo</a> interface, which
describes all properties of the object which supplies this
interface.
</dd>
<dt><b>Returns</b></dt>
<dd><b>NULL</b> if the implementation cannot or will
not provide information about the properties; otherwise the
interface <a href="XPropertySetInfo.html">XPropertySetInfo</a> is returned.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPropertyValue" class="membertitle">setPropertyValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setPropertyValue</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aPropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom"> aValue )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
<a href="PropertyVetoException.html">PropertyVetoException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sets the value of the property with the specified name.
</dd>
<dd><p>If it is a bound property the value will be changed before
the change event is fired. If it is a constrained property
a vetoable event is fired before the property value can be
changed. </p>
</dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::beans::PropertyVetoException
if the property is read-only or vetoable
and one of the listeners throws this exception
because of an unaccepted new value.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPropertyValue" class="membertitle">getPropertyValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">any</td>
</tr>
<tr>
<td valign="top"><b>getPropertyValue</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> PropertyName )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the value of the property with the specified name.
</dd>
<dt><b>Parameter PropertyName</b></dt>
<dd>This parameter specifies the name of the property.
</dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException
if the property does not exist.
</dd>
<dt><b>Throws</b></dt>
<dd>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::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addPropertyChangeListener" class="membertitle">addPropertyChangeListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>addPropertyChangeListener</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aPropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPropertyChangeListener.html">XPropertyChangeListener</a></td>
<td valign="bottom"> xListener )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds an <a href="XPropertyChangeListener.html">XPropertyChangeListener</a> to the specified property.
</dd>
<dd><p>An empty name ("") registers the listener to all bound
properties. If the property is not bound, the behavior is
not specified. </p>
<p>It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
</dd>
<dt><b>See also</b></dt>
<dd><a href="#removePropertyChangeListener">removePropertyChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removePropertyChangeListener" class="membertitle">removePropertyChangeListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>removePropertyChangeListener</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> aPropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPropertyChangeListener.html">XPropertyChangeListener</a></td>
<td valign="bottom"> aListener )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes an <a href="XPropertyChangeListener.html">XPropertyChangeListener</a> from
the listener list.
</dd>
<dd><p>It is a "noop" if the listener is not registered. </p>
<p>It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
</dd>
<dt><b>See also</b></dt>
<dd><a href="#addPropertyChangeListener">addPropertyChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addVetoableChangeListener" class="membertitle">addVetoableChangeListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>addVetoableChangeListener</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> PropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XVetoableChangeListener.html">XVetoableChangeListener</a></td>
<td valign="bottom"> aListener )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds an <a href="XVetoableChangeListener.html">XVetoableChangeListener</a> to the specified
property with the name PropertyName.
</dd>
<dd><p>An empty name ("") registers the listener to all
constrained properties. If the property is not constrained,
the behavior is not specified. </p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="#removeVetoableChangeListener">removeVetoableChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeVetoableChangeListener" class="membertitle">removeVetoableChangeListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>removeVetoableChangeListener</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> PropertyName,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XVetoableChangeListener.html">XVetoableChangeListener</a></td>
<td valign="bottom"> aListener )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes an <a href="XVetoableChangeListener.html">XVetoableChangeListener</a> from the
listener list.
</dd>
<dd><p>It is a "noop" if the listener is not registered. </p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="#addVetoableChangeListener">addVetoableChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1434
