LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XEmbedObjectClipboardCreator Interface Referencepublished

allows to create and initialize a new embedded object from clipboard. More...

import"XEmbedObjectClipboardCreator.idl";

Inheritance diagram for XEmbedObjectClipboardCreator:
XInterface MSOLEObjectSystemCreator

Public Member Functions

InsertedObjectInfo createInstanceInitFromClipboard ([in]::com::sun::star::embed::XStorage xStorage, [in] string sEntryName, [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs) raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::uno::Exception )
 creates a new object and initializes it from the system clipboard. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

allows to create and initialize a new embedded object from clipboard.

This interface contains methods that can help to create and initialize an embedded object based on system clipboard.

Member Function Documentation

InsertedObjectInfo createInstanceInitFromClipboard ( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] string  sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue aObjectArgs 
)
raises ( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception
)

creates a new object and initializes it from the system clipboard.

In case specified entry exists it's contents are ignored and will be overwritten on storing.

The clipboard can provide a number of choices that are container related. This information will be returned in the InsertedObjectInfo object.

Parameters
xStoragea parent storage the entry should be created/opened in
sEntryNamea name for the entry
aObjectArgsoptional parameters for the object persistence initialization see also EmbeddedObjectDescriptor
Returns
the structure containing the object and container related options
Exceptions
com::sun::star::lang::IllegalArgumentExceptionone of arguments is illegal
com::sun::star::io::IOExceptionin case of io problems during opening or creation
com::sun::star::uno::Exceptionin case of other problems

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