Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

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

Feedback, Comments & Corrections

XLSheetMBS.GetHorPageBreak(index as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns row with horizontal page break at position index.

Feedback, Comments & Corrections

XLSheetMBS.GetHorPageBreakCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method 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

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Gets merged cells for cell at row, col.
Notes:
Result is written in rowFirst, rowLast, colFirst, colLast.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Gets the named range coordianates by name.
Notes: Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 14.0 Yes Yes Yes Yes No
Function: Gets the named range coordianates by name.
Notes:
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:

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns a workbook picture index at position index in worksheet.
Notes:
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.

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Gets the print area.
Notes: Returns false if print area isn't found.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintFit(byref wPages as Integer, byref hPages as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns whether fit to page option is enabled.
Notes:
Output parameters:
wPages - number of pages the sheet width is fit to;
hPages - number of pages the sheet height is fit to.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintRepeatCols(byref colFirst as Integer, byref colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Gets repeated columns on each page from colFirst to colLast.
Notes: Returns false if repeated columns aren't found.

Feedback, Comments & Corrections

XLSheetMBS.GetPrintRepeatRows(byref rowFirst as Integer, byref rowLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Gets repeated rows on each page from rowFirst to rowLast.
Notes: Returns false if repeated rows aren't found.

Feedback, Comments & Corrections

XLSheetMBS.GetTopLeftView(byref row as Integer, byref col as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 12.2 Yes Yes Yes Yes No
Function: Extracts the first visible row and the leftmost visible column of the sheet.
Example:
// create new xls file
dim book as new XLBookMBS(false)

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

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

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

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

Feedback, Comments & Corrections

XLSheetMBS.GetVerPageBreak(index as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns column with vertical page break at position index.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

XLSheetMBS.GroupCols(colFirst as Integer, colLast as Integer, collapsed as boolean = true) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Groups columns from colFirst to colLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.GroupRows(rowFirst as Integer, rowLast as Integer, collapsed as boolean = true) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Groups rows from rowFirst to rowLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage 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 computed 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 computed 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 computed property)

Feedback, Comments & Corrections

XLSheetMBS.Header as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method 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 (&)

Feedback, Comments & Corrections

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

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

Feedback, Comments & Corrections

XLSheetMBS.Hyperlink(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Gets the hyperlink and its coordianates by index.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

XLSheetMBS.InsertCol(colFirst as Integer, colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Inserts columns from colFirst to colLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.InsertRow(rowFirst as Integer, rowLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Inserts rows from rowFirst to rowLast.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.IsDate(row as Integer, col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Checks that cell contains a date or time value.

Feedback, Comments & Corrections

XLSheetMBS.IsFormula(row as Integer, col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Checks that cell contains a formula.

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

Feedback, Comments & Corrections

XLSheetMBS.LastCol as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method 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)

Feedback, Comments & Corrections

Previous items Next items

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




Links
MBS Xojo PDF Plugins