XL.Format.GetPatternForegroundColor
-----------------------------------

Returns the foreground color of the fill pattern.

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

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

**MBS**( **"XL.Format.GetPatternForegroundColor";** /\* Returns the foreground color of the fill pattern. \*/  
**$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 the foreground color of the fill pattern.  
If book is in RGB mode, you need to use [XL.Color.UnPack](XLColorUnPack.md) to get red, green and blue color components from the returned number. If book is not in RGB mode, you receive a color number (see [XL.Font.SetColor](XLFontSetColor.md)).  
### See also

- [XL.Color.UnPack](XLColorUnPack.md)
- [XL.Font.SetColor](XLFontSetColor.md)
- [XL.Format.GetPatternBackgroundColor](XLFormatGetPatternBackgroundColor.md)
- [XL.Format.SetPatternBackgroundColor](XLFormatSetPatternBackgroundColor.md)
- [XL.Format.SetPatternForegroundColor](XLFormatSetPatternForegroundColor.md)

This function checks for a license.

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

  
[XL.Format.GetPatternBackgroundColor](XLFormatGetPatternBackgroundColor.md) - [XL.Format.GetRotation](XLFormatGetRotation.md)

[HTML Version](XLFormatGetPatternForegroundColor.shtml)