Edit

Share via

Word.Interfaces.CoauthoringLoadOptions interface

Package:
word

Represents the Coauthoring object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring.

Remarks

[ API set: WordApiDesktop 1.4 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
canCoauthor

Gets whether this document can be coauthored.
canMerge

Gets whether the document can be automatically merged.
me

Gets a Coauthor object that represents the current user.
pendingUpdates

Gets whether the document has pending updates that have not been accepted.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

canCoauthor

Gets whether this document can be coauthored.

canCoauthor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

canMerge

Gets whether the document can be automatically merged.

canMerge?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

me

Gets a Coauthor object that represents the current user.

me?: Word.Interfaces.CoauthorLoadOptions;

Property Value

Word.Interfaces.CoauthorLoadOptions

Remarks

[ API set: WordApiDesktop 1.4 ]

pendingUpdates

Gets whether the document has pending updates that have not been accepted.

pendingUpdates?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]