Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

XLSheetMBS.AutoFilter as XLAutoFilterMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: Returns the AutoFilter.
Notes:
Creates it if it doesn't exist.
Only for xml based files.
(Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Book as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 15.0 Yes Yes Yes Yes No
Function: The parent book.
Notes:
As a sheet is only valid with the owning book, we keep a back reference here.
(Read only property)

Feedback, Comments & Corrections

XLSheetMBS.DisplayGridlines as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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)

Feedback, Comments & Corrections

XLSheetMBS.FirstCol as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns the first column in the sheet that contains a used cell.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.FirstRow as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns the first row in the sheet that contains a used cell.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Footer as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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.

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)

Feedback, Comments & Corrections

XLSheetMBS.FooterMargin as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The footer margin in inches.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.GetHorPageBreakCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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)

Feedback, Comments & Corrections

XLSheetMBS.GetVerPageBreakCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns a number of vertical page breaks in the sheet.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.GroupSummaryBelow as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Whether grouping rows summary is below.
Notes:
True if summary is below and false if isn't.
(Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.GroupSummaryRight as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Whether grouping columns summary is right.
Notes:
Returns true if summary is right and false if isn't.
(Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The internal object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.HCenter as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Whether the sheet is centered horizontally when printed.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.Header as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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.

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)

Feedback, Comments & Corrections

XLSheetMBS.HeaderMargin as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The header margin in inches.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Hidden as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 12.1 Yes Yes Yes Yes No
Function: Specifies the visible state of this sheet.
Notes:
See constants: SheetStateHidden, SheetStateVeryHidden, SheetStateVisible.
(Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.HyperlinkSize as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Returns the number of hyperlinks in the sheet.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Landscape as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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)

Feedback, Comments & Corrections

XLSheetMBS.LastCol as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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)

Feedback, Comments & Corrections

XLSheetMBS.LastRow as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
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)

Feedback, Comments & Corrections

XLSheetMBS.MarginBottom as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The bottom margin of the sheet in inches.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.MarginLeft as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The left margin of the sheet in inches.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.MarginRight as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The right margin of the sheet in inches.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.MarginTop as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The top margin of the sheet in inches.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.MergeSize as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Returns a number of merged cells in this worksheet.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Name as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The name of the sheet.
Notes: (Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.NamedRangeCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns the number of named ranges in the sheet.
Notes: (Read only property)

Feedback, Comments & Corrections

XLSheetMBS.Paper as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The paper size.
Notes:
See Paper* constants.
(Read and Write property)

Feedback, Comments & Corrections

XLSheetMBS.PictureCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns a number of pictures in this worksheet.
Notes: (Read only property)

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo blog