Platforms to show: All Mac Windows Linux Cross-Platform
XLSheetMBS.ReadDateTime(row as integer, col as integer, byref format as XLFormatMBS) as dateTime
Function:
Reads a date/time and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads error from cell.
Notes:
See ErrorType* constants.
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:
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
Function:
Reads a formula string and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a formula string and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a number or date/time and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a number or date/time and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a rich string with multiple fonts and its format from the cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a rich string with multiple fonts and its format from the cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a string and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a string and its format from cell.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads rich string of a cell and converts to StyledText.
Notes: We convert attributes like bold, italic, underline, color, font name and size.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Notes: 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
Function:
Reads rich string from a cell and returns as StyledText.
Notes: We convert attributes like bold, italic, underline, color, font name and size.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Notes: We convert attributes like bold, italic, underline, color, font name and size.
See also:
XLSheetMBS.ReadValue(row as integer, col as integer) as Variant
Function:
Reads a value value from a cell.
Notes:
Depending on content we return number, boolean, text or date.
Returns nil for empty, error or blank cells.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Reads a value value from a cell.
Notes:
Depending on content we return number, boolean, text or date.
Returns nil for empty, error or blank cells.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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
Function:
Removes columns from colFirst to colLast.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.
| 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.
Updates existing named ranges.
XLSheetMBS.RemoveColAndKeepRanges(colFirst as integer, colLast as integer) as boolean
Function:
Removes columns from colFirst to colLast.
Notes:
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 | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
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)
Function:
Removes a comment from the cell (only for xls format).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RemoveDataValidations
Function:
Removes all data validations for the sheet (only for xlsx files).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.RemoveFilter
Function:
Removes the AutoFilter from the sheet.
| 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
Function:
Removes a picture in the specified position.
Notes: Returns false if an error occurs.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns false if an error occurs.
XLSheetMBS.RemovePictureByIndex(index as integer) as Boolean
Function:
Removes a picture by specified index. Returns false if an error occurs.
| 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
Function:
Removes rows from rowFirst to rowLast.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.
| 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.
Updates existing named ranges.
XLSheetMBS.RemoveRowAndKeepRanges(rowFirst as integer, rowLast as integer) as boolean
Function:
Removes rows from rowFirst to rowLast.
Notes:
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 | 20.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Doesn't update existing named ranges.
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.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 (&) |
The items on this page are in the following plugins: MBS XL Plugin.
Links
MBS Xojo Plugins
