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

XL.Book.AddConditionalFormat

Adds a new conditional format to the workbook for using with conditional formatting rules.

Component Version macOS Windows Linux Server iOS SDK
XL 14.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Book.AddConditionalFormat"; bookRef )   More

Parameters

Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref

Result

Returns conditional format index number or error.

Description

Adds a new conditional format to the workbook for using with conditional formatting rules.
Requires LibXL 4.1 or newer and only for xlsx files.

Examples

Highlighting cells that begin With the given text:

# add conditional format
Set Variable [ $cFormat ; Value: MBS("XL.Book.AddConditionalFormat"; $book) ]
#
# set font to be folder
Set Variable [ $font ; Value: MBS("XL.ConditionalFormat.Font"; $book; $cFormat) ]
Set Variable [ $r ; Value: MBS("XL.Font.SetBold"; $book; $font; 1) ]
#
Set Variable [ $CF ; Value: MBS("XL.Sheet.AddConditionalFormatting"; $book; $sheet) ]
Set Variable [ $r ; Value: MBS("XL.ConditionalFormating.AddRange"; $book; $CF; 2; 10; 1; 1) ]
Set Variable [ $r ; Value: MBS("XL.ConditionalFormating.AddRule"; $book; $CF; 0 /* BeginWith */; $cFormat; "a") ]

See also

Release notes

  • Version 14.2
    • Added new XL functions to create conditional formatting including XL.Book.AddConditionalFormat and XL.Sheet.AddConditionalFormatting.

Blog Entries

Created 30th March 2024, last changed 31st March 2024


X509.Write - XL.Book.AddCustomNumFormat