Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLSheetMBS class.

XLSheetMBS.GetActiveCell(byref row as integer, byref col as integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets an active cell of the sheet.

Returns true if an active cell is found otherwise returns false.

XLSheetMBS.GetHorPageBreak(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
Returns row with horizontal page break at position index.

XLSheetMBS.GetMerge(row as Integer, col 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 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets merged cells for cell at row, col.

Result is written in rowFirst, rowLast, colFirst, colLast.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

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

Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

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

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:

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
Returns a workbook picture index at position index in worksheet.

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.

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
Gets the print area.

Returns false if print area isn't found.

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
Returns whether fit to page option is enabled.

Output parameters:
wPages - number of pages the sheet width is fit to;
hPages - number of pages the sheet height is fit to.

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
Gets repeated columns on each page from colFirst to colLast.

Returns false if repeated columns aren't found.

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
Gets repeated rows on each page from rowFirst to rowLast.

Returns false if repeated rows aren't found.

XLSheetMBS.GetTabRgbColor(byref red as Integer, byref green as Integer, byref blue as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the sheet's tab RGB color.

Returns true if the values have been returned.

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
Extracts the first visible row and the leftmost visible column of the sheet.
Example
// create new xls file
Var book as new XLBookMBS(false)

// create sheet
Var sheet as XLSheetMBS = book.AddSheet("Sheet1")

// set top left view
sheet.SetTopLeftView(2,3)

// read values
Var col, row as Integer
sheet.GetTopLeftView(row, col)

MsgBox str(Row)+", "+str(col) // shows 2, 3

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
Returns column with vertical page break at position index.

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

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

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

Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

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


The biggest plugin in space...