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
Returns the AutoFilter.

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
The parent book.

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
The default row height measured in point size.

(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
Whether the gridlines are displayed.

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:

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
Returns the first column in the sheet that contains a used cell.

(Read only property)

Some examples using this property:

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
Returns the first column in the sheet that contains a filled cell.

(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
Returns the first row in the sheet that contains a filled cell.

(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
Returns the first row in the sheet that contains a used cell.

(Read only property)

Some examples using this property:

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
The footer text of the sheet when printed.

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.

CodeDescription
&Lspecifies the beginning of the left section
&Pspecifies the current page number
&Nspecifies 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
&Sspecifies whether the strikethrough text style is on or off
&Xspecifies whether the superscript text style is on or off
&Yspecifies whether the subscript text style is on or off
&Cspecifies the beginning of the center section
&Dspecifies a date
&Tspecifies a time
&Gspecifies a picture
&Uspecifies whether the single underline text style is on or off
&Especifies whether the double underline text style is on or off
&Rspecifies the beginning of the right section
&Zspecifies a workbook file path
&Fspecifies a workbook file name
&Aspecifies a sheet name
&"fontname"specifies the text font, for example: &"Comic Sans MS"
&Bspecifies whether the bold text style is on or off
&Ispecifies 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
The footer margin in inches.

(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
Returns a number of form controls in this worksheet.

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

(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
Returns a number of vertical page breaks in the sheet.

(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
Whether grouping rows summary is below.

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
Whether grouping columns summary is right.

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
The internal object reference.

(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
Whether the sheet is centered horizontally when printed.

(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
The header text of the sheet when printed.

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.

CodeDescription
&Lspecifies the beginning of the left section
&Pspecifies the current page number
&Nspecifies 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
&Sspecifies whether the strikethrough text style is on or off
&Xspecifies whether the superscript text style is on or off
&Yspecifies whether the subscript text style is on or off
&Cspecifies the beginning of the center section
&Dspecifies a date
&Tspecifies a time
&Gspecifies a picture
&Uspecifies whether the single underline text style is on or off
&Especifies whether the double underline text style is on or off
&Rspecifies the beginning of the right section
&Zspecifies a workbook file path
&Fspecifies a workbook file name
&Aspecifies a sheet name
&"fontname"specifies the text font, for example: &"Comic Sans MS"
&Bspecifies whether the bold text style is on or off
&Ispecifies 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
The header margin in inches.

(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
Specifies the visible state of this sheet.

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
Returns the number of hyperlinks in the sheet.

(Read only property)

Some examples using this property:

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
Whether to use landscape or portrait mode for printing.

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

(Read only property)

Some examples using this property:

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
Returns the zero-based index of the column after the last column in the sheet that contains a filled cell.

(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
Returns the zero-based index of the row after the last row in the sheet that contains a filled cell.

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

(Read only property)

Some examples using this property:

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
The bottom margin of the sheet in inches.

(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
The left margin of the sheet in inches.

(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
The right margin of the sheet in inches.

(Read and Write property)

XLSheetMBS.MarginTop as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The top margin of the sheet in inches.

(Read and Write property)

XLSheetMBS.MergeSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 14.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns a number of merged cells in this worksheet.

(Read only property)

XLSheetMBS.Name as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The name of the sheet.

(Read and Write property)

XLSheetMBS.NamedRangeCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of named ranges in the sheet.

(Read only property)

XLSheetMBS.Paper as Integer

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

See Paper* constants.
(Read and Write property)

XLSheetMBS.PictureCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns a number of pictures in this worksheet.

(Read only property)

XLSheetMBS.PrintGridlines as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the gridlines are printed.

True if gridlines are printed and false if aren't.
(Read and Write property)

XLSheetMBS.PrintRowCol as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the row and column headers are printed.

(Read and Write property)

XLSheetMBS.PrintZoom as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Scaling factor for printing as a percentage.

(Read and Write property)

XLSheetMBS.Protect as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether sheet is protected.

(Read and Write property)

XLSheetMBS.RightToLeft as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the text is displayed in right-to-left mode.

true - the text is displayed in right-to-left mode,
false - the text is displayed in left-to-right mode.
(Read and Write property)

XLSheetMBS.TabColor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The sheet's tab color.

For use with documents using indexed colors.
(Read and Write property)

XLSheetMBS.TableSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of tables in the sheet.

(Read only property)

XLSheetMBS.VCenter as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the sheet is centered vertically when printed.

(Read and Write property)

XLSheetMBS.Zoom as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The zoom level of the current view.

100 is a usual view.
(Read and Write property)

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


The biggest plugin in space...