XL.Sheet.SetCellFormat

Sets cell's format.

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

Result

Returns OK or error.

Description

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

See also

• XL.Book.SheetCount
• XL.Format.SetNumFormat
• XL.LoadBook
• XL.Sheet.CellWriteMatrix
• XL.Sheet.CellWriteTexts
• XL.Sheet.GetCellError
• XL.Sheet.GetCellErrors
• XL.Sheet.GetLastRow
• XL.Sheet.SetCellFormats
• XL.Sheet.SetCol

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.

This function checks for a license.

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

XL.Sheet.SetAutoFitArea - XL.Sheet.SetCellFormats