Edit

Share via

Word.CoauthoringLockAddOptions interface

Package:
word

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.

Specifies the options for adding to a Word.CoauthoringLockCollection object.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

range

If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point.
type

If provided, specifies the type of lock. If not provided, the lock type is set to reservation.

Property Details

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.

If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point.

range?: Word.Range;

Property Value

Word.Range

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

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.

If provided, specifies the type of lock. If not provided, the lock type is set to reservation.

type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed";

Property Value

Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]