Platforms to show: All Mac Windows Linux Cross-Platform
Back to XLSheetMBS class.
XLSheetMBS.RowColToAddr(row as Integer, col as Integer, rowRelative as boolean = true, colRelative as boolean = true) as string
Function:
Converts row and column to a cell reference.
Example:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
// create new xls file
dim book as new XLBookMBS(false)
// create sheet
dim sheet as XLSheetMBS = book.AddSheet("Sheet1")
MsgBox sheet.RowColToAddr(5,5) // shows F6
MsgBox sheet.RowColToAddr(5,5,false,false) // shows $F$6
XLSheetMBS.RowHeight(row as Integer) as Double
Function:
Returns row height.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RowHeightPx(row as integer) as Integer
Function:
Returns row height in pixels.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RowHidden(row as Integer) as boolean
Function:
Whether row is hidden.
Notes: (Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: (Read and Write computed property)
XLSheetMBS.SelectionRange as string
Function:
Returns a range of the selection.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 23.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetActiveCell(row as integer, col as integer)
Function:
Sets an active cell of the sheet.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 23.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetAutoFitArea(rowFirst as Integer = 0, colFirst as Integer = 0, rowLast as Integer = -1, colLast as Integer = -1)
Function:
Sets the borders for autofit column widths feature.
Notes: The method setCol with -1 width value will affect only to the specified limited area.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: The method setCol with -1 width value will affect only to the specified limited area.
XLSheetMBS.SetCol(colFirst as Integer, colLast as Integer, width as Double, format as XLFormatMBS = nil, hidden as boolean = false) as boolean
Function:
Sets column width and format for all columns from colFirst to colLast.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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.SetFooter(footer as string, margin as Double) as boolean
Function:
Sets the footer text for the sheet when printed.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Sets the header text of the sheet when printed.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Sets/removes a horizontal page break.
Example:
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
// new document
dim x as new XLBookMBS
// add a sheet
dim 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
XLSheetMBS.SetMerge(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer) as boolean
Function:
Sets merged cells for range: rowFirst - rowLast, colFirst - colLast.
Example:
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
// create new xls file
Dim book As New XLBookMBS(True)
// create sheet
dim sheet as XLSheetMBS = book.AddSheet("Sheet1")
// create a format with border
Dim borderFormat As XLFormatMBS = book.AddFormat
borderFormat.SetBorder 2
borderFormat.SetBorderColor &hFF0000
// now fill a cell and merge a few more cells.
Dim r1 As Boolean = sheet.WriteString(2, 2, "Hello World", borderFormat)
Dim r2 As Boolean = sheet.SetMerge(2, 4, 2, 4)
// write file
Dim 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
Some examples using this method:
XLSheetMBS.SetNamedRange(name as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, scopeId as Integer = -2) as boolean
Function:
Sets the named range.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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)
Function:
Sets a picture with pictureId identifier at position row and col with scale factor.
Notes: Use XLBookMBS.addPicture() for getting picture identifier.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Use XLBookMBS.addPicture() for getting picture identifier.
See also:
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)
Function:
Sets a picture with pictureId identifier at position row and col with custom size.
Notes:
Use XLBookMBS.addPicture() for getting a picture identifier.
Width and height can be -1 for default size of picture.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Use XLBookMBS.addPicture() for getting a picture identifier.
Width and height can be -1 for default size of picture.
See also:
XLSheetMBS.SetPrintArea(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)
Function:
Sets the print area.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintFit(wPages as Integer, hPages as Integer)
Function:
Fits sheet width and sheet height to wPages and hPages respectively.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintRepeatCols(colFirst as Integer, colLast as Integer)
Function:
Sets repeated columns on each page from colFirst to colLast.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintRepeatRows(rowFirst as Integer, rowLast as Integer)
Function:
Sets repeated rows on each page from rowFirst to rowLast.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetProtectEx(protect as boolean = true, password as string = "", enhancedProtection as Integer = -1)
Function:
Protects/unprotects the sheet with password and enchanced parameters below.
Notes: It is possible to combine a few EnhancedProtection values with operator BitwiseOr.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: 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
Function:
Sets row height and format.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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.SetTabColor(colorValue as Integer)
Function:
Sets the color for the sheet's tab.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetTabRgbColor(red as Integer, green as Integer, blue as Integer)
Function:
Sets the color for the sheet's tab.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetTopLeftView(row as Integer, col as Integer)
Function:
Sets the first visible row and the leftmost visible column of the sheet.
Example:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
// create new xls file
dim book as new XLBookMBS(false)
// create sheet
dim sheet as XLSheetMBS = book.AddSheet("Sheet1")
// set top left view
sheet.SetTopLeftView(2,3)
// read values
dim 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
Function:
Sets/removes a vertical page break.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLSheetMBS.Split(row as Integer, col as Integer)
Function:
Splits a sheet at position (row, col).
Notes: 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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: 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
Function:
Gets the split information (position of frozen pane) in the sheet.
Notes:
row: vertical position of the split;
col: horizontal position of the split.
Returns true on success.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 14.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Gets the table parameters by index.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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.
XLSheetMBS.WriteBlank(row as Integer, col as Integer, format as XLFormatMBS = nil) as boolean
Function:
Writes blank cell with specified format.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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:
XLSheetMBS.WriteBoolean(row as Integer, col as Integer, value as boolean, format as XLFormatMBS = nil) as boolean
Function:
Writes a bool value into cell with specified format.
Example:
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
Dim Sheet as XLSheetMBS // your current sheet
Dim format as XLFormatMBS // optional format
Dim 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.
The items on this page are in the following plugins: MBS XL Plugin.
