XLBookMBS.LoadRaw(data 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 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.

See also:

• LoadRaw(data as MemoryBlock) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadRawMT(data as MemoryBlock) 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 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.

See also:

• LoadRawMT(data as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadRawMT(data 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 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.

See also:

• LoadRawMT(data as MemoryBlock) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadRawPartially(data as MemoryBlock, 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 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.

See also:

• LoadRawPartially(data as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadRawPartially(data 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 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.

See also:

• LoadRawPartially(data as MemoryBlock, sheetIndex as Integer, firstRow as Integer, lastRow as Integer) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadUsingTempFile(path as folderitem, 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 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.

See also:

• LoadUsingTempFile(path as string, TempFile as String) as boolean

Feedback, Comments & Corrections

XLBookMBS.LoadUsingTempFile(path as string, TempFile as String) 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 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.

See also:

• LoadUsingTempFile(path as folderitem, TempFile as folderitem) as boolean

Feedback, Comments & Corrections

XLBookMBS.MoveSheet(SourceIndex as integer, DestIndex as Integer) as boolean

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

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.

Feedback, Comments & Corrections

XLBookMBS.PackColor(ColorValue as color) 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: Packs red, green and blue components in color type.

See also:

• PackColor(red as Integer, green as Integer, blue as Integer) as Integer

Feedback, Comments & Corrections

XLBookMBS.PackColor(red as Integer, green as Integer, blue 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: Packs red, green and blue components in color type.

See also:

• PackColor(ColorValue as color) as Integer

Feedback, Comments & Corrections

XLBookMBS.PackDate(d as date) 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: Packs date and time information into double type.

See also:

• 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

Feedback, Comments & Corrections

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

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

Function: Packs date and time information into double type.

See also:

• PackDate(d as date) as Double

Feedback, Comments & Corrections

XLBookMBS.Picture(index as Integer, byref 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: 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.

Feedback, Comments & Corrections

XLBookMBS.PictureCount 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 pictures in this workbook.

Feedback, Comments & Corrections

XLBookMBS.Save(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: Saves current workbook into xls-file.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

• Save(path as folderitem, UseTempFile as Boolean) as boolean
• Save(path as string) as boolean
• Save(path as string, UseTempFile as Boolean) as boolean

Feedback, Comments & Corrections

XLBookMBS.Save(path as folderitem, UseTempFile as Boolean) 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: 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.

See also:

• Save(path as folderitem) as boolean
• Save(path as string) as boolean
• Save(path as string, UseTempFile as Boolean) as boolean

Feedback, Comments & Corrections

XLBookMBS.Save(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: Saves current workbook into xls-file.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

• Save(path as folderitem) as boolean
• Save(path as folderitem, UseTempFile as Boolean) as boolean
• Save(path as string, UseTempFile as Boolean) as boolean

Feedback, Comments & Corrections

XLBookMBS.Save(path as string, UseTempFile as Boolean) 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: 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.

See also:

• Save(path as folderitem) as boolean
• Save(path as folderitem, UseTempFile as Boolean) as boolean
• Save(path as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveMT(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: 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.

See also:

• SaveMT(path as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveMT(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: 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.

See also:

• SaveMT(path as folderitem) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveRaw(byref data as MemoryBlock) as boolean

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

Function: Saves a xls-file to internal memory buffer.
Notes: Returns false if error occurs. Get error info with errorMessage property.

See also:

• SaveRaw(byref data as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveRaw(byref data 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: Saves a xls-file to internal memory buffer.
Notes: Returns false if error occurs. Get error info with errorMessage property.

See also:

• SaveRaw(byref data as MemoryBlock) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveRawMT(byref data as MemoryBlock) 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: 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.

See also:

• SaveRawMT(byref data as string) as boolean

Feedback, Comments & Corrections

XLBookMBS.SaveRawMT(byref data 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: 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.

See also:

• SaveRawMT(byref data as MemoryBlock) as boolean

Feedback, Comments & Corrections

XLBookMBS.SetDefaultFont(fontName as string, fontSize 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: Sets a default font name and size for this workbook.

Feedback, Comments & Corrections

XLBookMBS.SetKey(name as string, key 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: Sets customer's license key.
Notes:
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.

Feedback, Comments & Corrections

XLBookMBS.SetKeyGlobal(name as string, key as string)

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

Function: Private method to avoid you call this on an object.
Notes:
Please call shared method in app.open.
Because if you make a new object and set key, it's too late.

See also:

• SetKeyGlobal(name as string, key as string)

Feedback, Comments & Corrections

XLBookMBS.SetLocale(locale 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: Sets the locale.
Example:
Notes: Sets the locale for this library. It has no effect for unicode projects.

Feedback, Comments & Corrections

XLBookMBS.Sheet(index as Integer) 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: Gets the sheet with specified index.
Notes: Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLBookMBS.SheetCount 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 sheets in this book.

Feedback, Comments & Corrections