XL.Book.CustomNumFormat
-----------------------

Returns a custom format string for specified custom format identifier.

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

MBS( "XL.Book.CustomNumFormat"; BookRef; FormatIndex ) 

**MBS**( **"XL.Book.CustomNumFormat";** /\* Returns a custom format string for specified custom format identifier. \*/  
**$BookRef**; /\* The reference number for the workbook.e.g. $ref \*/   
**$FormatIndex**) /\* The index for the format.e.g. 1 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| BookRef | The reference number for the workbook. | $ref |
| FormatIndex | The index for the format. | 1 |

### Result

Returns format string or error.

### Description

Returns a custom format string for specified custom format identifier.  
Read website for details:  
<http://www.libxl.com/custom-format.html>  
### See also

- [XL.Book.AddCustomNumFormat](XLBookAddCustomNumFormat.md)

This function checks for a license.

Created 18th August 2014 , last changed 22nd October 2024

  
[XL.Book.ConditionalFormatSize](XLBookConditionalFormatSize.md) - [XL.Book.DeleteSheet](XLBookDeleteSheet.md)

[HTML Version](XLBookCustomNumFormat.shtml)