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.5   10.0   10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2    Statistic    FMM    Blog  

XL.Format.SetPatternBackgroundColor

Sets the background color of the fill pattern.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Format.SetPatternBackgroundColor"; Book; Format; Value )   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
Value The new setting. $value

Result

Returns OK or error.

Description

Sets the background color of the fill pattern.
If you set value and book is in RGB mode you can use XL.ColorPack function to get a numeric value for color components. If the book is not in RGB mode, you can use color values as described in XL.Font.SetColor.

This is the background color for the pattern, you can put in the background of a cell. If your pattern is stripes, the one color is the foreground one and the other the background one.

Examples

Sets the fore color to red:

If [ MBS( "XL.Book.GetRGBMode"; $book) = 0 ]
      Set Variable [ $r; Value: MBS( "XL.Format.SetPatternBackgroundColor"; $book; $format; 10) ]
Else
      Set Variable [ $c; Value: MBS( "XL.Color.Pack"; $book; 255; 0; 0) ]
      Set Variable [ $r; Value: MBS( "XL.Format.SetPatternBackgroundColor"; $book; $format; $c) ]
End If
Set Variable [ $r; Value: MBS( "XL.Format.SetFillPattern"; $book; $format; 1 ) ]

See also

Created 18th August 2014, last changed 14th June 2017


XL.Format.SetNumFormat - XL.Format.SetPatternForegroundColor

Feedback: Report problem or ask question.