LibreOffice LibreOffice 25.8 SDK API Reference

Public Attributes | List of all members
EmbeddedObjectDescriptor Service Referencepublished

describes properties of an embedded object More...

`import"EmbeddedObjectDescriptor.idl";`

## Public Attributes
boolean | StoreVisualReplacement
| lets the graphical representation of embedded document be stored. More...
::com::sun::star::frame::XDispatchProviderInterceptor | OutplaceDispatchInterceptor
| allows to provide a dispatch interceptor for outplace activation. More...
XStorage | RecoveryStorage
| denotes the storage from which the embedded object is to be recovered. More...

## Detailed Description

describes properties of an embedded object

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

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

## Member Data Documentation

## ◆ OutplaceDispatchInterceptor

::com::sun::star::frame::XDispatchProviderInterceptor OutplaceDispatchInterceptor
| optional property

allows to provide a dispatch interceptor for outplace activation.

## ◆ RecoveryStorage

XStorage RecoveryStorage
| optional property

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.

## ◆ StoreVisualReplacement

boolean StoreVisualReplacement
| optional property

lets the graphical representation of embedded document be stored.

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

The documentation for this service was generated from the following file:

- com/sun/star/embed/EmbeddedObjectDescriptor.idl