Edit

Share via

Word.Interfaces.CoauthorCollectionLoadOptions interface

Package:
word

Contains a collection of Word.Coauthor objects.

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).
emailAddress

For EACH ITEM in the collection: Gets the email address of the coauthor.
id

For EACH ITEM in the collection: Gets the unique identifier for the Coauthor object.
isMe

For EACH ITEM in the collection: Gets whether this author represents the current user.
name

For EACH ITEM in the collection: Gets the display name of the coauthor.

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

emailAddress

For EACH ITEM in the collection: Gets the email address of the coauthor.

emailAddress?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

id

For EACH ITEM in the collection: Gets the unique identifier for the Coauthor object.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isMe

For EACH ITEM in the collection: Gets whether this author represents the current user.

isMe?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

name

For EACH ITEM in the collection: Gets the display name of the coauthor.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]