XLBookMBS.BookRemoveVBA as boolean

It should be called after loading xlsm or xlsb files. Returns true if VBA scripts were found and removed.
Returns true on success and false on failure.

XLBookMBS.BookVersion as Integer

Var b as new XLBookMBS
Var v as Integer = b.BookVersion

Var h as Integer = v \ 256 \ 256 \ 256
Var m as Integer = v \ 256 \ 256       mod 256
Var l as Integer = v \ 256             mod 256

MsgBox "libXL "+str(h)+"."+str(m)+"."+str(l)

Version number is encoded as hex number with major version, minor version and bugfix.

XLBookMBS.Constructor(xml as boolean = false)

xml: If true, creates a book in xlsx format (xml), else one in xls format (binary).

XLBookMBS.CopyContent(dest as XLBookMBS, Options as XLCopyOptionsMBS = nil)

The plugin loops through all sheets and creates matching sheets on new book.
Formats and fonts are created on the fly.

This allows you to convert from XLS to XLSX or back.
Please report if something is not copied. Of course plugin can only copy what libXL supports, so stuff like movies or diagrams are not copied.

Some examples using this method:

• /XL/Convert

XLBookMBS.CoreProperties as XLCorePropertiesMBS

XLBookMBS.CustomNumFormat(fmt as Integer) as string

See custom format string guidelines (in FAQ). Returns NULL if error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLBookMBS.DefaultFont(byref fontSize as Integer) as string

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

XLBookMBS.DelSheet(index as Integer) as boolean

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

XLBookMBS.Font(index as Integer) as XLFontMBS

Index must be less than return value of fontCount method.

XLBookMBS.FontCount as Integer

XLBookMBS.Fonts as XLFontMBS()

XLBookMBS.Format(index as Integer) as XLFormatMBS

Index must be less than return value of formatCount method.

XLBookMBS.FormatCount as Integer

XLBookMBS.Formats as XLFormatMBS()

XLBookMBS.InsertSheet(index as Integer, name as string = "", initSheet as XLSheetMBS = nil) as XLSheetMBS

Use initSheet parameter if you wish to copy an existing sheet. Must be from the same book to copy sheet.

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

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

Returns false if error occurs and true on success.

XLBookMBS.PackColor(ColorValue as color) as Integer

// define a format for red fill
Var redBackgroundFormat As XLFormatMBS = book.AddFormat
Var c As Color = &cFF0000
// will give back numeric value of color for RGB mode or color index
Var n As Integer = book.PackColor(c)
// we set forecolor of the pattern to fill background!
redBackgroundFormat.PatternForegroundColor = n
redBackgroundFormat.PatternBackgroundColor = n
redBackgroundFormat.FillPattern = XLFormatMBS.FillPatternSolid

Var row As Integer = 5 // 6th row
Var col As Integer = 1 // Column B
Var value As Double = 123

Call sheet.WriteNumber row, col, value, redBackgroundFormat

See also:

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

Some examples using this method:

• /XL/Conditional formatting
• /XL/Invoice xml

XLBookMBS.PackColor(red as Integer, green as Integer, blue as Integer) as Integer

See also:

• PackColor(ColorValue as color) as Integer

XLBookMBS.PackDate(d as date) as Double

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

Some examples using this method:

• /XL/Generate

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

See also:

• PackDate(d as date) as Double

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.RemovePrinterSettings as boolean

It should be called after loading an Excel file. Returns true if printer settings were found and removed.
Returns true on success and false on failure.

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.