Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: reflection ::

interface XIdlField2
Base Interfaces
XIdlField2XIdlMember

XIdlMember
(referenced interface's summary:)
Base interface for XIdlField2s and XIdlMethods.
Description
Reflects an IDL interface attribute, enum or compound type (i.e. struct/exception) member.

Methods' Summary
getType Returns the type of the field.  
getAccessMode Returns the access mode of the field, i.e. read-write, read-only or write-only (access mode "const" is deprecated).  
get Gets the value of the reflected field from the given object, i.e. an interface, enum or compound type (struct/exception). For enums, the given object is ignored; the returned value reflects the constant enum 32-bit value.  
set Sets the value of the reflected field of the given object, i.e. an interface or compound type (struct/exception).  
Methods' Details
getType
XIdlClass
getType();

Description
Returns the type of the field.
Returns
type of the field
getAccessMode
FieldAccessMode
getAccessMode();

Description
Returns the access mode of the field, i.e. read-write, read-only or write-only (access mode "const" is deprecated).
Returns
access mode of the field
get
any
get( [in] any  obj )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Gets the value of the reflected field from the given object, i.e. an interface, enum or compound type (struct/exception). For enums, the given object is ignored; the returned value reflects the constant enum 32-bit value.

When setting an interface attribute raises a non-::com::sun::star::uno::RuntimeException, it is wrapped in a ::com::sun::star::lang::WrappedTargetRuntimeException.

Parameter obj
object instance having member of reflected type
Returns
value of field
Throws
IllegalAccessException An ::com::sun::star::lang::IllegalAccessException is thrown if the given object is no interface, enum or compound type; or the given object does not have the reflected field.
set
void
set( [inout] any  obj,
[in] any  value )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::IllegalAccessException );

Description
Sets the value of the reflected field of the given object, i.e. an interface or compound type (struct/exception).

When setting an interface attribute raises a non-::com::sun::star::uno::RuntimeException, it is wrapped in a ::com::sun::star::lang::WrappedTargetRuntimeException.

Parameter obj
object instance having member of reflected type
Parameter value
value to be set
Throws
IllegalAccessException An ::com::sun::star::lang::IllegalAccessException is thrown if the given object is no interface or compound type; or the given object does not have the reflected field.
Top of Page

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.