Monkeybread Xojo (Real Studio) plugin - XLBookMBS

Platforms to show: All Mac Windows Linux Cross-Platform

XLBookMBS.AddCustomNumFormat(customNumFormat as string) 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: Adds a new custom number format to the workbook.
Notes: The format string customNumFormat indicates how to format and render the numeric value of a cell. See custom format strings guidelines (in FAQ). Returns the custom format identifier. It's used in XLFormatMBS.NumFormat. Returns 0 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.AddFont(initFont as XLFontMBS = nil) as XLFontMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Adds a new font to the workbook, initial parameters can be copied from other font.
Notes: Returns NULL if error occurs.

Feedback, Comments & Corrections

XLBookMBS.AddFormat(initFormat as XLFormatMBS = nil) as XLFormatMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Adds a new format to the workbook, initial parameters can be copied from other format.
Example:

// define a format for red fill
Dim redBackgroundFormat As XLFormatMBS = book.AddFormat
Dim c As Color = &cFF0000
// will give back numeric value of color for RGB mode or color index
Dim n As Integer = book.PackColor(c)
// we set forecolor of the pattern to fill background!
redBackgroundFormat.PatternForegroundColor = n
redBackgroundFormat.PatternBackgroundColor = n
redBackgroundFormat.FillPattern = XLFormatMBS.FillPatternSolid

Dim row As Integer = 5 // 6th row
Dim col As Integer = 1 // Column B
Dim value As Double = 123

Call sheet.WriteNumber row, col, value, redBackgroundFormat

Notes: Returns NULL if error occurs.

Feedback, Comments & Corrections

XLBookMBS.AddPicture(path as folderitem) 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: Adds a picture to the workbook.
Notes: Returns a picture identifier. Supports BMP, DIB, PNG, JPG and WMF picture formats. Use picture identifier with XLSheetMBS.setPicture(). Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

AddPicture(path as string) as Integer

Feedback, Comments & Corrections

XLBookMBS.AddPicture(path as string) 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: Adds a picture to the workbook.
Notes: Returns a picture identifier. Supports BMP, DIB, PNG, JPG and WMF picture formats. Use picture identifier with XLSheetMBS.setPicture(). Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

AddPicture(path as folderitem) as Integer

Feedback, Comments & Corrections

XLBookMBS.AddPictureData(data as string) 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: Adds a picture to the workbook from memory buffer:
Notes: Returns a picture identifier. Use picture identifier with XLSheetMBS.setPicture(). Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.AddRichString as XLRichStringMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	20.2	Yes	Yes	Yes	Yes	No

Function: Creates a new rich string to be used in the book.

Feedback, Comments & Corrections

XLBookMBS.AddSheet(name as string = "", initSheet as XLSheetMBS = nil) as XLSheetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Adds a new sheet to this book, returns the sheet.
Notes:
Use initSheet parameter if you wish to copy an existing sheet.
Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.AddStyledText(StyledText as StyledText) as XLRichStringMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	20.2	Yes	Yes	Yes	Yes	No

Function: Adds styled text to the book to later assign to a cell.
Notes: We convert attributes like bold, italic, underline, color, font name and size.

Feedback, Comments & Corrections

XLBookMBS.BookVersion as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	13.0	Yes	Yes	Yes	Yes	No

Function: Returns the version number of this book.
Example:

dim b as new XLBookMBS
dim v as Integer = b.BookVersion

dim h as Integer = v \ 256 \ 256 \ 256
dim m as Integer = v \ 256 \ 256       mod 256
dim l as Integer = v \ 256             mod 256

MsgBox "libXL "+str(h)+"."+str(m)+"."+str(l)

Notes: Version number is encoded as hex number with major version, minor version and bugfix.

Feedback, Comments & Corrections

XLBookMBS.Constructor(xml as boolean = false)

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Creates a new XLBookMBS object.
Notes: xml: If true, creates a book in xlsx format (xml), else one in xls format (binary).

Feedback, Comments & Corrections

XLBookMBS.CopyContent(dest as XLBookMBS, Options as XLCopyOptionsMBS = nil)

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	15.1	Yes	Yes	Yes	Yes	No

Function: Copies all content from one book to other book.
Notes:
The plugin loops through all sheets and creates matching sheets on new book.
Formats and fonts are created on the fly.

This allows you to convert from XLS to XLSX or back.
Please report if something is not copied. Of course plugin can only copy what libXL supports, so stuff like movies or diagrams are not copied.

Feedback, Comments & Corrections

XLBookMBS.CustomNumFormat(fmt as Integer) 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: Returns a custom format string for specified custom format identifier fmt.
Notes: See custom format string guidelines (in FAQ). Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.DefaultFont(byref fontSize as Integer) 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: Returns a default font name and size for this workbook.
Notes: Returns "" if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.DelSheet(index 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: Deletes a sheet with specified index.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.Font(index as Integer) as XLFontMBS

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 font with defined index.
Notes: Index must be less than return value of fontCount method.

Feedback, Comments & Corrections

XLBookMBS.FontCount 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 fonts in this book.

Feedback, Comments & Corrections

XLBookMBS.Fonts as XLFontMBS()

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Returns array with all defined fonts.

Feedback, Comments & Corrections

XLBookMBS.Format(index as Integer) as XLFormatMBS

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 format with defined index.
Notes: Index must be less than return value of formatCount method.

Feedback, Comments & Corrections

XLBookMBS.FormatCount 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 formats in this book.

Feedback, Comments & Corrections

XLBookMBS.Formats as XLFormatMBS()

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Returns array with all defined formats.

Feedback, Comments & Corrections

XLBookMBS.InsertSheet(index as Integer, name as string = "", initSheet as XLSheetMBS = nil) as XLSheetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	11.3	Yes	Yes	Yes	Yes	No

Function: Inserts a new sheet to this book at position index, returns the sheet.
Notes: Use initSheet parameter if you wish to copy an existing sheet. Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.Load(path as folderitem) 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: Loads a xls-file into memory.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

With the constructor of the XLBookMBS object you decide if you want to load XML format or older binary format. If the format of the book object doesn't match the file, it will fail.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

Load(path as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.Load(path as string) 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: Loads a xls-file into memory.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

With the constructor of the XLBookMBS object you decide if you want to load XML format or older binary format. If the format of the book object doesn't match the file, it will fail.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

Load(path as folderitem) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadMT(path as folderitem) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	17.5	Yes	Yes	Yes	Yes	No

Function: Loads from file.
Notes:
Same as the other method without MT in name, except:

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

See also:

LoadMT(path as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadMT(path as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	17.5	Yes	Yes	Yes	Yes	No

Function: Loads from file.
Notes:
Same as the other method without MT in name, except:

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

See also:

LoadMT(path as folderitem) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadPartially(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	17.3	Yes	Yes	Yes	Yes	No

Function: Loads a file only with specified sheet index and row range into memory.
Notes: Returns false if error occurs or true on success.. Get error info with errorMessage function.

See also:

LoadPartially(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadPartially(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	17.3	Yes	Yes	Yes	Yes	No

Function: Loads a file only with specified sheet index and row range into memory.
Notes: Returns false if error occurs or true on success.. Get error info with errorMessage function.

See also:

LoadPartially(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadPartiallyUsingTempFile(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as folderitem) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	Console & Web	iOS
method	XL	MBS XL Plugin	17.3	Yes	Yes	Yes	Yes	No

Function: Loads a file only with specified sheet index and row range into memory.
Notes:
Specify a temporary file for reducing memory consumption.
Returns false if error occurs or true on success.. Get error info with errorMessage function.

See also:

LoadPartiallyUsingTempFile(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as String) as boolean

Feedback, Comments & Corrections

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

The biggest plugin in space...

Links
MBS Xojo tutorial videos