Monkeybread Xojo plugin - XLSheetMBS properties

Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLSheetMBS class.

XLSheetMBS.AutoFilter as XLAutoFilterMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the AutoFilter.
Notes:
Creates it if it doesn't exist.
Only for xml based files.
(Read only property)

Some examples using this property:

XLSheetMBS.Book as XLBookMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	15.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The parent book.
Notes:
As a sheet is only valid with the owning book, we keep a back reference here.
(Read only property)

XLSheetMBS.DefaultRowHeight as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	23.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The default row height measured in point size.
Notes: (Read and Write property)

XLSheetMBS.DisplayGridlines as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Whether the gridlines are displayed.
Notes:
True if gridlines are displayed and false if aren't.
(Assigning a value to this property calls setDisplayGridlines internally)
(Read and Write property)

Some examples using this property:

/XL/Writing data

XLSheetMBS.FirstCol as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the first column in the sheet that contains a used cell.
Notes: (Read only property)

Some examples using this property:

/XL/Extract

XLSheetMBS.FirstFilledCol as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	20.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the first column in the sheet that contains a filled cell.
Notes: (Read only property)

XLSheetMBS.FirstFilledRow as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	20.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the first row in the sheet that contains a filled cell.
Notes: (Read only property)

XLSheetMBS.FirstRow as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the first row in the sheet that contains a used cell.
Notes: (Read only property)

Some examples using this property:

/XL/Extract

XLSheetMBS.Footer as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The footer text of 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. 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 (&)

(Read only property)

XLSheetMBS.FooterMargin as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The footer margin in inches.
Notes: (Read only property)

XLSheetMBS.FormControlCount as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	21.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns a number of form controls in this worksheet.
Notes: (Read only property)

XLSheetMBS.GetHorPageBreakCount as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns a number of horizontal page breaks in the sheet.
Example:

// new document
dim x as new XLBookMBS

// add a sheet
dim s as XLSheetMBS = x.AddSheet

// write a cell
call s.WriteString(5,5, "Hello")

// now put a page break there
if s.SetHorPageBreak(5, true) then
  // and now we have one at row 5
  MsgBox str(s.GetHorPageBreakCount)+" "+str(s.GetHorPageBreak(0))
end if

Notes: (Read only property)

XLSheetMBS.GetVerPageBreakCount as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns a number of vertical page breaks in the sheet.
Notes: (Read only property)

XLSheetMBS.GroupSummaryBelow as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Whether grouping rows summary is below.
Notes:
True if summary is below and false if isn't.
(Read and Write property)

XLSheetMBS.GroupSummaryRight as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Whether grouping columns summary is right.
Notes:
Returns true if summary is right and false if isn't.
(Read and Write property)

XLSheetMBS.Handle as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The internal object reference.
Notes: (Read and Write property)

XLSheetMBS.HCenter as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Whether the sheet is centered horizontally when printed.
Notes: (Read and Write property)

XLSheetMBS.Header as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

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 (&)

(Read only property)

XLSheetMBS.HeaderMargin as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The header margin in inches.
Notes: (Read only property)

XLSheetMBS.Hidden as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	12.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Specifies the visible state of this sheet.
Notes:
See constants: SheetStateHidden, SheetStateVeryHidden, SheetStateVisible.
(Read and Write property)

XLSheetMBS.HyperlinkSize as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	14.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the number of hyperlinks in the sheet.
Notes: (Read only property)

Some examples using this property:

/XL/List Hyperlinks

XLSheetMBS.Landscape as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Whether to use landscape or portrait mode for printing.
Notes:
true - pages are printed using landscape mode, false - pages are printed using portrait mode.
(Read and Write property)

XLSheetMBS.LastCol as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the zero-based index of the column after the last column in the sheet that contains a used cell.
Example:

dim book as XLBookMBS // your book instance

// get first sheet
dim sheet as XLSheetMBS = book.Sheet(0)

// show index of last column
dim LastCol as Integer = sheet.LastCol

MsgBox "LastCol: " + str(LastCol)

Notes: (Read only property)

Some examples using this property:

/XL/Extract

XLSheetMBS.LastFilledCol as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	20.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the zero-based index of the column after the last column in the sheet that contains a filled cell.
Notes: (Read only property)

XLSheetMBS.LastFilledRow as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	20.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the zero-based index of the row after the last row in the sheet that contains a filled cell.
Notes: (Read only property)

XLSheetMBS.LastRow as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Returns the zero-based index of the row after the last row in the sheet that contains a used cell.
Example:

dim book as XLBookMBS // your book instance

// get first sheet
dim sheet as XLSheetMBS = book.Sheet(0)

// show index of last row
dim LastRow as Integer = sheet.LastRow

MsgBox "LastRow: " + str(LastRow)

Notes: (Read only property)

Some examples using this property:

/XL/Extract

XLSheetMBS.MarginBottom as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The bottom margin of the sheet in inches.
Notes: (Read and Write property)

XLSheetMBS.MarginLeft as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The left margin of the sheet in inches.
Notes: (Read and Write property)

XLSheetMBS.MarginRight as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	XL	MBS XL Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: The right margin of the sheet in inches.
Notes: (Read and Write property)

Next items

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

💬 Ask a question or report a problem