SheetProtection class
TOC
Collapse the table of content
Expand the table of content

SheetProtection class

Office 2013 and later

Sheet Protection. When the object is serialized out as xml, its qualified name is x:sheetProtection.

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class SheetProtection : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

sheetProtection (Sheet Protection Options)

This collection expresses the sheet protection options to enforce when the sheet is protected.

[Example:

This example demonstrates that the sheet is protected, objects and scenarios can be edited, cell formatting is allowed,and selection of locked cells is not allowed:

<sheetProtection sheet="1" objects="1" scenarios="1" formatCells="0"  selectLockedCells="1"/>

end example]

Parent Elements

dialogsheet (§18.3.1.34); worksheet (§18.3.1.99)

Attributes

Description

algorithmName (Cryptographic Algorithm Name)

Specifies the specific cryptographic hashing algorithm which shall be used along with the salt attribute and input password in order to compute the hash value.

The following values are reserved:

Value

Algorithm

MD2

Specifies that the MD2 algorithm, as defined by RFC 1319, shall be used.

[Note: It is recommended that applications should avoid using this algorithm to store new hash values, due to publically known breaks. end note]

MD4

Specifies that the MD4 algorithm, as defined by RFC 1320, shall be used.

[Note: It is recommended that applications should avoid using this algorithm to store new hash values, due to publically known breaks. end note]

MD5

Specifies that the MD5 algorithm, as defined by RFC 1321, shall be used.

[Note: It is recommended that applications should avoid using this algorithm to store new hash values, due to publically known breaks. end note]

RIPEMD-128

Specifies that the RIPEMD-128 algorithm, as defined by /IEC 10118-3:2004 shall be used.

[Note: It is recommended that applications should avoid using this algorithm to store new hash values, due to publically known breaks. end note]

RIPEMD-160

Specifies that the RIPEMD-160 algorithm, as defined by /IEC 10118-3:2004 shall be used.

SHA-1

Specifies that the SHA-1 algorithm, as defined by /IEC 10118-3:2004 shall be used.

SHA-256

Specifies that the SHA-256 algorithm, as defined by /IEC 10118-3:2004 shall be used.

SHA-384

Specifies that the SHA-384 algorithm, as defined by /IEC 10118-3:2004 shall be used.

SHA-512

Specifies that the SHA-512 algorithm, as defined by /IEC 10118-3:2004 shall be used.

WHIRLPOOL

Specifies that the WHIRLPOOL algorithm, as defined by /IEC 10118-3:2004 shall be used.

[Example: Consider an Office Open XML document with the following information stored in one of its protection elements:

< … algorithmName="SHA-1"   hashValue="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The algorithmName attribute value of “SHA-1” specifies that the SHA-1 hashing algorithm must be used to generate a hash from the user-defined password. end example]

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

autoFilter (AutoFilter Locked)

If 1 or true then AutoFilters should not be allowed to operate when the sheet is protected.

If 0 or false then AutoFilters should be allowed to operate when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

deleteColumns (Delete Columns Locked)

If 1 or true then deleting columns should not be allowed when the sheet is protected.

If 0 or false then deleting columns should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

deleteRows (Delete Rows Locked)

If 1 or true then deleting rows should not be allowed when the sheet is protected.

If 0 or false then deleting rows should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

formatCells (Format Cells Locked)

If 1 or true then formatting cells should not be allowed when the sheet is protected.

If 0 or false then formatting cells should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

formatColumns (Format Columns Locked)

If 1 or true then formatting columns should not be allowed when the sheet is protected.

If 0 or false then formatting columns should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

formatRows (Format Rows Locked)

If 1 or true then formatting rows should not be allowed when the sheet is protected.

If 0 or false then formatting rows should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

hashValue (Password Hash Value)

Specifies the hash value for the password required to edit this worksheet. This value shall be compared with the resulting hash value after hashing the user-supplied password using the algorithm specified by the preceding attributes and parent XML element, and if the two values match, the protection shall no longer be enforced.

If this value is omitted, then the reservationPassword attribute shall contain the password hash for the workbook.

[Example: Consider an Office Open XML document with the following information stored in one of its protection elements:

<… algorithmName="SHA-1"  hashValue="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The hashValue attribute value of 9oN7nWkCAyEZib1RomSJTjmPpCY= specifies that the user-supplied password must be hashed using the pre-processing defined by the parent element (if any) followed by the SHA-1 algorithm (specified via the algorithmName attribute value of SHA-1) and that the resulting hash value must be 9oN7nWkCAyEZib1RomSJTjmPpCY= for the protection to be disabled. end example]

The possible values for this attribute are defined by the W3C XML Schema base64Binary datatype.

insertColumns (Insert Columns Locked)

If 1 or true then inserting columns should not be allowed when the sheet is protected.

If 0 or false then inserting columns should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

insertHyperlinks (Insert Hyperlinks Locked)

If 1 or true then inserting hyperlinks should not be allowed when the sheet is protected.

If 0 or false then inserting hyperlinks should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

insertRows (Insert Rows Locked)

If 1 or true then inserting rows should not be allowed when the sheet is protected.

If 0 or false then inserting rows should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

objects (Objects Locked)

If 1 or true then editing of objects should not be allowed when the sheet is protected.

If 0 or false then objects are allowed to be edited when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

pivotTables (Pivot Tables Locked)

If 1 or true then PivotTables should not be allowed to operate when the sheet is protected.

If 0 or false then PivotTables should be allowed to operate when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

saltValue (Salt Value for Password Verifier)

Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm defined by the preceding attribute values to generate the hashValue attribute, and which shall also be prepended to the user-supplied password before attempting to generate a hash value for comparison. A salt is a random string which is added to a user-supplied password before it is hashed in order to prevent a malicious party from pre-calculating all possible password/hash combinations and simply using those pre-calculated values (often referred to as a "dictionary attack").

If this attribute is omitted, then no salt shall be prepended to the user-supplied password before it is hashed for comparison with the stored hash value.

[Example: Consider an Office Open XML document with the following information stored in one of its protection elements:

<… saltValue="ZUdHa+D8F/OAKP3I7ssUnQ=="  hashValue="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The saltValue attribute value of ZUdHa+D8F/OAKP3I7ssUnQ== specifies that the user-supplied password must have this value prepended before it is run through the specified hashing algorithm to generate a resulting hash value for comparison. end example]

The possible values for this attribute are defined by the W3C XML Schema base64Binary datatype.

scenarios (Scenarios Locked)

If 1 or true then Scenarios should not be edited when the sheet is protected.

If 0 or false then Scenarios are allowed to be edited when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

selectLockedCells (Select Locked Cells Locked)

If 1 or true then selection of locked cells should not be allowed when the sheet is protected.

If 0 or false then selection of locked cells should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

selectUnlockedCells (Select Unlocked Cells Locked)

If 1 or true then selection of unlocked cells should not be allowed when the sheet is protected.

If 0 or false then selection of unlocked cells should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

sheet (Sheet Locked)

If 1 or true then the sheet is protected.

If 0 or false then the sheet is not protected.

The value of this attribute dictates whether the other attributes of sheetProtection should be applied. If 1 or true then the other attributes of sheetProtection should be applied. If 0 or false then the other attributes of sheetProtection should not be applied.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

sort (Sort Locked)

If 1 or true then sorting should not be allowed when the sheet is protected.

If 0 or false then sorting should be allowed when the sheet is protected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

spinCount (Iterations to Run Hashing Algorithm)

Specifies the number of times the hashing function shall be iteratively run (runs using each iteration's result plus a 4 byte value (0-based, little endian) containing the number of the iteration as the input for the next iteration) when attempting to compare a user-supplied password with the value stored in the hashValue attribute.

[Rationale: Running the algorithm many times increases the cost of exhaustive search attacks correspondingly. Storing this value allows for the number of iterations to be increased over time to accommodate faster hardware (and hence the ability to run more iterations in less time). end rationale]

[Example: Consider an Office Open XML document with the following information stored in one of its protection elements:

<… spinCount="100000"  hashValue="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The spinCount attribute value of 100000 specifies that the hashing function must be run one hundred thousand times to generate a hash value for comparison with the hashValue attribute. end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_SheetProtection) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2016 Microsoft