Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XPropertySet

Base Interface
com::sun::star::uno::XInterface

Description
provides information about and access to the properties from an implementation.

There are three types of properties:

You can listen to changes of bound properties with the XPropertyChangeListener and you can veto changes of constrained properties with the XVetoableChangeListener .

To implement inaccurate name access, you must support the interface XExactName .

See also
com::sun::star::beans::XExactName


Known Services which Export this Interface

com::sun::star::beans::PropertyBag Implementation of this service can keep any properties and is useful when an XPropertySet is to be used, for example, as parameters for a method call.
com::sun::star::beans::PropertySet specifies an abstract service which gives some hints which interfaces belong to a proper property set implementation.
com::sun::star::lang::RegistryServiceManager provides a collection of and a registry for implementations for services.
com::sun::star::beans::PropertyBag Implementation of this service can keep any properties and is useful when an XPropertySet is to be used, for example, as parameters for a method call.
com::sun::star::beans::PropertySet specifies an abstract service which gives some hints which interfaces belong to a proper property set implementation.
com::sun::star::lang::RegistryServiceManager provides a collection of and a registry for implementations for services.
com::sun::star::chart::Chart3DBarProperties Specifies all the properties for the graphic object of a data point in a three-dimensional bar diagram.
com::sun::star::chart::ChartArea Specifies the area elements of a chart, e.g. the background area, the diagram wall, and the diagram floor of three-dimensional charts.
com::sun::star::chart::ChartAxis Specifies the axes in a diagram.
com::sun::star::chart::ChartDataPointProperties specifies all the properties for the graphic object of a data point (e.g., a single bar in a bar chart).
com::sun::star::chart::ChartDataRowProperties specifies the properties for a group of graphic elements which belong to a data row (also known as data series).
com::sun::star::chart::ChartDocument is the service for a chart document.
com::sun::star::chart::ChartGrid specifies the grid of the diagram in a chart.
com::sun::star::chart::ChartLine specifies line elements in a chart (regression lines, etc.).
com::sun::star::chart::ChartPieSegmentProperties specifies all the properties for the graphic object of a pie segment.
com::sun::star::chart::ChartStatistics offers statistical properties for the data in the chart. It is available for a single data row and for the whole diagram.
com::sun::star::chart::Diagram the base service for the diagram of the chart document.
com::sun::star::table::CellProperties contains the properties of a table cell.
com::sun::star::table::TableColumn represents a special cell range containing all cells of a single specific column in a table or spreadsheet.
com::sun::star::table::TableRow represents a special cell range containing all cells of a single specific row in a table or spreadsheet.
com::sun::star::util::SearchDescriptor describes what and how to search within a container.
com::sun::star::util::SortDescriptor specifies the properties which can be used to describe a sort order applied to an XSortable.
com::sun::star::util::NumberFormatSettings specifies the settings for number formatting.
com::sun::star::view::ViewSettings provides access to the settings of the controller of an office document.
com::sun::star::document::ExportFilter filter for exports.
com::sun::star::document::ImportFilter filter for imports.
com::sun::star::document::DocumentInfo This service provides document-specific information like the author, creation date and user fields.
com::sun::star::document::LinkTarget This service is implemented by objects inside a document object model that can be the target of a link inside a document
com::sun::star::form::FormComponent specifies a component which can be part of a form.
com::sun::star::presentation::Presentation This service is a presentation that is available from a PresentationDocument via the XPresentationSupplier interface.
com::sun::star::sdbc::PreparedStatement represents a precompiled SQL statement.
com::sun::star::sdbc::ResultSet provides access to a table of data. A ResultSet object is usually generated by executing a Statement.
com::sun::star::sdbc::Statement is used for executing a static SQL statement and obtaining the results produced by it.
com::sun::star::drawing::GenericDrawPage This abstract service is implemented by every page of a DrawingDocument .
com::sun::star::drawing::DrawingDocumentDrawView This view service is implemented by objects that can display DrawPage s or MasterPage s in drawing mode.
com::sun::star::drawing::Layer A layer is an entity inside a document which contains shapes.
com::sun::star::drawing::DrawingDocument specifies a document which consists of multiple pages with drawings.
com::sun::star::drawing::Shape This abstract service specifies the general characteristics of all Shape s.
com::sun::star::awt::UnoControlModel specifies the standard model of an UnoControl in the Smalltalk model view controller design .
com::sun::star::ucb::FileContentProvider The File Content Provider (FCP) implements a ContentProvider for the UniversalContentBroker (UCB).
com::sun::star::ucb::ContentResultSet provides access to the children of a folder content.
com::sun::star::sheet::CellAreaLink a linked cell range.
com::sun::star::sheet::Spreadsheet a 2-dimensional sheet of cells.
com::sun::star::sheet::DataPilotField a single field in a DataPilotDescriptor.
com::sun::star::sheet::DataPilotSource a data pilot source.
com::sun::star::sheet::GlobalSheetSettings the settings for all spreadsheets.
com::sun::star::sheet::TableAutoFormatField a single field in a TableAutoFormat.
com::sun::star::sheet::SheetFilterDescriptor a description of how a cell range is to be filtered.
com::sun::star::sheet::DataPilotSourceLevel a level in a data pilot source.
com::sun::star::sheet::TableValidation the validation settings for a cell or cell range.
com::sun::star::sheet::TableAutoFormat an autoformat for tables.
com::sun::star::sheet::SpreadsheetDocumentSettings keep the configuration which is global for all views of a spreadsheet document.
com::sun::star::sheet::SpreadsheetViewSettings settings which are specific to each view of a spreadsheet document.
com::sun::star::sheet::TablePageStyle a spreadsheet page format.
com::sun::star::sheet::SubTotalDescriptor This is a description of how subtotals are created.
com::sun::star::sheet::DataPilotSourceMember a field in a data pilot source.
com::sun::star::sheet::DataPilotSourceDimension a dimension in a data pilot source.
com::sun::star::sheet::DatabaseRange A database range is a name for a cell range that also stores filtering, sorting, subtotal and import settings and options.
com::sun::star::sheet::SheetLink A sheet link represents the source data of linked sheets.
com::sun::star::configuration::PropertyHierarchy provides access to and information about properties and subproperties of an implementation.
com::sun::star::sdbcx::Column describes the common properties of a database column.
com::sun::star::sdbcx::Descriptor is used to create a new object within a database.
com::sun::star::sdbcx::Group represents a group of users, which has certain access rights for the objects of the database.
com::sun::star::sdbcx::Index is used to specify the index for a database table. It refers to one or more columns of a table.
com::sun::star::sdbcx::Key is used to define a new key for a table.
com::sun::star::sdbcx::Table used to specify a table in a database. A table is described by its name and one or more columns.
com::sun::star::sdbcx::User represents a user of the database, who has certain access rights for the objects of the database.
com::sun::star::sdbcx::View is used to specify views on data. A view object is only used for creation and deletion. Inspecting the command of a view is normally not supported.
com::sun::star::image::ImageMapObject this is a base service for objects inside a image maps.
com::sun::star::linguistic2::LinguProperties the set of linguistic relevant properties.
com::sun::star::packages::PackageFolder The PackageFolder service represents a single folder or directory within a Package. Instances of this service can only be constructed by an implementation of the Package service and not via the service manager.
com::sun::star::packages::PackageStream This service represents a stream contained within a Package. Instances of this class can only be constructed by the implementation of the Package service.
com::sun::star::sdb::ColumnSettings describes the common properties of a database column.
com::sun::star::sdb::DataSource is a factory to establish database connections. It should be registered at a NamingService.
com::sun::star::sdb::DatabaseAccess specifies a component, which controls DatabaseAccessConnections and acts like a shared DataSource.
com::sun::star::sdb::DatabaseAccessDataSource is a factory to create data access beans. Data access beans are shared amoung components, so if an already existing bean is requested, the existing one is returned.
com::sun::star::sdb::DatabaseDocument specifies documents which belong to a database access bean.
com::sun::star::sdb::DatabaseEnvironment [ DEPRECATED ]
com::sun::star::sdb::DatasourceAdministrationDialog provides a user interface for administrating the system wide registered data sources.
com::sun::star::sdb::Document [ DEPRECATED ]
specifies documents which belong to a database source.
com::sun::star::sdb::ErrorMessageDialog provides a dialog for displaying database related exceptions.
com::sun::star::sdb::QueryDefinition is a stored definition of a SQL "Select statement".
com::sun::star::text::ViewSettings provides access to the settings of the controller of a text document.
com::sun::star::text::TextTableRow specifies the properties of a text table row.
com::sun::star::text::CellProperties service that holds all cell properties of a table cell in a text document.
com::sun::star::text::TextSection A TextSection is a range of complete paragraphs within a text. @
com::sun::star::text::Paragraph is a piece of text which can take its own paragraph-specific attributes (technically, properties).
com::sun::star::text::TextField A TextField is a TextContent which fades its textual representation into the text range to which it is anchored.
com::sun::star::text::NumberingRules provides access to the numbering rules.
com::sun::star::text::TextFieldMaster A TextFieldMaster specifies important data for its DependentTextField s.
com::sun::star::text::AdvancedTextDocument [ DEPRECATED ]
An advanced text document is an extension of a hypertext document which can also contain text-frames, foot- and endnotes, and some other advanced contents.
com::sun::star::text::TextCursor A TextCursor is a TextRange which can be moved within a Text object.
com::sun::star::text::BaseFrame specifies the base service of text frames, graphic objects, and embedded objects
com::sun::star::text::Defaults provides default settings of a text document for paragraph and character properties.
com::sun::star::text::TextDocument A text document is a model component which contains text structured by paragraphs.
com::sun::star::text::TextRange points to a sequence of characters within a Text .
com::sun::star::text::TextTableCursor specifies a cursor in text tables.
com::sun::star::frame::DesktopTask specifies a separate task within a desktop environment.
com::sun::star::frame::FrameControl contains a frame with a desktop component.
com::sun::star::frame::SynchronousFrameLoader Derivations of this abstract service are used to load components into Frame s of the environment.
com::sun::star::frame::Desktop is the environment for components which can instantiate within frames.

Methods' Summary

getPropertySetInfo
setPropertyValue sets the value of the property with the specified name.
getPropertyValue
addPropertyChangeListener adds an XPropertyChangeListener to the specified property.
removePropertyChangeListener removes an XPropertyChangeListener from the listener list.
addVetoableChangeListener adds an XVetoableChangeListener to the specified property with the name PropertyName.
removeVetoableChangeListener removes an XVetoableChangeListener from the listener list.

Methods' Details

getPropertySetInfo
 
com::sun::star::beans::XPropertySetInfo
getPropertySetInfo();
Returns
the XPropertySetInfo interface, which describes all properties of the object which supplies this interface.
Returns
NULL if the implementation cannot or will not provide information about the properties; otherwise the interface XPropertySetInfo is returned.
setPropertyValue
 
void
setPropertyValue(
[ in ] string aPropertyName,
[ in ] any aValue )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException );

Description
sets the value of the property with the specified name.

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.

@raises 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.
getPropertyValue
 
any
getPropertyValue(
[ in ] string PropertyName )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Returns
the value of the property with the specified name.
Parameter PropertyName
This parameter specifies the name of the property.
Throws
UnknownPropertyException if the property 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 WrappedTargetException .
addPropertyChangeListener
 
void
addPropertyChangeListener(
[ in ] string aPropertyName,
[ in ] com::sun::star::beans::XPropertyChangeListener xListener )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Description
adds an XPropertyChangeListener to the specified property.

An empty name ("") registers the listener to all bound properties. If the property is not bound, the behavior is not specified.

See also
removePropertyChangeListener
removePropertyChangeListener
 
void
removePropertyChangeListener(
[ in ] string aPropertyName,
[ in ] com::sun::star::beans::XPropertyChangeListener aListener )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Description
removes an XPropertyChangeListener from the listener list.

It is a "noop" if the listener is not registered.

See also
addPropertyChangeListener
addVetoableChangeListener
 
void
addVetoableChangeListener(
[ in ] string PropertyName,
[ in ] com::sun::star::beans::XVetoableChangeListener aListener )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Description
adds an XVetoableChangeListener to the specified property with the name PropertyName.

An empty name ("") registers the listener to all constrained properties. If the property is not constrained, the behavior is not specified.

See also
removeVetoableChangeListener
removeVetoableChangeListener
 
void
removeVetoableChangeListener(
[ in ] string PropertyName,
[ in ] com::sun::star::beans::XVetoableChangeListener aListener )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Description
removes an XVetoableChangeListener from the listener list.

It is a "noop" if the listener is not registered.

See also
addVetoableChangeListener

Top of Page