Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4   10.5   10.6    Statistic    FMM    Blog  

XL.Format.GetPatternBackgroundColor

Returns the background color of the fill pattern.

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

Parameters

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

Result

Returns value or error.

Description

Returns the background 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

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


XL.Format.GetNumFormat   -   XL.Format.GetPatternForegroundColor

Feedback: Report problem or ask question.



Links
MBS Xojo Plugins

Start Chat