LibreOffice
LibreOffice 24.2 SDK API Reference
|
this is a simple interface to load components by a URL into a frame environment More...
import"XComponentLoader.idl";
Public Member Functions | |
com::sun::star::lang::XComponent | loadComponentFromURL ([in] string URL, [in] string TargetFrameName, [in] long SearchFlags, [in] sequence< com::sun::star::beans::PropertyValue > Arguments) raises ( com::sun::star::io::IOException, com::sun::star::lang::IllegalArgumentException ) |
loads a component specified by a URL into the specified new or existing frame. 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... | |
this is a simple interface to load components by a URL into a frame environment
com::sun::star::lang::XComponent loadComponentFromURL | ( | [in] string | URL, |
[in] string | TargetFrameName, | ||
[in] long | SearchFlags, | ||
[in] sequence< com::sun::star::beans::PropertyValue > | Arguments | ||
) | |||
raises | ( | com::sun::star::io::IOException, | |
com::sun::star::lang::IllegalArgumentException | |||
) |
loads a component specified by a URL into the specified new or existing frame.
URL | specifies the URL of the document to load |
To create new documents, use "private:factory/scalc", "private:factory/swriter", etc. Other special protocols (e.g. "slot:", ".uno") are not allowed and raise a com::sun::star::lang::IllegalArgumentException.
TargetFrameName | 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. There exist some special targets which never can be used as real frame names:
"_blank" | always creates a new frame |
"_default" | special UI functionality (e.g. detecting of already loaded documents, using of empty frames of creating of new top frames as fallback) |
"_self", ""(!) | means frame himself |
"_parent" | address direct parent of frame |
"_top" | indicates top frame of current path in tree |
"_beamer" | means special sub frame |
SearchFlags | use the values of FrameSearchFlag to specify how to find the specified TargetFrameName |
Note: These flags are optional ones and will be used for non special target names only.
Arguments | 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: "Text - CSV". For more information see com::sun::star::document::MediaDescriptor.
NULL
if it failedThis interface is a generic one and can be used to start further requests on loaded document or control the lifetime of it (means dispose() it after using). The real document service behind this interface can be one of follow three ones:
com::sun::star::io::IOException | when URL couldn't be found or was corrupt |
com::sun::star::lang::IllegalArgumentException | when given parameters doesn't perform the specification |