Edit

Share via

Word.RequestContext class

  • Reference
Package:
word

The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word 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 Word.run(async (context: Word.RequestContext) => {
  const document = context.document;
  // Interact with the Word document...
});

Constructors

(constructor)(url)

Constructs a new instance of the RequestContext class

Properties

application

[ API set: WordApi 1.3 ] *
document

Constructor Details

(constructor)(url)

Constructs a new instance of the RequestContext class

constructor(url?: string);

Parameters

url

string

Property Details

application

[ API set: WordApi 1.3 ] *

readonly application: Application;

Property Value

Word.Application

document 

readonly document: Document;

Property Value

Word.Document