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 XEmbedObjectCreator
Description
allows to create and initialize a new embedded object.

This interface contains methods that can help to create and initialize an embedded object.


Methods' Summary
createInstanceInitNew creates a new object and initializes it as a new one.  
createInstanceInitFromEntry creates a new object that should be based on specified storage entry.  
createInstanceInitFromMediaDescriptor creates a new object and initializes it based on ::com::sun::star::document::MediaDescriptor.  
Methods' Details
createInstanceInitNew
::com::sun::star::uno::XInterface
createInstanceInitNew( [in] sequence< byte >  aClassID,
[in] string  sClassName,
[in] 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 );

Description
creates a new object and initializes it as a new one.

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

Parameter aClassID
the class id of the new object
Parameter sClassName
the class name of the new object
Parameter xStorage
a parent storage the entry should be created/opened in
Parameter sEntryName
a name for the entry
Parameter aObjectArgs
optional parameters for the object persistence initialization see also EmbeddedObjectDescriptor
Throws
::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
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
createInstanceInitFromEntry
::com::sun::star::uno::XInterface
createInstanceInitFromEntry( [in] XStorage  xStorage,
[in] string  sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aMediaDescriptor,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
creates a new object that should be based on specified storage entry.

The specified entry must exists and the object should be loaded from the entry. In case a persistent representation of a link is specified, the result object will be a link.

Parameter xStorage
a parent storage the entry should be opened in
Parameter sEntryName
a name for the entry
Parameter aMediaDescriptor
an object of type ::com::sun::star::document::MediaDescriptor that specifies document related properties; please remember that target related parameters, for example URL, will be ignored since the object should be loaded from storage entry
Parameter aObjectArgs
an object of type EmbeddedObjectDescriptor contains object related properties @thrown ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal @thrown ::com::sun::star::container::NoSuchElementException the specified entry does not exist
Throws
com::sun::star::io::IOException in case of io problems during opening
Throws
com::sun::star::uno::Exception in case of other problems
createInstanceInitFromMediaDescriptor
::com::sun::star::uno::XInterface
createInstanceInitFromMediaDescriptor( [in] XStorage  xStorage,
[in] string  sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aMediaDescriptor,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
creates a new object and initializes it based on ::com::sun::star::document::MediaDescriptor.

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

Parameter xStorage
a parent storage the entry should be created/opened in
Parameter sEntryName
a name for the entry
Parameter aMediaDescriptor
an object of type ::com::sun::star::document::MediaDescriptor that specifies source
Parameter aObjectArgs
an object of type EmbeddedObjectDescriptor contains object related properties @thrown ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
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.