Methods' Details |
setPersistentEntry
- Description
- provides object with a parent storage and a name for object's entry.
An entry with the specified name should be created/opened inside
provided storage. It can be a storage or a stream. For example,
OOo API will refer to ole storages only by streams, but the object
implementation will use storage based on this stream.
Factory does this call to initialize the embedded object.
The linked object can be initialized by factory in different way
( internally ).
It is also possible to switch object persistent representation through
this call. Actually this is the way, this call can be used by user
( since initialization is done by factory ).
- Parameter xStorage
- a parent storage the entry should be created in
- Parameter sEntName
- a name for the entry
- Parameter nEntryConnectionMode
- a mode in which the object should be initialized from entry
can take values from EntryInitModes constant set
- Parameter aMediaArgs
- optional parameters for the embedded document persistence
initialization, see also
::com::sun::star::document::MediaDescriptor
- Parameter aObjectArgs
- optional parameters for the object persistence initialization,
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
|
|
storeToEntry
- Description
- lets the object store itself to an entry in destination storage,
the own persistence entry is not changed.
- Parameter xStorage
- a parent storage the entry should be created inside
- Parameter sEntName
- a name for the entry
- Parameter aMediaArgs
- optional parameters for document saving, see also
::com::sun::star::document::MediaDescriptor
- Parameter aObjectArgs
- optional parameters for the object saving, 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 storing
- Throws
- com::sun::star::uno::Exception
in case of other problems
|
|
storeAsEntry
- Description
- lets the object store itself to an entry in destination storage and
prepare to use the new entry for own persistence.
The object should be stored to the new entry, after that the entry
should be remembered by the object. After the storing process is
finished the XEmbedPersist::saveCompleted method
can be used to specify whether the object should use the new entry or
the old one. The object persistence can not be used until
XEmbedPersist::saveCompleted is called.
So this state can be treated as "HandsOff" state.
- Parameter xStorage
- a parent storage the entry should be created in
- Parameter sEntName
- a name for the entry
- Parameter aMediaArgs
- optional parameters for document saving, see also
::com::sun::star::document::MediaDescriptor
- Parameter aObjectArgs
- optional parameters for the object saving, 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 storing
- Throws
- com::sun::star::uno::Exception
in case of other problems
|
|
saveCompleted
- Description
- specifies whether the object should use an old storage or a new one
after "save as" operation.
- Parameter bUseNew
- true the new storage should be used
false the old one
- Throws
- com::sun::star::embed::WrongStateException
the object is in wrong state
- Throws
- com::sun::star::uno::Exception
in case of other problems
|
|
hasEntry
- Description
- allows to detect if the object has entry.
- Returns
- true if the object has own entry set
false otherwise
|
|
getEntryName
- Description
- allows to retrieve the current object entry name.
- Returns
- the object entry name if any
- Throws
- com::sun::star::embed::WrongStateException
the object is in wrong state ( has no entry )
|
|
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.