Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

XLSheetMBS.GetNamedRange(name as string, 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 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets the named range coordianates by name.
Notes: Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

Feedback, Comments & Corrections

XLSheetMBS.GetNamedRange(name as string, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer, ScopeID as Integer, byref Hidden as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets the named range coordianates by name.
Notes:
scopeId - index of sheet for local named range or SCOPE_WORKBOOK for global named range.
hidden - true if named range is hidden and false if isn't.
Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.errorMessage.

See also:

Feedback, Comments & Corrections

XLSheetMBS.GetPicture(index as Integer, byref rowTop as Integer, byref colLeft as Integer, byref rowBottom as Integer, byref colRight as Integer, byref width as Integer, byref height as Integer, byref offsetX as Integer, byref offsetY 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
Function: Returns a workbook picture index at position index in worksheet.
Notes:
Output parameters:
(rowTop, colLeft) - top left position of picture;
(rowBottom, colRight) - bottom right position of picture;
width - width of picture in pixels;
height - height of picture in pixels;
offset_x - horizontal offset of picture in pixels;
offset_y - vertical offset of picture in pixels.

Use XLBookMBS.getPicture() for extracting binary data of picture by workbook picture index.
Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintArea(byref rowFirst as Integer, byref colFirst as Integer, byref rowLast as Integer, byref colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 15.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets the print area.
Notes: Returns false if print area isn't found.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintFit(byref wPages as Integer, byref hPages 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
Function: Returns whether fit to page option is enabled.
Notes:
Output parameters:
wPages - number of pages the sheet width is fit to;
hPages - number of pages the sheet height is fit to.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintRepeatCols(byref colFirst as Integer, byref colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 15.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets repeated columns on each page from colFirst to colLast.
Notes: Returns false if repeated columns aren't found.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintRepeatRows(byref rowFirst as Integer, byref rowLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 15.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets repeated rows on each page from rowFirst to rowLast.
Notes: Returns false if repeated rows aren't found.

Feedback, Comments & Corrections

XLSheetMBS.GetTopLeftView(byref row as Integer, byref col as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Extracts the first visible row and the leftmost visible column of the sheet.
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

Feedback, Comments & Corrections

XLSheetMBS.GetVerPageBreak(index 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
Function: Returns column with vertical page break at position index.

Feedback, Comments & Corrections

XLSheetMBS.GroupCols(colFirst as Integer, colLast as Integer, collapsed as boolean = true) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Groups columns from colFirst to colLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.GroupRows(rowFirst as Integer, rowLast as Integer, collapsed as boolean = true) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Groups rows from rowFirst to rowLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.Hyperlink(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 14.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Gets the hyperlink and its coordianates by index.

Feedback, Comments & Corrections

XLSheetMBS.InsertCol(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
Function: Inserts 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.InsertColAndKeepRanges(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
Function: Inserts 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.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
Function: Inserts 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.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
Function: Inserts 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.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
Function: Checks that cell contains a date or time value.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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
Function: Checks that the cell contains a rich string with multiple fonts.
Notes: If return value is true read it with the readRichString() method.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

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
Function: Reads a comment from specified cell.
Notes:
Col and Row are zero based.
Please remember that Excel files have limits like 65536 rows and 256 columns.

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

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

See also:

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 Plugins

Start Chat