Edit

Share via

Word.Interfaces.EditorData interface

Package:
word

An interface describing the data returned by calling editor.toJSON().

Properties

id

Gets the identifier for the Editor object when the parent document is saved as a webpage.
name

Gets the name of the editor.
nextRange

Gets a Range object that represents the next range that the editor has permissions to modify.
range

Gets a Range object that represents the portion of the document that's contained in the Editor object.

Property Details

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the identifier for the Editor object when the parent document is saved as a webpage.

id?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

name

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the name of the editor.

name?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nextRange

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a Range object that represents the next range that the editor has permissions to modify.

nextRange?: Word.Interfaces.RangeData;

Property Value

Word.Interfaces.RangeData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a Range object that represents the portion of the document that's contained in the Editor object.

range?: Word.Interfaces.RangeData;

Property Value

Word.Interfaces.RangeData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]