Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to XLSheetMBS class.
XLSheetMBS.InsertRowAndKeepRanges(rowFirst as integer, rowLast as integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Doesn't update existing named ranges.
XLSheetMBS.IsAutoFilter as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 21.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true if there is an auto filter, otherwise false.
XLSheetMBS.IsDate(row as Integer, col as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.IsFormula(row as Integer, col as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.IsRichString(row as integer, col as integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If return value is true read it with the readRichString() method.
XLSheetMBS.Merge(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 14.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.NamedRange(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
XLSheetMBS.NamedRange(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref scopeId as Integer, byref Hidden as Boolean) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
scopeId - index of sheet for local named range or ScopeWorkbook for global named range.
hidden - true if named range is hidden and false if isn't.
See also:
XLSheetMBS.ReadBlank(row as Integer, col as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if specified cell isn't blank or 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.
See also:
XLSheetMBS.ReadBlank(row as Integer, col as Integer, byref format as XLFormatMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if specified cell isn't blank or 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.
See also:
XLSheetMBS.ReadBoolean(row as Integer, col as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If nil format is returned then an error occured. 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.
See also:
XLSheetMBS.ReadBoolean(row as Integer, col as Integer, byref format as XLFormatMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If nil format is returned then an error occured. 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.
See also:
XLSheetMBS.ReadComment(row as Integer, col as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.
XLSheetMBS.ReadDate(row as Integer, col as Integer) as date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Internally uses XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadDate(row as Integer, col as Integer, byref format as XLFormatMBS) as date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Internally uses XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadDateTime(row as integer, col as integer) as dateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Internally uses XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadDateTime(row as integer, col as integer, byref format as XLFormatMBS) as dateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Internally uses XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadError(row as Integer, col as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See ErrorType* constants.
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.
XLSheetMBS.ReadFormula(row as Integer, col as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns nil if specified cell doesn't contain formula or 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.
See also:
XLSheetMBS.ReadFormula(row as Integer, col as Integer, byref format as XLFormatMBS) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns nil if specified cell doesn't contain formula or 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.
See also:
XLSheetMBS.ReadNumber(row as Integer, col as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadNumber(row as Integer, col as Integer, byref format as XLFormatMBS) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use XLBookMBS.dateUnpack() for extract date/time parts from double.
If format is returned as nil, then 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.
See also:
XLSheetMBS.ReadRichString(row as integer, col as integer) as XLRichStringMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
It's possible to check if the specified cell contains a rich string with the isRichString() method.
Returns nil if the specified cell doesn't contain a string or error occurs.
Get error info with XLBookMBS.ErrorMessage property.
See also:
XLSheetMBS.ReadRichString(row as integer, col as integer, byref format as XLFormatMBS) as XLRichStringMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
It's possible to check if the specified cell contains a rich string with the isRichString() method.
Returns nil if the specified cell doesn't contain a string or error occurs.
Get error info with XLBookMBS.ErrorMessage property.
See also:
XLSheetMBS.ReadString(row as Integer, col as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns "" if specified cell doesn't contain string or 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.
See also:
XLSheetMBS.ReadString(row as Integer, col as Integer, byref format as XLFormatMBS) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns "" if specified cell doesn't contain string or 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.
See also:
XLSheetMBS.ReadStyledText(row as integer, col as integer) as StyledText
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
We convert attributes like bold, italic, underline, color, font name and size.
See also:
XLSheetMBS.ReadStyledText(row as integer, col as integer, byref format as XLFormatMBS) as StyledText
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
We convert attributes like bold, italic, underline, color, font name and size.
See also:
XLSheetMBS.ReadValue(row as integer, col as integer) as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Depending on content we return number, boolean, text or date.
Returns nil for empty, error or blank cells.
See also:
XLSheetMBS.ReadValue(row as integer, col as integer, byref format as XLFormatMBS) as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Depending on content we return number, boolean, text or date.
Returns nil for empty, error or blank cells.
See also:
XLSheetMBS.RemoveCol(colFirst as Integer, colLast as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.
XLSheetMBS.RemoveColAndKeepRanges(colFirst as integer, colLast as integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Doesn't update existing named ranges.
XLSheetMBS.RemoveComment(row as Integer, col as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RemoveDataValidations
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RemovePicture(row as integer, col as integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if an error occurs.
XLSheetMBS.RemovePictureByIndex(index as integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RemoveRow(rowFirst as Integer, rowLast as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.
XLSheetMBS.RemoveRowAndKeepRanges(rowFirst as integer, rowLast as integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Doesn't update existing named ranges.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 23.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RowColToAddr(row as Integer, col as Integer, rowRelative as boolean = true, colRelative as boolean = true) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RowHeight(row as Integer) as Double
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
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
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write computed property)
XLSheetMBS.SelectionRange as string
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)
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)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 23.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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 (&) |
The items on this page are in the following plugins: MBS XL Plugin.