Platforms to show: All Mac Windows Linux Cross-Platform
Back to XLSheetMBS class.
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 |
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 |
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 |
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 |
(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 |
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 |
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 |
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 |
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 |
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.
XLSheetMBS.SetFooter(footer as string, margin as Double) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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 (&) |
XLSheetMBS.SetHeader(header as string, margin as Double) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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.
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 (&) |
XLSheetMBS.SetHorPageBreak(row as Integer, pageBreak 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 |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLSheetMBS.SetMerge(rowFirst as Integer, rowLast as Integer, 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 |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Some examples using this method:
XLSheetMBS.SetNamedRange(name as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, scopeId as Integer = -2) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
scopeId - index of sheet for local named range or ScopeWorkbook for global named range.
Returns false if error occurs. Get error info with XLBookMBS.errorMessage.
XLSheetMBS.SetPicture(row as Integer, col as Integer, PictureID as Integer, scale as Double = 1.0, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use XLBookMBS.addPicture() for getting picture identifier.
See also:
XLSheetMBS.SetPicture(row as Integer, col as Integer, PictureID as Integer, width as Integer, height as Integer, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use XLBookMBS.addPicture() for getting a picture identifier.
Width and height can be -1 for default size of picture.
See also:
XLSheetMBS.SetPrintArea(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintFit(wPages as Integer, hPages as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintRepeatCols(colFirst as Integer, colLast as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetPrintRepeatRows(rowFirst as Integer, rowLast as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetProtectEx(protect as boolean = true, password as string = "", enhancedProtection as Integer = -1)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
It is possible to combine a few EnhancedProtection values with operator BitwiseOr.
XLSheetMBS.SetRow(row as Integer, height 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 |
If format is nil then format is ignored. Row may be hidden. Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
Height is in points. If you want to convert from pixels to points you can use this calculation: points = pixels * 72 / 96. So for a height of 72 pixel, you pass 54 points.
XLSheetMBS.SetRowPx(row as integer, height 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 |
If format equals nil then format is ignored. Row may be hidden. Returns false if error occurs. Get an error info with the errorMessage function in XLBookMBS class.
XLSheetMBS.SetTabColor(colorValue as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetTabRgbColor(red as Integer, green as Integer, blue as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetTopLeftView(row as Integer, col as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLSheetMBS.SetVerPageBreak(row as Integer, pageBreak 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 |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLSheetMBS.Split(row as Integer, col as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Splits a sheet at position (row, col) or specifies the position of frozen pane. This function allows to freeze a header at top position or freeze some columns on the right.
XLSheetMBS.SplitInfo(byref row as Integer, byref col 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 |
row: vertical position of the split;
col: horizontal position of the split.
Returns true on success.
XLSheetMBS.Table(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref headerRowCount as Integer, byref totalsRowCount as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | XL | MBS XL Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
headerRowCount - the number of header rows showing at the top of the table. 0 means that the header row is not shown.
totalsRowCount - the number of totals rows that shall be shown at the bottom of the table. 0 means that the totals row is not shown.
Returns a string representing the name of the table.
See also:
The items on this page are in the following plugins: MBS XL Plugin.