Platforms to show: All Mac Windows Linux Cross-Platform
Back to XLBookMBS class.
XLBookMBS.Save(path as folderitem) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
See also:
XLBookMBS.Save(path as folderitem, UseTempFile as Boolean) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
See also:
XLBookMBS.Save(path as string, UseTempFile as Boolean) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
XLBookMBS.SaveMT(path as string) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
XLBookMBS.SaveRaw(byref data as MemoryBlock) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 14.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with errorMessage property.
See also:
Some examples using this method:
XLBookMBS.SaveRaw(byref data as string) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns false if error occurs. Get error info with errorMessage property.
See also:
XLBookMBS.SaveRawMT(byref data as MemoryBlock) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
XLBookMBS.SaveRawMT(byref data as string) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 17.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
XLBookMBS.SetDefaultFont(fontName as string, fontSize as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XLBookMBS.SetKey(name as string, key as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Call this once for each XLBookMBS object and before you read or write data.
If you have keys for more than one platform, please use #if condition to make sure you pass right key for current platform.
XLBookMBS.SetKeyGlobal(name as string, key as string) Private
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 18.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please call shared method in app.open.
Because if you make a new object and set key, it's too late.
See also:
XLBookMBS.SetLocale(locale as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Sets the locale for this library. It has no effect for unicode projects.
XLBookMBS.SetPassword(Password as String)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 26.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Must be called on the book before calling the load functions.
XLBookMBS.Sheet(index as Integer) as XLSheetMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns nil if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLBookMBS.SheetCount as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
XLBookMBS.SheetName(index as integer) as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 26.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
To be used with the LoadInfo functions.
XLBookMBS.Sheets as XLSheetMBS()
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
XLBookMBS.SheetType(index as Integer) as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | XL | MBS XL Plugin | 13.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The items on this page are in the following plugins: MBS XL Plugin.