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

XL.Book.GetRGBMode

Returns whether the RGB mode is active.

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

Parameters

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

Result

Returns 0 for index mode or 1 for RGB mode or error.

Description

Returns whether the RGB mode is active.

Examples

Sets the fore color to 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 18th August 2014


XL.Book.GetPictureType - XL.Book.GetRefR1C1