:: com :: sun :: star :: script :: provider ::

interface XScriptContext

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