XL.Format.GetLocked
-------------------

Returns whether the locked property is set to true.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [XL](component_XL.md) | [3.5](newinversion35.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "XL.Format.GetLocked"; Book; Format ) 

**MBS**( **"XL.Format.GetLocked";** /\* Returns whether the locked property is set to true. \*/  
**$Book**; /\* The reference number for the workbook.e.g. $ref \*/   
**$Format**) /\* The index of the format in the book to target.e.g. 0 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| Book | The reference number for the workbook. | $ref |
| Format | The index of the format in the book to target. | 0 |

### Result

Returns value or error.

### Description

Returns whether the locked property is set to true.  
### See also

- [XL.Format.GetFont](XLFormatGetFont.md)
- [XL.Format.GetHidden](XLFormatGetHidden.md)
- [XL.Format.SetBorder](XLFormatSetBorder.md)
- [XL.Format.SetLocked](XLFormatSetLocked.md)

This function checks for a license.

Created 18th August 2014 , last changed 18th August 2014

  
[XL.Format.GetIndent](XLFormatGetIndent.md) - [XL.Format.GetNumFormat](XLFormatGetNumFormat.md)

[HTML Version](XLFormatGetLocked.shtml)