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

interface XCommonEmbedPersist
Description
specifies common implementation for embedded objects and links persistence.

Methods' Summary
storeOwn lets the object or the link store itself.  
isReadonly allows to detect if the data store is read-only.  
reload lets the object or the link reload itself.  
Methods' Details
storeOwn
void
storeOwn()
raises( WrongStateException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
lets the object or the link store itself.
Throws
com::sun::star::embed::WrongStateException the object is in wrong state
Throws
com::sun::star::io::IOException in case of io problems during saving
Throws
com::sun::star::uno::Exception in case of other problems
isReadonly
boolean
isReadonly()
raises( WrongStateException );

Description
allows to detect if the data store is read-only.
Returns
true if the data store is readonly or opened readonly false otherwise
Throws
com::sun::star::embed::WrongStateException the object is in wrong state ( has no entry )
reload
void
reload( [in] sequence< ::com::sun::star::beans::PropertyValue >  aMediaArgs,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
WrongStateException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
lets the object or the link reload itself.

If the object has persistance it will be reloaded from it's persistant entry.

Parameter aMediaArgs
optional parameters for document reloading, see also ::com::sun::star::document::MediaDescriptor
Parameter aObjectArgs
optional parameters for object reloading, see also EmbeddedObjectDescriptor @thrown ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
Throws
com::sun::star::embed::WrongStateException the object is in wrong state
Throws
com::sun::star::io::IOException in case of io problems during opening\creation
Throws
com::sun::star::uno::Exception in case of other problems
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.