Monkeybread Software - MBS FileMaker Plugin: XL.Sheet.SetCellFormat

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.Sheet.SetCellFormat

Sets cell's format.

Component	Version	macOS	Windows	Linux	Server	FileMaker iOS SDK
XL	3.5	Yes	Yes	Yes	Yes	Yes

MBS( "XL.Sheet.SetCellFormat"; bookRef; sheetIndex; Row; Column; Format ) More

Parameters

Parameter Description Example

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

sheetIndex The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. 0

Row The row for the cell. First row has index 0. $row

Column The column for the cell. First column has index 0. $column

Format The format for the cell. This is index from 0 to XL.GetFormatCount-1 in the book's list of formats. 0

Parameter	Description	Example
bookRef	The reference to the workbook. Please use XL.LoadBook to load a file.	$ref
sheetIndex	The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1.	0
Row	The row for the cell. First row has index 0.	$row
Column	The column for the cell. First column has index 0.	$column
Format	The format for the cell. This is index from 0 to XL.GetFormatCount-1 in the book's list of formats.	0

Result

Returns OK or error.

Description

Sets cell's format.

Examples

Apply a new format to a column:

#create new format
Set Variable [$format; Value:MBS( "XL.Book.AddFormat"; $BookRef )]
Set Variable [$r; Value:MBS( "XL.Format.SetNumFormat"; $BookRef; $format; 7)]
#set as format for column
Set Variable [$r; Value:MBS( "XL.Sheet.SetColumn"; $BookRef; 0; 6; 6; 50 ; $format; 0 )]
#loop over all rows
Set Variable [$lastRow; Value:MBS( "XL.Sheet.GetLastRow"; $BookRef; $sheet )]
Set Variable [$row; Value:1]
Loop
Set Variable [$r; Value:MBS( "XL.Sheet.SetCellFormat"; $BookRef; $sheet; $row; 6; $format )]
#next
Set Variable [$row; Value:$row + 1]
Exit Loop If [$row > $lastRow]
End Loop

Release notes

Version 8.0
- Added XL.Sheet.CellReadBooleans, XL.Sheet.CellReadComments, XL.Sheet.CellReadDates, XL.Sheet.CellReadFormulas, XL.Sheet.CellReadNumbers, XL.Sheet.CellReadTexts, XL.Sheet.CellWriteBlanks, XL.Sheet.CellWriteBooleans, XL.Sheet.CellWriteComments, XL.Sheet.CellWriteDates, XL.Sheet.CellWriteFormulas, XL.Sheet.CellWriteNumbers, XL.Sheet.CellWriteTexts, XL.Sheet.GetCellErrors, XL.Sheet.GetCellFormats, XL.Sheet.RemoveComments and XL.Sheet.SetCellFormats.

Created 18th August 2014, last changed 24th March 2016

XL.Sheet.SetAutoFitArea - XL.Sheet.SetCellFormats