Word.EditorCollection class
Represents the editors in a protected (read-only) Word document.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
Methods
| add |
Returns an |
| add |
Returns an |
| add |
Returns an |
| get |
Returns the number of items in the collection. |
| get |
Gets an |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
Method Details
addById(editorId)
Returns an Editor object that represents a new permission for the specified user to modify a range within the document.
addById(editorId: string): Word.Editor;Parameters
- editorId
-
string
The user's email alias (if in the same domain) or an email address.
Returns
Remarks
addByType(editorType)
Returns an Editor object that represents a new permission for the specified group of users to modify a range within the document.
addByType(editorType: Word.EditorType): Word.Editor;Parameters
- editorType
- Word.EditorType
An EditorType that represents a group of users.
Returns
Remarks
addByType(editorType)
Returns an Editor object that represents a new permission for the specified group of users to modify a range within the document.
addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor;Parameters
- editorType
-
"Current" | "Editors" | "Everyone" | "Owners"
An EditorType that represents a group of users.
Returns
Remarks
getCount()
Returns the number of items in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getItemAt(index)
Gets an Editor object by its index in the collection.
getItemAt(index: number): Word.Editor;Parameters
- index
-
number
The index of the item to retrieve.
Returns
Remarks
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.EditorCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.EditorCollection;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.EditorCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.EditorCollectionData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): {
[key: string]: string;
};Returns
{ [key: string]: string; }
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.EditorCollection;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.EditorCollection;