Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.
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
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:
XLBookMBS.LoadRaw(data as string) 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 | 11.3 | 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:
XLBookMBS.LoadRawMT(data as MemoryBlock) as boolean
Function:
Loads from memoryblock.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
XLBookMBS.LoadRawMT(data as string) as boolean
Function:
Loads from string.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
XLBookMBS.LoadRawPartially(data as MemoryBlock, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean
Function:
Loads a file from user's memory buffer.
Notes:
data: Data buffer
sheetIndex: loads a file only with specified sheet index, -1 loads all sheets
firstRow: the first row of loaded range, -1 loads all rows until lastRow
lastRow: the last row of loaded range, -1 loads all rows after firstRow.
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:
data: Data buffer
sheetIndex: loads a file only with specified sheet index, -1 loads all sheets
firstRow: the first row of loaded range, -1 loads all rows until lastRow
lastRow: the last row of loaded range, -1 loads all rows after firstRow.
Returns false if error occurs or true on success. Get error info with errorMessage function.
See also:
XLBookMBS.LoadRawPartially(data as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean
Function:
Loads a file from user's memory buffer.
Notes:
data: Data buffer
sheetIndex: loads a file only with specified sheet index, -1 loads all sheets
firstRow: the first row of loaded range, -1 loads all rows until lastRow
lastRow: the last row of loaded range, -1 loads all rows after firstRow.
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:
data: Data buffer
sheetIndex: loads a file only with specified sheet index, -1 loads all sheets
firstRow: the first row of loaded range, -1 loads all rows until lastRow
lastRow: the last row of loaded range, -1 loads all rows after firstRow.
Returns false if error occurs or true on success. Get error info with errorMessage function.
See also:
XLBookMBS.LoadUsingTempFile(path as folderitem, TempFile as folderitem) as boolean
Function:
Loads an entire file 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.LoadUsingTempFile(path as string, TempFile as String) as boolean
Function:
Loads an entire file 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.MoveSheet(SourceIndex as integer, DestIndex as Integer) as boolean
Function:
Takes a sheet with SourceIndex and insert it in front of a sheet with DestIndex.
Notes: Returns false if error occurs and true on success.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 17.2 | Yes | Yes | Yes | Yes | No |
Notes: Returns false if error occurs and true on success.
XLBookMBS.PackColor(ColorValue as color) as Integer
Function:
Packs red, green and blue components in color type.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
See also:
XLBookMBS.PackColor(red as Integer, green as Integer, blue as Integer) as Integer
Function:
Packs red, green and blue components in color type.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
See also:
XLBookMBS.PackDate(d as date) as Double
Function:
Packs date and time information into double type.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
See also:
XLBookMBS.PackDate(year as Integer, month as Integer, day as Integer, hour as Integer = 0, min as Integer = 0, sec as Integer = 0, msec as Integer = 0) as Double
Function:
Packs date and time information into double type.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
See also:
XLBookMBS.Picture(index as Integer, byref data as string) as Integer
Function:
Returns a picture at position index in memory buffer.
Notes:
Parameters:
index: position in the workbook
data: reference to buffer
Returns type of picture. See PictureType* constants.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes:
Parameters:
index: position in the workbook
data: reference to buffer
Returns type of picture. See PictureType* constants.
XLBookMBS.PictureCount as Integer
Function:
Returns a number of pictures in this workbook.
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
method | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
XLBookMBS.RefR1C1 as Integer
Function:
Whether the R1C1 reference mode is active.
Notes: (Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
property | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes: (Read and Write computed property)
XLBookMBS.RgbMode as boolean
Function:
Whether the RGB mode is active. Used for xlsx format only.
Notes:
true - RGB mode, false - Index mode (default).
In RGB mode use colorPack() and colorUnpack() methods for getting/setting colors. Used for xlsx format only.
(Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
property | XL | MBS XL Plugin | 11.3 | Yes | Yes | Yes | Yes | No |
Notes:
true - RGB mode, false - Index mode (default).
In RGB mode use colorPack() and colorUnpack() methods for getting/setting colors. Used for xlsx format only.
(Read and Write computed property)
XLBookMBS.Save(path as folderitem) as boolean
Function:
Saves current workbook into xls-file.
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.
See also:
XLBookMBS.Save(path as folderitem, UseTempFile as Boolean) as boolean
Function:
Saves current workbook into the file.
Notes:
Use 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:
Use 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.Save(path as string) as boolean
Function:
Saves current workbook into xls-file.
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.
See also:
XLBookMBS.Save(path as string, UseTempFile as Boolean) as boolean
Function:
Saves current workbook into the file.
Notes:
Use 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:
Use 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.SaveMT(path as folderitem) as boolean
Function:
Saves document to file on disk.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
XLBookMBS.SaveMT(path as string) as boolean
Function:
Saves document to file on disk.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
XLBookMBS.SaveRaw(byref data as MemoryBlock) as boolean
Function:
Saves a xls-file to internal memory buffer.
Notes: Returns false if error occurs. Get error info with errorMessage property.
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.
See also:
XLBookMBS.SaveRaw(byref data as string) as boolean
Function:
Saves a xls-file to internal memory buffer.
Notes: Returns false if error occurs. Get error info with 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 errorMessage property.
See also:
XLBookMBS.SaveRawMT(byref data as MemoryBlock) as boolean
Function:
Saves document to memoryblock.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
XLBookMBS.SaveRawMT(byref data as string) as boolean
Function:
Saves document to string.
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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) 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 (Real Studio) threads. For best user experience run this command on a Xojo (Real Studio) thread, so your GUI stays responsive.
See also:
The items on this page are in the following plugins: MBS XL Plugin.
Links
MBS Xojo tutorial videos