Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLSheetMBS class.

Previous items Next items

XLSheetMBS.InsertRow(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
Inserts rows from rowFirst to rowLast.

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Updates existing named ranges.

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
Inserts rows from rowFirst to rowLast.

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
Whether this sheet has an auto filter.

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
Checks that cell contains a date or time value.

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
Checks that cell contains a formula.

Some examples using this method:

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
Checks that the cell contains a rich string with multiple fonts.

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
Gets the merged cells by index.

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
Gets the named range coordianates by index.

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
Reads format from blank cell.

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
Reads format from blank cell.

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
Reads a boolean value and its format from cell.

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:

Some examples using this method:

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
Reads a boolean value and its format from cell.

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
Reads a comment from specified cell.

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
Reads a date/time and its format from cell.

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
Reads a date/time and its format from cell.

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
Reads a date/time and its format from cell.

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
Reads a date/time and its format from cell.

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
Reads error from cell.

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
Reads a formula string and its format from cell.

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:

Some examples using this method:

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
Reads a formula string and its format from cell.

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
Reads a number or date/time and its format from cell.

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:

Some examples using this method:

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
Reads a number or date/time and its format from cell.

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
Reads a rich string with multiple fonts and its format from the cell.

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
Reads a rich string with multiple fonts and its format from the cell.

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
Reads a string and its format from cell.

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
Reads a string and its format from cell.

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
Reads rich string of a cell and converts to StyledText.

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
Reads rich string from a cell and returns as StyledText.

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
Reads a value value from a cell.

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
Reads a value value from a cell.

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
Removes columns from colFirst to colLast.

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
Removes columns from colFirst to colLast.

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
Removes a comment from the cell (only for xls format).

XLSheetMBS.RemoveDataValidations

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

XLSheetMBS.RemoveFilter

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Removes the AutoFilter from the sheet.

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
Removes a picture in the specified position.

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
Removes a picture by specified index. Returns false if an error occurs.

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
Removes rows from rowFirst to rowLast.

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
Removes rows from rowFirst to rowLast.

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Doesn't update existing named ranges.

XLSheetMBS.RemoveSelection

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Removes all selection.

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
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

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
Returns row height.

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
Returns row height in pixels.

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
Whether row is hidden.

(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
Returns a range of the selection.

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
Sets an active cell of the sheet.

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
Sets the borders for autofit column widths feature.

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
Sets column width and format for all columns from colFirst to colLast.

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
Sets column width in pixels and format for all columns from colFirst to colLast.

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.

Previous items Next items

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


The biggest plugin in space...