XLSheetMBS.SetActiveCell(row as integer, col as integer)

XLSheetMBS.SetAutoFitArea(rowFirst as Integer = 0, colFirst as Integer = 0, rowLast as Integer = -1, colLast as Integer = -1)

The method setCol with -1 width value will affect only to the specified limited area.

XLSheetMBS.SetBorder(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, borderStyle as Integer, borderColor as Integer)   New in 25.2

rowFirst - the first row of range;
rowLast - the last row of range;
colFirst - the first column of range;
colLast - the last column of range;
borderStyle - the border style;
borderColor - the border color.

XLSheetMBS.SetCol(colFirst as Integer, colLast as Integer, width as Double, format as XLFormatMBS = nil, hidden as boolean = false) as boolean

If format is nil then format is ignored. Columns may be hidden. Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. Value -1 is used for autofit column widths. If format equals 0 then format is ignored. Columns may be hidden.

XLSheetMBS.SetColPx(colFirst as integer, colLast as integer, width as integer, format as XLFormatMBS = nil, hidden as boolean = false) as boolean

Value -1 is used for autofit column widths.
If format equals nil then format is ignored. Columns may be hidden.
Returns false if error occurs. Get an error info with the errorMessage function in XLBookMBS class.

XLSheetMBS.SetFooter(footer as string, margin as Double) as boolean

The footer text appears at the bottom of every page when printed. The length of the text must be less than or equal to 255. The footer text can contain special commands, for example a placeholder for the page number, current date or text formatting attributes. See setHeader for details. Margin is specified in inches.

Code	Description
&L	specifies the beginning of the left section
&P	specifies the current page number
&N	specifies the total number of pages
&\d{1,3}	specifies the text font size, where font size is measured in points, for example: &9 or &36
&S	specifies whether the strikethrough text style is on or off
&X	specifies whether the superscript text style is on or off
&Y	specifies whether the subscript text style is on or off
&C	specifies the beginning of the center section
&D	specifies a date
&T	specifies a time
&G	specifies a picture
&U	specifies whether the single underline text style is on or off
&E	specifies whether the double underline text style is on or off
&R	specifies the beginning of the right section
&Z	specifies a workbook file path
&F	specifies a workbook file name
&A	specifies a sheet name
&"fontname"	specifies the text font, for example: &"Comic Sans MS"
&B	specifies whether the bold text style is on or off
&I	specifies whether the italic text style is on or off
&&	specifies an ampersand character (&)

XLSheetMBS.SetHeader(header as string, margin as Double) as boolean

The text appears at the top of every page when printed. The length of the text must be less than or equal to 255. The header text can contain special commands, for example a placeholder for the page number, current date or text formatting attributes. Special commands are represented by single letter with a leading ampersand ("&"). Margin is specified in inches.

Code	Description
&L	specifies the beginning of the left section
&P	specifies the current page number
&N	specifies the total number of pages
&\d{1,3}	specifies the text font size, where font size is measured in points, for example: &9 or &36
&S	specifies whether the strikethrough text style is on or off
&X	specifies whether the superscript text style is on or off
&Y	specifies whether the subscript text style is on or off
&C	specifies the beginning of the center section
&D	specifies a date
&T	specifies a time
&G	specifies a picture
&U	specifies whether the single underline text style is on or off
&E	specifies whether the double underline text style is on or off
&R	specifies the beginning of the right section
&Z	specifies a workbook file path
&F	specifies a workbook file name
&A	specifies a sheet name
&"fontname"	specifies the text font, for example: &"Comic Sans MS"
&B	specifies whether the bold text style is on or off
&I	specifies whether the italic text style is on or off
&&	specifies an ampersand character (&)

XLSheetMBS.SetHorPageBreak(row as Integer, pageBreak as boolean = true) as boolean

// new document
Var x as new XLBookMBS

// add a sheet
Var s as XLSheetMBS = x.AddSheet

// write a cell
call s.WriteString(5,5, "Hello")

// now put a page break there
if s.SetHorPageBreak(5, true) then
  // and now we have one at row 5
  MsgBox str(s.GetHorPageBreakCount)+" "+str(s.GetHorPageBreak(0))
end if

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLSheetMBS.SetMerge(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer) as boolean

// create new xls file
Var book As New XLBookMBS(True)

// create sheet
Var sheet as XLSheetMBS = book.AddSheet("Sheet1")

// create a format with border
Var borderFormat As XLFormatMBS = book.AddFormat
borderFormat.SetBorder 2
borderFormat.SetBorderColor &hFF0000

// now fill a cell and merge a few more cells.
Var r1 As Boolean = sheet.WriteString(2, 2, "Hello World", borderFormat)
Var r2 As Boolean = sheet.SetMerge(2, 4, 2, 4)

// write file
Var file As FolderItem = SpecialFolder.Desktop.Child("Generate.xlsx")

if book.Save(file) then
  file.Launch
else
  MsgBox "Failed to create file."+EndOfLine+EndOfLine+book.ErrorMessage
end if

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Some examples using this method:

• /XL/Writing data

XLSheetMBS.SetNamedRange(name as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, scopeId as Integer = -2) as boolean

scopeId - index of sheet for local named range or ScopeWorkbook for global named range.
Returns false if error occurs. Get error info with XLBookMBS.errorMessage.

XLSheetMBS.SetPicture(row as Integer, col as Integer, PictureID as Integer, scale as Double = 1.0, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)

Use XLBookMBS.addPicture() for getting picture identifier.

scale = 0 means the picture is stretched inside the specified cell or merged area.

See also:

• SetPicture(row as Integer, col as Integer, PictureID as Integer, width as Integer, height as Integer, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)

XLSheetMBS.SetPicture(row as Integer, col as Integer, PictureID as Integer, width as Integer, height as Integer, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)

Use XLBookMBS.addPicture() for getting a picture identifier.

Width and height can be -1 for default size of picture.

See also:

• SetPicture(row as Integer, col as Integer, PictureID as Integer, scale as Double = 1.0, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)

XLSheetMBS.SetPrintArea(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)

XLSheetMBS.SetPrintFit(wPages as Integer, hPages as Integer)

XLSheetMBS.SetPrintRepeatCols(colFirst as Integer, colLast as Integer)

XLSheetMBS.SetPrintRepeatRows(rowFirst as Integer, rowLast as Integer)

XLSheetMBS.SetProtectEx(protect as boolean = true, password as string = "", enhancedProtection as Integer = -1)

It is possible to combine a few EnhancedProtection values with operator BitwiseOr.

XLSheetMBS.SetRow(row as Integer, height as Double, format as XLFormatMBS = nil, hidden as boolean = false) as boolean

If format is nil then format is ignored. Row may be hidden. Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Height is in points. If you want to convert from pixels to points you can use this calculation: points = pixels * 72 / 96. So for a height of 72 pixel, you pass 54 points.

XLSheetMBS.SetRowPx(row as integer, height as integer, format as XLFormatMBS = nil, hidden as boolean = false) as boolean

If format equals nil then format is ignored. Row may be hidden. Returns false if error occurs. Get an error info with the errorMessage function in XLBookMBS class.

XLSheetMBS.SetTabColor(colorValue as Integer)

XLSheetMBS.SetTabRgbColor(red as Integer, green as Integer, blue as Integer)

XLSheetMBS.SetTopLeftView(row as Integer, col as Integer)

// create new xls file
Var book as new XLBookMBS(false)

// create sheet
Var sheet as XLSheetMBS = book.AddSheet("Sheet1")

// set top left view
sheet.SetTopLeftView(2,3)

// read values
Var col, row as Integer
sheet.GetTopLeftView(row, col)

MsgBox str(Row)+", "+str(col) // shows 2, 3

XLSheetMBS.SetVerPageBreak(row as Integer, pageBreak as boolean = true) as boolean

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLSheetMBS.Split(row as Integer, col as Integer)

Splits a sheet at position (row, col) or specifies the position of frozen pane. This function allows to freeze a header at top position or freeze some columns on the right.

XLSheetMBS.SplitInfo(byref row as Integer, byref col as Integer) as Boolean

row: vertical position of the split;
col: horizontal position of the split.
Returns true on success.

XLSheetMBS.Table(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref headerRowCount as Integer, byref totalsRowCount as Integer) as string

headerRowCount - the number of header rows showing at the top of the table. 0 means that the header row is not shown.
totalsRowCount - the number of totals rows that shall be shown at the bottom of the table. 0 means that the totals row is not shown.
Returns a string representing the name of the table.

See also:

• Table(name as string, byref rowFirst as integer, byref rowLast as integer, byref ColFirst as integer, byref ColLast as integer, byref headerRowCount as integer, byref totalsRowCount as integer) as Boolean

XLSheetMBS.Table(name as string, byref rowFirst as integer, byref rowLast as integer, byref ColFirst as integer, byref ColLast as integer, byref headerRowCount as integer, byref totalsRowCount as integer) as Boolean

headerRowCount - the number of header rows showing at the top of the table. 0 means that the header row is not shown.
totalsRowCount - the number of totals rows that shall be shown at the bottom of the table. 0 means that the totals row is not shown.

Returns true if the table is found.

See also:

• Table(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref headerRowCount as Integer, byref totalsRowCount as Integer) as string

XLSheetMBS.TableByIndex(index as Integer) as XLTableMBS   New in 25.2

Only for xlsx files.
Returns the table if successed, nil if failed.

XLSheetMBS.TableByName(Name as String) as XLTableMBS   New in 25.2

Only for xlsx files.
Returns the table if successed, nil if failed.

XLSheetMBS.WriteBlank(row as Integer, col as Integer, format as XLFormatMBS = nil) as boolean

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

Some examples using this method:

• /XL/Writing data

XLSheetMBS.WriteBoolean(row as Integer, col as Integer, value as boolean, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteBoolean(2, 5, true, format)

If format is nil then format is ignored.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

XLSheetMBS.WriteComment(row as Integer, col as Integer, value as string, author as string, width as Integer, height as Integer)

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteComment(2, 5, "Sales Worldwide", "Peter", 30, 10)

row and col: cell's position
value: comment string
author: author string
width: width of text box in pixels
height: height of text box in pixels

Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

XLSheetMBS.WriteDate(row as Integer, col as Integer, value as date, format as XLFormatMBS = nil) as boolean

If format is nil then format is ignored. Internally uses XLBookMBS.datePack() for packing date/time parts to double.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

XLSheetMBS.WriteDateTime(row as integer, col as integer, value as dateTime, format as XLFormatMBS = nil) as boolean

If format is nil then format is ignored. Internally uses XLBookMBS.datePack() for packing date/time parts to double.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

XLSheetMBS.WriteError(row as Integer, col as Integer, Error as Integer, format as XLFormatMBS = nil)

If format equals nil then format is ignored.

XLSheetMBS.WriteFormula(row as Integer, col as Integer, value as string, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteFormula(2, 5, "SUM(E16:E38)", format)

If format is nil then format is ignored. Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.
As LibXL does not calculate the result of the formula, it will not encode the result in the Excel file. It does only store the formula, so an app opening the file will have to do the calculation. But QuickLook on Mac OS X does not calculate, so results do not show there.
Examples for formulas are: "TODAY()", "IF(C1>0;ABS(C1*D1);"""")", "SUM(E16:E38)" or "E39+E39*E40".

Some examples using this method:

• /XL/Writing data

XLSheetMBS.WriteFormulaBool(row as Integer, col as Integer, Expression as string, value as Boolean, format as XLFormatMBS = nil) as boolean

If format equals nil then format is ignored.
Returns false if error occurs. Get error info with XLBookMBS.errorMessage.

XLSheetMBS.WriteFormulaNum(row as Integer, col as Integer, Expression as string, value as Double, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteFormulaNum(2, 5, "SUM(E16:E38)", 123.45, format)

If format equals nil then format is ignored. Returns false if error occurs. Get error info with XLBookMBS.errorMessage.

XLSheetMBS.WriteFormulaString(row as Integer, col as Integer, Expression as string, value as String, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var DollarFormat as XLFormatMBS // the format to use

Var Success as Boolean = Sheet.WriteFormulaNum(2, 5, "SUM(E16:E38)", "$123.45"", DollarFormat)

If format equals nil then format is ignored. Returns false if error occurs. Get error info with XLBookMBS.errorMessage.

XLSheetMBS.WriteNumber(row as Integer, col as Integer, value as Double, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteNumber(2, 5, 123.45, format)

If format is nil then format is ignored. Use XLBookMBS.datePack() for packing date/time parts to double.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

Some examples using this method:

• /XL/AutoFilter by Values
• /XL/AutoFilter Number Filter
• /XL/AutoFilter Sort
• /XL/Conditional formatting
• /XL/Edit
• /XL/Invoice
• /XL/Invoice with Template for Web/Invoice with Template for Web
• /XL/Invoice xml
• /XL/Performance
• /XL/Writing data

XLSheetMBS.WriteRichString(row as integer, col as integer, RichString as XLRichStringMBS, format as XLFormatMBS = nil) as boolean

Add a new rich string with the addRichString() method. If format equals nil then format is ignored.
Returns false if an error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLSheetMBS.WriteString(row as Integer, col as Integer, value as string, format as XLFormatMBS = nil) as boolean

Var Sheet as XLSheetMBS // your current sheet
Var format as XLFormatMBS // optional format

Var Success as Boolean = Sheet.WriteString(2, 5, "Hello World", format)

If format is nil then format is ignored.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.