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

service EmbeddedObjectDescriptor
Description
describes properties of an embedded object

This service may be represented by a ::com::sun::star::beans::PropertyValue[]. Such descriptors will be passed to different functions, included into possible load/save proccesses. Every member of such process can use this descriptor and may change it to actualize the informations about the object. So this descriptor should be used as an in/out parameter.

See also
::com::sun::star::beans::PropertyValue

Properties' Summary
boolean
StoreVisualReplacement
[ OPTIONAL ]
lets the graphical representation of embedded document be stored.  
::com::sun::star::frame::XDispatchProviderInterceptor
OutplaceDispatchInterceptor
[ OPTIONAL ]
allows to provide a dispatch interceptor for outplace activation.  
XStorage
RecoveryStorage
[ OPTIONAL ]
denotes the storage from which the embedded object is to be recovered.  
Properties' Details
StoreVisualReplacement
boolean StoreVisualReplacement;
Usage Restrictions
optional
Description
lets the graphical representation of embedded document be stored.

Setting of this property to true tells the embedded object that controlls the document to store or not to store the graphical representation of the document in to the object persistence. If this property is not set the object makes the decision itself.

OutplaceDispatchInterceptor
::com::sun::star::frame::XDispatchProviderInterceptor OutplaceDispatchInterceptor;
Usage Restrictions
optional
Description
allows to provide a dispatch interceptor for outplace activation.
RecoveryStorage
XStorage RecoveryStorage;
Usage Restrictions
optional
Description
denotes the storage from which the embedded object is to be recovered.

Upon activating the embedded object, it is normally loaded from a storage as denoted by the parameters to the XEmbedObjectCreator method calls.

You can pass a non-NULL RecoveryStorage in the object descriptor if you wish to load the embedded object from an alternate storage.

The object will still be based on the storage denoted in the XEmbedObjectCreator method call, i.e., subsequent save operations will still use that storage. RecoveryStorage is used at loading time only, and then discarded.


 
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.