interface XComponentLoader in module com::sun::star::frame::

(Global Index)

Syntax

interface XComponentLoader : com::sun::star::uno::XInterface ;

Description

This is a simple interface to load components by an URL into a frame environment.

See also

Desktop

See also

Frame

See also

XFrame

Method Summary

loadComponentFromURL loads a component specified by an URL into the specified new or existing frame.

Known Services Which Export this Interface

com::sun::star::frame::Desktop

Method Details



loadComponentFromURL

Syntax

com::sun::star::lang::XComponent loadComponentFromURL (
string aURL,
string aTargetFrameName,
long nSearchFlags,
sequence< com::sun::star::beans::PropertyValue > aArgs )
raises ( com::sun::star::io::IOException , com::sun::star::lang::IllegalArgumentException );

Description

loads a component specified by an URL into the specified new or existing frame.

Parameter aURL

specifies the URL of the document to load. To create new documents, use "private:factory/scalc", "private:factory/swriter", etc.

Parameter aTargetFrameName

specifies the name of the frame to view the document in. If a frame with the specified name already exists, it is used, otherwise it is created. "_blank" always creates a new frame, "_self" means frame himself, "_parent" address direct parent of frame, "_top" indicates top frame of current path in tree.

Parameter nSearchFlags

use the values of FrameSearchFlag to specify how to find the specified aTargetFrameName . Normally, simply use 0 .

Parameter aArgs

these arguments specify component or filter specific behavior. For example, "ReadOnly" with a boolean value specifies whether the document is opened read-only. "FilterName" specifies the component type to create and the filter to use, for example: "scalc: Text - csv". For more information see MediaDescriptor .
Top of Page