The Free and Open Productivity Suite
QA Volunteers Needed -- Help us test OpenOffice

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for Apache OpenOffice version 3.4.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: embed ::

interface XEmbedObjectFactory
Description
allows to create and initialize a new embedded object of specified type.

This interface provides user with full control over object creation.

Methods' Summary
createInstanceUserInit creates a new object and transport parameters for persistent initialization.  
Methods' Details
createInstanceUserInit
::com::sun::star::uno::XInterface
createInstanceUserInit( [in] sequence< byte >  aClassID,
[in] string  sClassName,
[in] XStorage  xStorage,
[in] string  sEntName,
[in] long  nEntryConnectionMode,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aArgs,
[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 transport parameters for persistent initialization.

This method can be used to have a full control over persistence initialization of a object.

If the service implementation does not support XEmbedObjectCreator interface, it must accept the empty aClassID parameter in case of loading from existing entry.

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 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 aArgs
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::io::IOException in case of io problems during opening\creation
Throws
com::sun::star::uno::Exception in case of other problems
Top of Page

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.

Apache Feather

Copyright & License | Privacy | Contact Us | Donate

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.