Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Returns the foreground color of the fill pattern.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Format.GetPatternForegroundColor"; Book; Format )   More


Parameter Description Example
Book The reference to the workbook. Please use XL.LoadBook to load a file. $ref
Format The index of the format in the book to target. 0


Returns value or error.


Returns the foreground color of the fill pattern.
If book is in RGB mode, you need to use XL.Color.UnPack 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).

See also

This function checks for a license.

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

XL.Format.GetPatternBackgroundColor - XL.Format.GetRotation