Platforms to show: All Mac Windows Linux Cross-Platform
XLBookMBS.AddCustomNumFormat(customNumFormat as string) as Integer
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
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.
XLBookMBS.AddFont(initFont as XLFontMBS = nil) as XLFontMBS
Function:
Adds a new font to the workbook, initial parameters can be copied from other font.
Notes: Returns NULL if error occurs.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns NULL if error occurs.
XLBookMBS.AddFormat(initFormat as XLFormatMBS = nil) as XLFormatMBS
Function:
Adds a new format to the workbook, initial parameters can be copied from other format.
Notes: Returns NULL if error occurs.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns NULL if error occurs.
XLBookMBS.AddPicture(path as folderitem) as Integer
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.AddPicture(path as string) as Integer
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.AddPictureData(data as string) as Integer
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns a picture identifier. Use picture identifier with XLSheetMBS.setPicture(). Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.AddSheet(name as string = "", initSheet as XLSheetMBS = nil) as XLSheetMBS
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes:
Use initSheet parameter if you wish to copy an existing sheet.
Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.BookVersion as Integer
Function:
Returns the version number of this book.
Example:
Notes:
Version number is encoded as hex number with major version, minor version and bugfix.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 13.0 | Yes | Yes | Yes | Yes | No |
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)
XLBookMBS.Constructor(xml as boolean = false)
Function:
Creates a new XLBookMBS object.
Notes: xml: If true, creates a book in xlsx format (xml), else one in xls format (binary).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: xml: If true, creates a book in xlsx format (xml), else one in xls format (binary).
XLBookMBS.CopyContent(dest as XLBookMBS, Options as XLCopyOptionsMBS = nil)
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 15.1 | Yes | Yes | Yes | Yes | No |
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.
XLBookMBS.CustomNumFormat(fmt as Integer) as string
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: See custom format string guidelines (in FAQ). Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.DefaultFont(byref fontSize as Integer) as string
Function:
Returns a default font name and size for this workbook.
Notes: Returns "" if error occurs. Get error info with XLBookMBS.ErrorMessage property.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns "" if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.DelSheet(index as Integer) as boolean
Function:
Deletes a sheet with specified index.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.Font(index as Integer) as XLFontMBS
Function:
Returns a font with defined index.
Notes: Index must be less than return value of fontCount method.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Index must be less than return value of fontCount method.
XLBookMBS.FontCount as Integer
Function:
Returns a number of fonts in this book.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
XLBookMBS.Fonts as XLFontMBS()
Function:
Returns array with all defined fonts.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
XLBookMBS.Format(index as Integer) as XLFormatMBS
Function:
Returns a format with defined index.
Notes: Index must be less than return value of formatCount method.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Index must be less than return value of formatCount method.
XLBookMBS.FormatCount as Integer
Function:
Returns a number of formats in this book.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
XLBookMBS.Formats as XLFormatMBS()
Function:
Returns array with all defined formats.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
XLBookMBS.InsertSheet(index as Integer, name as string = "", initSheet as XLSheetMBS = nil) as XLSheetMBS
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: Use initSheet parameter if you wish to copy an existing sheet. Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.Load(path as folderitem) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.Load(path as string) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.LoadMT(path as folderitem) as boolean
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 can yield time to other Xojo (Xojo) threads. For best user experience run this command on a Xojo (Xojo) thread, so your GUI stays responsive.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.5 | Yes | Yes | Yes | Yes | No |
Notes:
Same as the other method without MT in name, except:
The work is performed on a preemptive thread, so this function can yield time to other Xojo (Xojo) threads. For best user experience run this command on a Xojo (Xojo) thread, so your GUI stays responsive.
See also:
XLBookMBS.LoadMT(path as string) as boolean
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 can yield time to other Xojo (Xojo) threads. For best user experience run this command on a Xojo (Xojo) thread, so your GUI stays responsive.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.5 | Yes | Yes | Yes | Yes | No |
Notes:
Same as the other method without MT in name, except:
The work is performed on a preemptive thread, so this function can yield time to other Xojo (Xojo) threads. For best user experience run this command on a Xojo (Xojo) thread, so your GUI stays responsive.
See also:
XLBookMBS.LoadPartially(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns false if error occurs or true on success.. Get error info with errorMessage function.
See also:
XLBookMBS.LoadPartially(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns false if error occurs or true on success.. Get error info with errorMessage function.
See also:
XLBookMBS.LoadPartiallyUsingTempFile(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as folderitem) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.LoadPartiallyUsingTempFile(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as String) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 17.3 | Yes | Yes | Yes | Yes | No |
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:
XLBookMBS.LoadRaw(data as MemoryBlock) as boolean
Function:
Loads a xls-file from user's memory buffer.
Notes:
Returns false if error occurs. Get error info with 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | XL | MBS XL Plugin | 14.4 | Yes | Yes | Yes | Yes | No |
Notes:
Returns false if error occurs. Get error info with 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:
The items on this page are in the following plugins: MBS XL Plugin.
Links
MBS FileMaker Plugins
