Content for OpenOffice.org version 3.3.
:: 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
- Description
- Obtain the document reference on which the script can operate
- Returns
- ::com::sun::star::frame::XModel interface
|
|
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
- Description
- Obtain the desktop reference on which the script can operate
- Returns
- ::com::sun::star::frame::XDesktop interface
|
|
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 © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
