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 :: frame ::

interface XStorable
Description
offers a simple way to store a component to an URL.

It is usually only useful for two cases:

  1. Large components which are wrapped up in UNO interfaces and for which distinct filters are not available separately as components.
  2. Very small components for which only one or very few hard coded file format filters make sense or even exist.
Developers Guide
Drawings - Storing
OfficeDev - Storing Documents
Spreadsheets - Saving Spreadsheet Documents - Storing
Text - Saving Text Documents - Storing

Methods' Summary
hasLocation The object may know the location because it was loaded from there, or because it is stored there.  
getLocation After XStorable::storeAsURL() it returns the URL the object was stored to.  
isReadonly It is not possible to call XStorable::store() successfully when the data store is read-only.  
store stores the data to the URL from which it was loaded.  
storeAsURL stores the object's persistent data to a URL and makes this URL the new location of the object.  
storeToURL stores the object's persistent data to a URL and continues to be a representation of the old URL.  
Methods' Details
hasLocation
boolean
hasLocation();

Description
The object may know the location because it was loaded from there, or because it is stored there.
Returns
true if the object knows a location where it is persistent false otherwise
getLocation
string
getLocation();

Description
After XStorable::storeAsURL() it returns the URL the object was stored to.
Returns
the URL of the resource which is represented by this object.
isReadonly
boolean
isReadonly();

Description
It is not possible to call XStorable::store() successfully when the data store is read-only.
Returns
true if the data store is readonly or opened readonly false otherwise
store
void
store()
raises( ::com::sun::star::io::IOException );

Description
stores the data to the URL from which it was loaded.

Only objects which know their locations can be stored.

Throws
com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown)
See also
XStorable::storeAsURL, XStorable::storeToURL
storeAsURL
void
storeAsURL( [in] string  sURL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  lArguments )
raises( ::com::sun::star::io::IOException );

Description
stores the object's persistent data to a URL and makes this URL the new location of the object.

This is the normal behavior for UI's "save-as" feature.

The change of the location makes it necessary to store the document in a format that the object can load. For this reason the implementation of XStorable::storeAsURL() will throw an exception if a pure export filter is used, it will accept only combined import/export filters. For such filters the method XStorable::storeToURL() must be used that does not change the location of the object.

Parameter sURL
specifies the new location of this component
Parameter lArguments
optional parameters for saving (see ::com::sun::star::document::MediaDescriptor for further details)
Throws
com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown)
See also
XStorable::store, XStorable::storeToURL, ::com::sun::star::document::MediaDescriptor
storeToURL
void
storeToURL( [in] string  sURL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  lArguments )
raises( ::com::sun::star::io::IOException );

Description
stores the object's persistent data to a URL and continues to be a representation of the old URL.

This is the normal behavior for UI's export feature.

This method accepts all kinds of export filters, not only combined import/export filters because it implements an exporting capability, not a persistence capability.

Throws
com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown)
Parameter lArguments
optional parameters for saving (see ::com::sun::star::document::MediaDescriptor for further details)
See also
XStorable::store, XStorable::storeAsURL, ::com::sun::star::document::MediaDescriptor
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.