Edit

Share via

Word.DocumentProtectOptions 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.

Provides configuration options for the Document.protect method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

enforceStyleLock

If provided, specifies whether to enforce style lock restrictions. The default value is false.
noReset

If provided, specifies whether to reset form fields when protecting the document. The default value is false.
password

If provided, specifies the password to apply for document protection. The default value is an empty string.
useInformationRightsManagement

If provided, specifies whether to use Information Rights Management (IRM). The default value is false.

Property Details

enforceStyleLock

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 whether to enforce style lock restrictions. The default value is false.

enforceStyleLock?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

noReset

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 whether to reset form fields when protecting the document. The default value is false.

noReset?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

password

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 password to apply for document protection. The default value is an empty string.

password?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

useInformationRightsManagement

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 whether to use Information Rights Management (IRM). The default value is false.

useInformationRightsManagement?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]