Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: script :: provider ::
unpublished | interface XScriptContext |
Usage Restrictions not published Description This interface is provided to scripts, and provides a means of access to the various interfaces which they might need to perform some action on a document. It is required to be passed as the first argument for any Java scripts.

Methods' Summary
getDocument | Obtain the document reference on which the script can operate
getInvocationContext | provides access to the context where the script was invoked
getDesktop | Obtain the desktop reference on which the script can operate
getComponentContext | Obtain the component context which the script can use to create other uno components

Methods' Details
getDocument
::com::sun::star::frame::XModel
getDocument();
Description Obtain the document reference on which the script can operate Returns ::com::sun::star::frame::XModel interface
getInvocationContext
::com::sun::star::document::XScriptInvocationContext
getInvocationContext();
Description provides access to the context where the script was invoked In some cases, it is possible that scripts, embedded in a document, are executed from within a context which is not the document itself. In this case, the `getInvocationContext` member allows to access this context. Note that the returned context is allowed to be NULL, in this case, the document as returned by `getDocument` is the invocation context. If the returned context is not NULL, its `ScriptContainer` attribute equals the document as returned by `XScriptContext::getDocument`. Since OOo 3.0
getDesktop
::com::sun::star::frame::XDesktop
getDesktop();
Description Obtain the desktop reference on which the script can operate Returns ::com::sun::star::frame::XDesktop interface
getComponentContext
::com::sun::star::uno::XComponentContext
getComponentContext();
Description Obtain the component context which the script can use to create other uno components Returns ::com::sun::star::uno::XComponentContext interface

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.