XLBookMBS.Load(path as folderitem) as boolean

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

XLBookMBS.Load(path as string) as boolean

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

XLBookMBS.LoadInfo(path as folderitem) as boolean

Var f As New FolderItem("/Users/cs/Desktop/test.xlsx", folderitem.PathModes.Native)
Var b As New XLBookMBS(True)

If b.LoadInfo(f) Then
  
  var names() as string
  Var c As Integer = b.SheetCount
  For i As Integer = 0 To c-1
    names.add b.SheetName(i)
  Next
  
  MessageBox Join(names, EndOfLine)
  
End If

Loads only information about sheets.
Afterwards you can call SheetCount() and SheetName(index).
Returns false if error occurs. Get an error info with the errorMessage property.

See also:

• LoadInfo(path as string) as boolean

XLBookMBS.LoadInfo(path as string) as boolean

Loads only information about sheets.
Afterwards you can call SheetCount() and SheetName(index).
Returns false if error occurs. Get an error info with the errorMessage property.

See also:

• LoadInfo(path as folderitem) as boolean

XLBookMBS.LoadInfoRaw(data as MemoryBlock) as boolean

Loads only information about sheets.
Afterwards you can call SheetCount() and SheetName(index).
Returns false if error occurs. Get an error info with the errorMessage property.

See also:

• LoadInfoRaw(data as string) as boolean

XLBookMBS.LoadInfoRaw(data as string) as boolean

Loads only information about sheets.
Afterwards you can call SheetCount() and SheetName(index).
Returns false if error occurs. Get an error info with the errorMessage property.

See also:

• LoadInfoRaw(data as MemoryBlock) as boolean

XLBookMBS.LoadMT(path as folderitem) as boolean

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

XLBookMBS.LoadMT(path as string) as boolean

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

XLBookMBS.LoadPartially(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

Returns false if error occurs or true on success.. Get error info with errorMessage function.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

See also:

• LoadPartially(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadPartially(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

Returns false if error occurs or true on success.. Get error info with errorMessage function.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

See also:

• LoadPartially(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadPartiallyUsingTempFile(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as folderitem, keepAllSheets as Boolean = false) as boolean

Specify a temporary file for reducing memory consumption.
Returns false if error occurs or true on success.. Get error info with errorMessage function.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

This is more a thing for 32-bit applications loading huge files where memory limits may be hit. On 64-bit applications you may not need a temporary file.

See also:

• LoadPartiallyUsingTempFile(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as String, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadPartiallyUsingTempFile(path as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as String, keepAllSheets as Boolean = false) as boolean

Specify a temporary file for reducing memory consumption.
Returns false if error occurs or true on success.. Get error info with errorMessage function.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

This is more a thing for 32-bit applications loading huge files where memory limits may be hit. On 64-bit applications you may not need a temporary file.

See also:

• LoadPartiallyUsingTempFile(path as folderitem, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, TempFile as folderitem, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadRaw(data as MemoryBlock) as boolean

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 string) as boolean

XLBookMBS.LoadRaw(data as string) as boolean

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

XLBookMBS.LoadRawMT(data as MemoryBlock) as boolean

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:

• LoadRawMT(data as string) as boolean

XLBookMBS.LoadRawMT(data as string) as boolean

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:

• LoadRawMT(data as MemoryBlock) as boolean

XLBookMBS.LoadRawPartially(data as MemoryBlock, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

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.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

See also:

• LoadRawPartially(data as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadRawPartially(data as string, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

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.

keepAllSheets parameter new in 14.2:
If this is true, all sheets are saved back with XL.Book.Save function,
But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.

See also:

• LoadRawPartially(data as MemoryBlock, sheetIndex as Integer, firstRow as Integer, lastRow as Integer, keepAllSheets as Boolean = false) as boolean

XLBookMBS.LoadUsingTempFile(path as folderitem, TempFile as folderitem) as boolean

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

XLBookMBS.LoadUsingTempFile(path as string, TempFile as String) as boolean

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