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

XL.Format.SetFillPattern

Sets the fill pattern.

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

Parameters

Parameter Description Example
Book The reference number for the workbook. $ref
Format The index of the format in the book to target. 0
Value The new pattern. 3

Result

Returns OK or error.

Description

Sets the fill pattern.

None0
Solid1
50% Gray2
75% Gray3
25% Gray4
Horizontal Stripes5
Vertical Stripes6
Reverse Diagonal Stripes7
Diagonal Stripes8
Diagonal Cross Hatch9
Thick Diagonal Stripe9
Thin Horizontal Stripe11
Thin Vertical Stripe12
Thin Reverse Diagonal Stripe13
Thin Diagonal Stripe14
Thin Horizontal Cross Hatch15
Thin Diagonal Cross Hatch16
Gray 12P517
Gray 6P2518

see table of fill patterns here:
http://www.libxl.com/format.html#borderStyleTable#setFillPattern

Examples

Sets the foreground color of the fill pattern to red to fill cell red:

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

See also

This function checks for a license.

Created 18th August 2014, last changed 30th March 2024


XL.Format.SetBorderTopColor - XL.Format.SetFont