Edit

Share via

Excel.RequestContext class

  • Reference
Package:
excel

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
OfficeExtension.ClientRequestContext

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)

Constructs a new instance of the RequestContext class

Properties

application
runtime

[ API set: ExcelApi 1.5 ]
workbook

Constructor Details

(constructor)(url)

Constructs a new instance of the RequestContext class

constructor(url?: string | Session);

Parameters

url

string | Excel.Session

Property Details

application 

readonly application: Application;

Property Value

Excel.Application

runtime

[ API set: ExcelApi 1.5 ]

readonly runtime: Runtime;

Property Value

Excel.Runtime

workbook 

readonly workbook: Workbook;

Property Value

Excel.Workbook