Edit

Share via


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.

Extends

Remarks

Examples

TypeScript
// *.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)

Constructs a new instance of the RequestContext class

Properties

Constructor Details

(constructor)(url)

Constructs a new instance of the RequestContext class

TypeScript
constructor(url?: string | Session);

Parameters

url

string | Excel.Session

Property Details

application

TypeScript
readonly application: Application;

Property Value

runtime

[ API set: ExcelApi 1.5 ]

TypeScript
readonly runtime: Runtime;

Property Value

workbook

TypeScript
readonly workbook: Workbook;

Property Value