Excel.RequestContext class
The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
Remarks
Examples
// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await Excel.run(async (context: Excel.RequestContext) => {
const workbook = context.workbook;
// Interact with the Excel workbook...
});
Constructors
(constructor)(url, invocation) | Constructs a new instance of the |
Properties
application | |
runtime | |
workbook |
Methods
set |
Constructor Details
(constructor)(url, invocation)
Constructs a new instance of the RequestContext
class
constructor(url?: string | Session, invocation?: {
invocationId: number;
isInCFSyncScenario: boolean;
});
Parameters
- url
-
string | Excel.Session
- invocation
-
{ invocationId: number; isInCFSyncScenario: boolean; }
Property Details
application
runtime
workbook
Method Details
setInvocation(invocation)
setInvocation(invocation: {
invocationId: number;
isInCFSyncScenario: boolean;
}): void;
Parameters
- invocation
-
{ invocationId: number; isInCFSyncScenario: boolean; }
Returns
void