WriteProtection.Recommended Property

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Recommend Write Protection in User Interface

Represents the following attribute in the schema: w:recommended

public DocumentFormat.OpenXml.OnOffValue? Recommended { get; set; }

member this.Recommended : DocumentFormat.OpenXml.OnOffValue with get, set

Public Property Recommended As OnOffValue

Property Value

OnOffValue

Returns EnumValue<T>.

Remarks

The following information from the ECMA International Standard ECMA-376 can be useful when working with this class.

Specifies that applications should provide user interface recommending that the user open this document in write protected state. If the user chooses to do so, the document shall be write protected, otherwise, it shall be opened fully editable.

If this attribute is omitted, then user interface recommending that the user open this document in write protected state should not be provided. If the password attribute is also specified, then this setting shall be ignored.

Consider a WordprocessingML document which specifies that applications shall recommend write protection to this document. This requirement would be specified using the following WordprocessingML in the document settings:

<w:writeProtection w:recommended="true" />  

The recommended attribute has a value of true specifying that the applications shall hash any password provided, and if it matches this hash value, may only then halt enforcement of write protection.

The possible values for this attribute are defined by the ST_OnOff simple type.