Word.Interfaces.CoauthoringLockCollectionLoadOptions interface
Represents a collection of coauthoring locks in a Word document.
Remarks
This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a GeneralException error.
Used by
Properties
| $all | Specifying |
| owner | For EACH ITEM in the collection: Gets the owner of the lock. |
| range | For EACH ITEM in the collection: Gets a |
| type | For EACH ITEM in the collection: Gets a |
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
owner
For EACH ITEM in the collection: Gets the owner of the lock.
owner?: Word.Interfaces.CoauthorLoadOptions;Property Value
Remarks
range
For EACH ITEM in the collection: Gets a Range object that represents the portion of the document that's contained in the CoauthoringLock object.
range?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
type
For EACH ITEM in the collection: Gets a CoauthoringLockType value that represents the lock type.
type?: boolean;Property Value
boolean