Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

XLSheetMBS.ReadError(row as Integer, col as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

Feedback, Comments & Corrections

XLSheetMBS.ReadFormula(row as Integer, col as Integer) as string
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadFormula(row as Integer, col as Integer, byref format as XLFormatMBS) as string
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadNumber(row as Integer, col as Integer) as Double
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadNumber(row as Integer, col as Integer, byref format as XLFormatMBS) as Double
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadRichString(row as integer, col as integer) as XLRichStringMBS
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadRichString(row as integer, col as integer, byref format as XLFormatMBS) as XLRichStringMBS
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadString(row as Integer, col as Integer) as string
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadString(row as Integer, col as Integer, byref format as XLFormatMBS) as string
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadStyledText(row as integer, col as integer) as StyledText
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes Desktop, Console & Web
Function: Reads rich string of a cell and converts to StyledText.
Notes: We convert attributes like bold, italic, underline, color, font name and size.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadStyledText(row as integer, col as integer, byref format as XLFormatMBS) as StyledText
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes Desktop, Console & Web
Function: Reads rich string from a cell and returns as StyledText.
Notes: We convert attributes like bold, italic, underline, color, font name and size.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadValue(row as integer, col as integer) as Variant
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.5 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.ReadValue(row as integer, col as integer, byref format as XLFormatMBS) as Variant
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.5 Yes Yes Yes All
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.RemoveCol(colFirst as Integer, colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
Function: Removes columns from colFirst to colLast.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.

Feedback, Comments & Corrections

XLSheetMBS.RemoveColAndKeepRanges(colFirst as integer, colLast as integer) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
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.

Feedback, Comments & Corrections

XLSheetMBS.RemoveComment(row as Integer, col as Integer)
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 16.5 Yes Yes Yes All
Function: Removes a comment from the cell (only for xls format).

Feedback, Comments & Corrections

XLSheetMBS.RemoveDataValidations
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 17.2 Yes Yes Yes All
Function: Removes all data validations for the sheet (only for xlsx files).

Feedback, Comments & Corrections

XLSheetMBS.RemoveFilter
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 16.5 Yes Yes Yes All
Function: Removes the AutoFilter from the sheet.

Feedback, Comments & Corrections

XLSheetMBS.RemovePicture(row as integer, col as integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
Function: Removes a picture in the specified position.
Notes: Returns false if an error occurs.

Feedback, Comments & Corrections

XLSheetMBS.RemovePictureByIndex(index as integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
Function: Removes a picture by specified index. Returns false if an error occurs.

Feedback, Comments & Corrections

XLSheetMBS.RemoveRow(rowFirst as Integer, rowLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
Function: Removes rows from rowFirst to rowLast.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.

Feedback, Comments & Corrections

XLSheetMBS.RemoveRowAndKeepRanges(rowFirst as integer, rowLast as integer) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.2 Yes Yes Yes All
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.

Feedback, Comments & Corrections

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 Targets
method XL MBS XL Plugin 12.2 Yes Yes Yes All
Function: Converts row and column to a cell reference.
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

Feedback, Comments & Corrections

XLSheetMBS.RowHeight(row as Integer) as Double
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
Function: Returns row height.

Feedback, Comments & Corrections

XLSheetMBS.RowHeightPx(row as integer) as Integer
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 20.0 Yes Yes Yes All
Function: Returns row height in pixels.

Feedback, Comments & Corrections

XLSheetMBS.RowHidden(row as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
property XL MBS XL Plugin 11.3 Yes Yes Yes All
Function: Whether row is hidden.
Notes: (Read and Write computed property)

Feedback, Comments & Corrections

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 Targets
method XL MBS XL Plugin 15.1 Yes Yes Yes All
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.

Feedback, Comments & Corrections

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 Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

Feedback, Comments & Corrections

XLSheetMBS.SetFooter(footer as string, margin as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

CodeDescription
&Lspecifies the beginning of the left section
&Pspecifies the current page number
&Nspecifies 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
&Sspecifies whether the strikethrough text style is on or off
&Xspecifies whether the superscript text style is on or off
&Yspecifies whether the subscript text style is on or off
&Cspecifies the beginning of the center section
&Dspecifies a date
&Tspecifies a time
&Gspecifies a picture
&Uspecifies whether the single underline text style is on or off
&Especifies whether the double underline text style is on or off
&Rspecifies the beginning of the right section
&Zspecifies a workbook file path
&Fspecifies a workbook file name
&Aspecifies a sheet name
&"fontname"specifies the text font, for example: &"Comic Sans MS"
&Bspecifies whether the bold text style is on or off
&Ispecifies whether the italic text style is on or off
&&specifies an ampersand character (&)

Feedback, Comments & Corrections

XLSheetMBS.SetHeader(header as string, margin as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Targets
method XL MBS XL Plugin 11.3 Yes Yes Yes All
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.

CodeDescription
&Lspecifies the beginning of the left section
&Pspecifies the current page number
&Nspecifies 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
&Sspecifies whether the strikethrough text style is on or off
&Xspecifies whether the superscript text style is on or off
&Yspecifies whether the subscript text style is on or off
&Cspecifies the beginning of the center section
&Dspecifies a date
&Tspecifies a time
&Gspecifies a picture
&Uspecifies whether the single underline text style is on or off
&Especifies whether the double underline text style is on or off
&Rspecifies the beginning of the right section
&Zspecifies a workbook file path
&Fspecifies a workbook file name
&Aspecifies a sheet name
&"fontname"specifies the text font, for example: &"Comic Sans MS"
&Bspecifies whether the bold text style is on or off
&Ispecifies whether the italic text style is on or off
&&specifies an ampersand character (&)

Feedback, Comments & Corrections

Previous items Next items

The items on this page are in the following plugins: MBS XL Plugin.

The biggest plugin in space...




Links
MBS Xojo tutorial videos