XLBookMBS.PackDateTime(d as dateTime) as double

XLBookMBS.Picture(index as Integer, byref data as string) as Integer

Parameters:
index: position in the workbook
data: reference to buffer

Returns type of picture. See PictureType* constants.

XLBookMBS.PictureCount as Integer

XLBookMBS.Save(path as folderitem) as boolean

// create new Excel file, pass true for XLSX format or false for older XLS format
Dim book As New XLBookMBS(True)

// add sheet
Dim sheet As XLSheetMBS = book.addSheet("Test")
Call sheet.WriteString(2, 1, "Hello World", Nil)

// write file and launch
Dim file As FolderItem = SpecialFolder.Desktop.Child("Writing data.xlsx")

If book.Save(file) Then
  file.Launch
Else
  MsgBox "Failed to create file."+EndOfLine+EndOfLine+book.ErrorMessage
End If

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

XLBookMBS.Save(path as folderitem, UseTempFile as Boolean) as boolean

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

XLBookMBS.Save(path as string) as boolean

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

XLBookMBS.Save(path as string, UseTempFile as Boolean) as boolean

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

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

• SaveMT(path as string) as boolean

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

• SaveMT(path as folderitem) as boolean

XLBookMBS.SaveRaw(byref data as MemoryBlock) as boolean

Returns false if error occurs. Get error info with errorMessage property.

See also:

• SaveRaw(byref data as string) as boolean

Some examples using this method:

• /XL/Invoice with Template for Web/Invoice with Template for Web

XLBookMBS.SaveRaw(byref data as string) as boolean

Returns false if error occurs. Get error info with errorMessage property.

See also:

• SaveRaw(byref data as MemoryBlock) as boolean

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

• SaveRawMT(byref data as string) as boolean

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

• SaveRawMT(byref data as MemoryBlock) as boolean

XLBookMBS.SetDefaultFont(fontName as string, fontSize as Integer)

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

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

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)

Some examples using this method:

• /XL/AutoFilter by Top10
• /XL/AutoFilter Custom Filter
• /XL/AutoFilter Number Filter
• /XL/AutoFilter Sort
• /XL/Convert
• /XL/Generate
• /XL/Invoice with Template/Invoice with Template
• /XL/Invoice xml
• /XL/Styled Text
• /XL/Writing data

XLBookMBS.SetLocale(locale as string)

dim book as new XLBookMBS(false)
book.SetLocale "en_US.UTF-8"

Sets the locale for this library. It has no effect for unicode projects.

XLBookMBS.Sheet(index as Integer) as XLSheetMBS

Returns nil if error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLBookMBS.SheetCount as Integer

Some examples using this method:

• /XL/Edit

XLBookMBS.Sheets as XLSheetMBS()

Function SheetByName(book as XLBookMBS, name as string) As XLSheetMBS
  dim sheets() as XLSheetMBS = book.Sheets
  for each s as XLSheetMBS in sheets
    if s.Name = name then
      Return s
    end if
  next
End Function

Some examples using this method:

• /XL/Edit
• /XL/Extract
• /XL/List Hyperlinks

XLBookMBS.SheetType(index as Integer) as Integer

XLBookMBS.UnpackColor(ColorValue as Integer) as color

See also:

• UnpackColor(ColorValue as Integer, byref red as Integer, byref green as Integer, byref blue as Integer)

XLBookMBS.UnpackColor(ColorValue as Integer, byref red as Integer, byref green as Integer, byref blue as Integer)

See also:

• UnpackColor(ColorValue as Integer) as color

XLBookMBS.UnpackDate(Value as Double) as date

Returns nil if error occurs.

See also:

• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer) as boolean
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer) as boolean
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer, byref msec as Integer) as boolean

Some examples using this method:

• /XL/Extract

XLBookMBS.UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer) as boolean

Returns false if error occurs.

See also:

• UnpackDate(Value as Double) as date
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer) as boolean
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer, byref msec as Integer) as boolean

XLBookMBS.UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer) as boolean

Returns false if error occurs.

See also:

• UnpackDate(Value as Double) as date
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer) as boolean
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer, byref msec as Integer) as boolean

XLBookMBS.UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer, byref msec as Integer) as boolean

Returns false if error occurs.

See also:

• UnpackDate(Value as Double) as date
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer) as boolean
• UnpackDate(Value as Double, byref year as Integer, byref month as Integer, byref day as Integer, byref hour as Integer, byref min as Integer, byref sec as Integer) as boolean

XLBookMBS.UnpackDateTime(Value as double) as dateTime

Returns nil if error occurs.