Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Component: XL

Read and Write Excel files.

You can import or export data from/to XML files in old (xls) or new format (xlsx).
Requires LibXL License (not included in MBS Plugin license)

Version macOS Windows Linux Server iOS SDK
2.9 / 14.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes

Item Details
XL.Book.AddConditionalFormat
Adds a new conditional format to the workbook for using with conditional formatting rules.
All
14.2
XL.Book.AddCustomNumFormat
Adds a new custom number format to the workbook.
All
3.5
XL.Book.AddFont
Adds a new font to the workbook, initial parameters can be copied from other font.
All
3.5
XL.Book.AddFontFromBook
Copies a font definition.
All
11.2
XL.Book.AddFormat
Adds a new format to the workbook, initial parameters can be copied from other format.
All
3.5
XL.Book.AddFormatFromBook
Copies a format definition.
All
11.2
XL.Book.AddPictureContainer
Adds a picture to the workbook from container.
All
3.5
XL.Book.AddPictureFile
Adds a picture to the workbook.
All
3.5
XL.Book.AddSheet
Adds a new sheet to this book, returns the sheet index.
All
3.5
XL.Book.BiffVersion
Returns BIFF version of binary file.
All
3.5
XL.Book.CustomNumFormat
Returns a custom format string for specified custom format identifier.
All
3.5
XL.Book.DeleteSheet
Deletes a sheet with specified index.
All
3.5
XL.Book.DeleteSheetsExcept
Deletes all sheets except the one with given name.
All
5.4
XL.Book.FontCount
Returns a number of fonts in this book.
All
3.5
XL.Book.FormatCount
Returns a number of formats in this book.
All
3.5
XL.Book.GetActiveSheet
Returns an active sheet index in this workbook.
All
3.5
XL.Book.GetCalcMode
Queries current calculation mode.
All
10.2
XL.Book.GetCoreProperty   New in 14.6
Queries a property.
All
14.6
XL.Book.GetDefaultFontName
Returns a default font name for this workbook.
All
3.5
XL.Book.GetDefaultFontSize
Returns a default font size for this workbook.
All
3.5
XL.Book.GetPicture
Returns a picture at position index.
All
3.5
XL.Book.GetPictureType
Returns a picture type at position index.
All
3.5
XL.Book.GetRGBMode
Returns whether the RGB mode is active.
All
3.5
XL.Book.GetRefR1C1
Returns whether the R1C1 reference mode is active.
All
3.5
XL.Book.GetText
Queries the text of a workbook.
All
3.5
XL.Book.InsertSheet
Inserts a new sheet to this book at position index, returns the new sheet index.
All
3.5
XL.Book.IsDate1904
Returns whether the 1904 date system is active.
All
7.2
XL.Book.IsTemplate
Returns whether the workbook is template.
All
7.2
XL.Book.IsWriteProtected
Queries whether the workbook is marked as read-only.
All
13.1
XL.Book.MoveSheet
Moves a sheet.
All
7.2
XL.Book.PictureCount
Returns a number of pictures in this workbook.
All
3.5
XL.Book.Release
Frees a workbook from memory.
All
3.5
XL.Book.ReleaseAll
Releases all books from memory.
All
10.0
XL.Book.RemoveAllCoreProperties   New in 14.6
Remove all workbook properties.
All
14.6
XL.Book.RemoveAllPhonetics   New in 14.6
Removes all phonetics data (furigana) from a workbook.
All
14.6
XL.Book.RemovePrinterSettings
Removes all printer settings from the workbook.
All
14.4
XL.Book.RemoveVBA
Removes all VBA scripts (macros) from the workbook.
All
14.4
XL.Book.Save
Writes excel file to container for storing in database.
All
3.5
XL.Book.SaveToFile
Saves current workbook into xls-file.
All
3.5
XL.Book.SetActiveSheet
Sets an active sheet index in this workbook.
All
3.5
XL.Book.SetCalcMode
Sets the current calculation mode.
All
10.2
XL.Book.SetCoreProperty   New in 14.6
Sets a property.
All
14.6
XL.Book.SetDate1904
Sets the date system mode.
All
7.2
XL.Book.SetDefaultFont
Sets a default font name and size for this workbook.
All
3.5
XL.Book.SetRGBMode
Sets a RGB mode.
All
3.5
XL.Book.SetRefR1C1
Sets the R1C1 reference mode.
All
3.5
XL.Book.SetTemplate
Sets the template flag.
All
7.2
XL.Book.SheetCount
Queries how many sheets are part of the workbook.
All
3.5
XL.Book.SheetIndexForName
Queries sheet index for sheet name.
All
5.4
XL.Book.Sheets
Queries list of sheet names.
All
5.4
XL.Book.Version
Queries version of XL library.
All
7.2
XL.Color.Pack
Packs red, green and blue components in color type.
All
3.5
XL.Color.UnPack
Unpacks color type to red, green and blue components.
All
3.5
XL.ConditionalFormat.Font
Returns the font for this format.
All
14.2
XL.ConditionalFormat.GetBorderBottom
Returns the bottom border style.
All
14.2
XL.ConditionalFormat.GetBorderBottomColor
Returns the color of the bottom border.
All
14.2
XL.ConditionalFormat.GetBorderLeft
Returns the left border style.
All
14.2
XL.ConditionalFormat.GetBorderLeftColor
Returns the color of the left border.
All
14.2
XL.ConditionalFormat.GetBorderRight
Returns the right border style.
All
14.2
XL.ConditionalFormat.GetBorderRightColor
Returns the color of the right border.
All
14.2
XL.ConditionalFormat.GetBorderTop
Returns the top border style.
All
14.2
XL.ConditionalFormat.GetBorderTopColor
Returns the color of the top border.
All
14.2
XL.ConditionalFormat.GetCustomNumFormat
Queries custom format string.
All
14.2
XL.ConditionalFormat.GetFillPattern
Returns the fill pattern.
All
14.2
XL.ConditionalFormat.GetNumFormat
Returns the number format identifier.
All
14.2
XL.ConditionalFormat.GetPatternBackgroundColor
Returns the background color of the fill pattern.
All
14.2
XL.ConditionalFormat.GetPatternForegroundColor
Returns the foreground color of the fill pattern.
All
14.2
XL.ConditionalFormat.SetBorder
Sets the border style.
All
14.2
XL.ConditionalFormat.SetBorderBottom
Sets the bottom border style.
All
14.2
XL.ConditionalFormat.SetBorderBottomColor
Sets the color of the bottom border.
All
14.2
XL.ConditionalFormat.SetBorderColor
Sets the border color.
All
14.2
XL.ConditionalFormat.SetBorderLeft
Sets the left border style.
All
14.2
XL.ConditionalFormat.SetBorderLeftColor
Sets the color of the left border.
All
14.2
XL.ConditionalFormat.SetBorderRight
Sets the right border style.
All
14.2
XL.ConditionalFormat.SetBorderRightColor
Sets the color of the right border.
All
14.2
XL.ConditionalFormat.SetBorderTop
Sets the top border style.
All
14.2
XL.ConditionalFormat.SetBorderTopColor
Sets the color of the top border.
All
14.2
XL.ConditionalFormat.SetCustomNumFormat
Sets a custom number format.
All
14.2
XL.ConditionalFormat.SetFillPattern
Sets the fill pattern.
All
14.2
XL.ConditionalFormat.SetNumFormat
Sets the number format identifier.
All
14.2
XL.ConditionalFormat.SetPatternBackgroundColor
Sets the background color of the fill pattern.
All
14.2
XL.ConditionalFormat.SetPatternForegroundColor
Sets the foreground color of the fill pattern.
All
14.2
XL.ConditionalFormating.Add2ColorScaleFormulaRule
Adds a conditional formatting rule that creates a gradated 2-color scale on the cells.
All
14.2
XL.ConditionalFormating.Add2ColorScaleRule
Adds a conditional formatting rule that creates a gradated 2-color scale on the cells.
All
14.2
XL.ConditionalFormating.Add3ColorScaleFormulaRule
Adds a conditional formatting rule that creates a gradated 3-color scale on the cells.
All
14.2
XL.ConditionalFormating.Add3ColorScaleRule
Adds a conditional formatting rule that creates a gradated 3-color scale on the cells.
All
14.2
XL.ConditionalFormating.AddAboveAverageRule
Adds a conditional formatting rule that highlights cells that are above or below the average for all values in the range.
All
14.2
XL.ConditionalFormating.AddOpNumRule
Adds a conditional formatting rule that highlights cells whose values are compared with a calculated result, using an operator.
All
14.2
XL.ConditionalFormating.AddOpStrRule
Adds a conditional formatting rule that highlights cells whose values are compared with a calculated result, using an operator.
All
14.2
XL.ConditionalFormating.AddRange
Adds a range to these conditional formatting rules.
All
14.2
XL.ConditionalFormating.AddRule
Adds a conditional formatting rule that highlights cells whose values correspond to the specified criteria.
All
14.2
XL.ConditionalFormating.AddTimePeriodRule
Adds a conditional formatting rule that highlights cells containing dates in the specified time period.
All
14.2
XL.ConditionalFormating.AddTopRule
Adds a conditional formatting rule that highlights cells whose values fall in the [top N] or [bottom N] bracket.
All
14.2
XL.CopyCellValue
Copies one cell.
All
11.2
XL.CopyColumn
Copies cells from one column to another column.
All
10.5
XL.CopyContent
Copies all content from one book to other book.
All
5.1
XL.CopyRow
Copies cells from one row to another row.
All
6.5
XL.CopySheet
Copies a sheet to another book.
All
6.5
XL.Date.DoubleToTimeStamp
Converts a timestamp number to a timestamp value.
All
5.0
XL.Date.Pack
Packs date and time information into double type.
All
3.5
XL.Date.TimeStampToDouble
Converts a date to a numeric value for writing in a number cell.
All
5.0
XL.Date.UnPack
Unpacks date and time information from double type.
All
3.5
XL.Font.GetBold
Returns whether the font is bold.
All
3.5
XL.Font.GetColor
Returns the color of the font.
All
3.5
XL.Font.GetItalic
Returns whether the font is italic.
All
3.5
XL.Font.GetName
Returns the name of the font.
All
3.5
XL.Font.GetScript
Returns the script style of the font.
All
3.5
XL.Font.GetSize
Returns the size of the font in points.
All
3.5
XL.Font.GetStrikeOut
Returns whether the font is strikeout.
All
3.5
XL.Font.GetUnderline
Returns the underline style of the font.
All
3.5
XL.Font.SetBold
Turns on/off the bold font.
All
3.5
XL.Font.SetColor
Sets the color of the font.
All
3.5
XL.Font.SetItalic
Turns on/off the italic font.
All
3.5
XL.Font.SetName
Sets the name of the font.
All
3.5
XL.Font.SetScript
Sets the script style of the font.
All
3.5
XL.Font.SetSize
Sets the size of the font in points.
All
3.5
XL.Font.SetStrikeOut
Turns on/off the strikeout font.
All
3.5
XL.Font.SetUnderline
Sets the underline style of the font.
All
3.5
XL.FormControl.AddItem
Adds the item to a list box or drop-down form control.
All
13.1
XL.FormControl.AltText
Returns alternative text for the object.
All
13.1
XL.FormControl.ClearItems
Clears all items from a list box or drop-down form control.
All
13.1
XL.FormControl.DefaultSize
Returns whether the object is at its default size.
All
13.1
XL.FormControl.Disabled
Returns whether the object is allowed to run an attached macro.
All
13.1
XL.FormControl.GetChecked
Queries the check state.
All
13.1
XL.FormControl.GetDropLines
Returns the number of lines in the drop-down before scroll bars are added.
All
13.1
XL.FormControl.GetDx
Returns the width of the scroll bar in pixels.
All
13.1
XL.FormControl.GetFirstButton
Returns whether the object is the first button in a set of radio buttons.
All
13.1
XL.FormControl.GetFmlaGroup
Queries group name.
All
13.1
XL.FormControl.GetFmlaRange
Returns the cell reference with range of source data cells.
All
13.1
XL.FormControl.GetFmlaTxbx
Queries the source for the control.
All
13.1
XL.FormControl.GetFromAnchor
Returns the bottom right location of a control within a document.
All
13.1
XL.FormControl.GetHoriz
Returns whether the scroll bar is horizontal.
All
13.1
XL.FormControl.GetInc
Queries increment.
All
13.1
XL.FormControl.GetMax
Queries maximum value.
All
13.1
XL.FormControl.GetMin
Queries minimum value.
All
13.1
XL.FormControl.GetMultiSel
Returns the indices of selected items as a comma-delimited list.
All
13.1
XL.FormControl.GetSet
Queries the index of the selected item.
All
13.1
XL.FormControl.GetToAnchor
Returns the top left location of a control within a document.
All
13.1
XL.FormControl.InsertItem
Inserts the item to the specified position to a list box or drop-down form control.
All
13.1
XL.FormControl.Item
Returns the item by index from a list box or drop-down form control.
All
13.1
XL.FormControl.ItemCount
Returns the number of items in a list box or drop-down form control.
All
13.1
XL.FormControl.JSON
Queries form controls as JSON.
All
14.0
XL.FormControl.LinkedCell
Returns the worksheet range linked to the control's value.
All
13.1
XL.FormControl.ListFillRange
Returns the range of source data cells used to populate the list box.
All
13.1
XL.FormControl.Locked
Returns whether the object is locked when the sheet is protected.
All
13.1
XL.FormControl.Macro
Returns the custom function associated with the object.
All
13.1
XL.FormControl.Name
Returns the name for this embedded control.
All
13.1
XL.FormControl.ObjectType
Returns the form control object type.
All
13.1
XL.FormControl.Print
Returns whether the object is printed when the document is printed.
All
13.1
XL.FormControl.SetChecked
Sets the check state.
All
13.1
XL.FormControl.SetDropLines
Sets the number of lines in the drop-down before scroll bars are added.
All
13.1
XL.FormControl.SetDx
Sets the width of the scroll bar in pixels.
All
13.1
XL.FormControl.SetFirstButton
Sets whether the object is the first button in a set of radio buttons.
All
13.1
XL.FormControl.SetFmlaGroup
Sets the cell reference in a group box is linked to.
All
13.1
XL.FormControl.SetFmlaRange
Sets the cell reference with range of source data cells.
All
13.1
XL.FormControl.SetFmlaTxbx
Sets the source.
All
13.1
XL.FormControl.SetHoriz
Sets whether the scroll bar is horizontal.
All
13.1
XL.FormControl.SetInc
Sets increment.
All
13.1
XL.FormControl.SetMax
Sets the maximum.
All
13.1
XL.FormControl.SetMin
Sets the minimum.
All
13.1
XL.FormControl.SetMultiSel
Sets the indices of selected items as a comma-delimited list.
All
13.1
XL.FormControl.SetSel
Sets the index of the selected item.
All
13.1
XL.Format.GetAlignH
Returns the horizontal alignment.
All
3.5
XL.Format.GetAlignV
Returns the vertical alignment.
All
3.5
XL.Format.GetBorderBottom
Returns the bottom border style.
All
3.5
XL.Format.GetBorderBottomColor
Returns the color of the bottom border.
All
3.5
XL.Format.GetBorderDiagonal
Returns the diagonal border.
All
3.5
XL.Format.GetBorderDiagonalColor
Returns the color of the diagonal border.
All
3.5
XL.Format.GetBorderDiagonalStyle
Gets the style for diagonal border.
All
3.5
XL.Format.GetBorderLeft
Returns the left border style.
All
3.5
XL.Format.GetBorderLeftColor
Returns the color of the left border.
All
3.5
XL.Format.GetBorderRight
Returns the right border style.
All
3.5
XL.Format.GetBorderRightColor
Returns the color of the right border.
All
3.5
XL.Format.GetBorderTop
Returns the top border style.
All
3.5
XL.Format.GetBorderTopColor
Returns the color of the top border.
All
3.5
XL.Format.GetFillPattern
Returns the fill pattern.
All
3.5
XL.Format.GetFont
Returns the font for this format.
All
3.5
XL.Format.GetHidden
Returns whether the hidden property is set to true.
All
3.5
XL.Format.GetIndent
Returns the text indentation level.
All
3.5
XL.Format.GetLocked
Returns whether the locked property is set to true.
All
3.5
XL.Format.GetNumFormat
Returns the number format identifier.
All
3.5
XL.Format.GetPatternBackgroundColor
Returns the background color of the fill pattern.
All
3.5
XL.Format.GetPatternForegroundColor
Returns the foreground color of the fill pattern.
All
3.5
XL.Format.GetRotation
Returns the text rotation.
All
3.5
XL.Format.GetShrinkToFit
Returns whether the cell is shrink-to-fit.
All
3.5
XL.Format.GetWrap
Returns whether the cell text is wrapped.
All
3.5
XL.Format.SetAlignH
Sets the horizontal alignment.
All
3.5
XL.Format.SetAlignV
Sets the vertical alignment.
All
3.5
XL.Format.SetBorder
Sets the border style.
All
3.5
XL.Format.SetBorderBottom
Sets the bottom border style.
All
3.5
XL.Format.SetBorderBottomColor
Sets the color of the bottom border.
All
3.5
XL.Format.SetBorderColor
Sets the border color.
All
3.5
XL.Format.SetBorderDiagonal
Sets the diagonal border.
All
3.5
XL.Format.SetBorderDiagonalColor
Sets the color of the diagonal border.
All
3.5
XL.Format.SetBorderDiagonalStyle
Sets the style for diagonal border.
All
3.5
XL.Format.SetBorderLeft
Sets the left border style.
All
3.5
XL.Format.SetBorderLeftColor
Sets the color of the left border.
All
3.5
XL.Format.SetBorderRight
Sets the right border style.
All
3.5
XL.Format.SetBorderRightColor
Sets the color of the right border.
All
3.5
XL.Format.SetBorderTop
Sets the top border style.
All
3.5
XL.Format.SetBorderTopColor
Sets the color of the top border.
All
3.5
XL.Format.SetFillPattern
Sets the fill pattern.
All
3.5
XL.Format.SetFont
Sets the font for the format.
All
3.5
XL.Format.SetHidden
Sets the hidden property.
All
3.5
XL.Format.SetIndent
Sets the text indentation level.
All
3.5
XL.Format.SetLocked
Sets the locked property.
All
3.5
XL.Format.SetNumFormat
Sets the number format identifier.
All
3.5
XL.Format.SetPatternBackgroundColor
Sets the background color of the fill pattern.
All
3.5
XL.Format.SetPatternForegroundColor
Sets the foreground color of the fill pattern.
All
3.5
XL.Format.SetRotation
Sets the text rotation.
All
3.5
XL.Format.SetShrinkToFit
Sets the flag whether the cell is shrink-to-fit.
All
3.5
XL.Format.SetWrap
Sets the flag whether the cell text is wrapped.
All
3.5
XL.Initialize
Initializes the XL library by loading it.
All
2.9
XL.IsInitialized
Checks if libXL library has been initialized.
All
4.2
XL.List
Lists all IDs of current XL books.
All
13.0
XL.LoadBook
Loads a Excel file.
All
2.9
XL.LoadBookPartially
Loads a Excel file partially.
All
8.0
XL.NewBook
Creates a new workbook in memory.
All
2.9
XL.Sheet.AddConditionalFormatting
Adds a conditional formatting rules to the sheet.
All
14.2
XL.Sheet.AddDataValidation
Adds a data validation for the specified range.
All
10.5
XL.Sheet.AddIgnoredError
Adds the ignored error for specified range.
All
7.2
XL.Sheet.AddSelectionRange
Adds a range to the selection.
All
13.1
XL.Sheet.AddrToRowCol
Converts a cell reference to row and column.
All
3.5
XL.Sheet.ApplyFilter
Applies the AutoFilter to the sheet.
All
7.2
XL.Sheet.AreCellsEmpty
Checks whether the cells in the given range are empty.
All
13.2
XL.Sheet.AutoFilter
Initializes the AutoFilter.
All
7.2
XL.Sheet.AutoFilter.AddFilter
Adds the filter value.
All
7.3
XL.Sheet.AutoFilter.AddSort
Adds the sorted column in AutoFilter by zero-based index and its sort order.
All
11.5
XL.Sheet.AutoFilter.Clear
Clear the filter criteria.
All
7.3
XL.Sheet.AutoFilter.ColumnSize
Returns the number of specified AutoFilter columns which have a filter information.
All
7.2
XL.Sheet.AutoFilter.Filter
Returns the filter value by index.
All
7.3
XL.Sheet.AutoFilter.FilterSize
Returns the number of filter values.
All
7.3
XL.Sheet.AutoFilter.FilterType
Returns the filter type of this AutoFilter column.
All
7.3
XL.Sheet.AutoFilter.GetCustomFilter
Gets the custom filter criteria.
All
7.3
XL.Sheet.AutoFilter.GetRef
Gets the cell range of AutoFilter with header.
All
7.2
XL.Sheet.AutoFilter.GetSort
Gets the zero-based index of sorted column in AutoFilter and its sort order.
All
7.2
XL.Sheet.AutoFilter.GetSortRange
Gets the whole range of data to sort.
All
7.2
XL.Sheet.AutoFilter.GetTop10
Gets the number of top or bottom items.
All
7.3
XL.Sheet.AutoFilter.SetCustomFilter
Sets the custom filter criteria.
All
7.3
XL.Sheet.AutoFilter.SetRef
Sets the cell range of AutoFilter with header.
All
7.2
XL.Sheet.AutoFilter.SetSort
Sets the sorted column in AutoFilter by zero-based index and its sort order.
All
7.2
XL.Sheet.AutoFilter.SetTop10
Sets the number of top or bottom items.
All
7.3
XL.Sheet.CellIsDate
Checks that cell contains a date or time value.
All
3.5
XL.Sheet.CellIsFormula
Checks that cell contains a formula.
All
3.5
XL.Sheet.CellIsStyledText
Queries whether cell has styled text.
All
10.2
XL.Sheet.CellReadBlank
Checks if cell is blank.
All
3.5
XL.Sheet.CellReadBoolean
Reads a boolean value from a cell.
All
3.5
XL.Sheet.CellReadBooleans
Reads all the boolean values in an area.
All
8.0
XL.Sheet.CellReadComment
Reads a comment value from a cell.
All
3.5
XL.Sheet.CellReadComments
Reads all the comments from cells in an area.
All
8.0
XL.Sheet.CellReadDate
Reads a number value from a cell.
All
5.0
XL.Sheet.CellReadDates
Reads all the dates from cells in an area.
All
8.0
XL.Sheet.CellReadFormula
Reads the formula value from a cell.
All
3.5
XL.Sheet.CellReadFormulas
Reads all the formulas from cells in an area.
All
8.0
XL.Sheet.CellReadNumber
Reads a number value from a cell.
All
3.5
XL.Sheet.CellReadNumbers
Reads all the numbers from cells in an area.
All
8.0
XL.Sheet.CellReadStyledText
Reads a styled text value from a cell.
All
10.2
XL.Sheet.CellReadText
Reads a text value from a cell.
All
3.5
XL.Sheet.CellReadTexts
Reads all the texts from cells in an area.
All
8.0
XL.Sheet.CellReadValue
Reads a value value from a cell.
All
10.5
XL.Sheet.CellReadValues
Reads all the values from cells in an area.
All
11.5
XL.Sheet.CellType
Queries type of cell.
All
3.5
XL.Sheet.CellWriteBlank
Writes a blank cell.
All
3.5
XL.Sheet.CellWriteBlanks
Writes blanks to an area of cells.
All
8.0
XL.Sheet.CellWriteBoolean
Writes a boolean value into cell.
All
3.5
XL.Sheet.CellWriteBooleans
Writes booleans to an area of cells.
All
8.0
XL.Sheet.CellWriteComment
Writes a comment to a cell.
All
3.5
XL.Sheet.CellWriteComments
Writes comments to an area of cells.
All
8.0
XL.Sheet.CellWriteDate
Writes a number into cell.
All
5.0
XL.Sheet.CellWriteDates
Writes dates to an area of cells.
All
8.0
XL.Sheet.CellWriteError
Writes error into the cell with specified format.
All
7.2
XL.Sheet.CellWriteFormula
Writes a formula into cell.
All
3.5
XL.Sheet.CellWriteFormulaBoolean
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulaNumber
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulaText
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulas
Writes formulas to an area of cells.
All
8.0
XL.Sheet.CellWriteMatrix
Writes cell values from matrix.
All
13.3
XL.Sheet.CellWriteNumber
Writes a number into cell.
All
3.5
XL.Sheet.CellWriteNumbers
Writes numbers to an area of cells.
All
8.0
XL.Sheet.CellWriteStyledText
Writes a styled text into a cell.
All
10.2
XL.Sheet.CellWriteText
Writes a string into cell.
All
3.5
XL.Sheet.CellWriteTextAsNumber
Writes a number into cell, but passes it as text.
All
10.3
XL.Sheet.CellWriteTexts
Writes texts to an area of cells.
All
8.0
XL.Sheet.Clear
Clears cells in specified area.
All
3.5
XL.Sheet.ClearPrintArea
Clears the print area.
All
3.5
XL.Sheet.ClearPrintRepeats
Clears repeated rows and columns on each page.
All
3.5
XL.Sheet.ColFormat   New in 14.6
Returns column's format.
All
14.6
XL.Sheet.CopyCell
Copies cell with format from (rowSrc, colSrc) to (rowDst, colDst).
All
3.5
XL.Sheet.DefaultRowHeight
Returns the default row height measured in point size.
All
13.1
XL.Sheet.DelMergeByIndex
Removes merged cells by index.
All
4.3
XL.Sheet.DeleteMerge
Removes merged cells.
All
3.5
XL.Sheet.DeleteNamedRange
Deletes the named range by name.
All
3.5
XL.Sheet.FormControlCount
Queries number of form controls.
All
13.1
XL.Sheet.GetActiveCell
Gets an active cell of the sheet.
All
13.1
XL.Sheet.GetCellError
Reads error from cell.
All
3.5
XL.Sheet.GetCellErrors
Reads all the errors from cells in an area.
All
8.0
XL.Sheet.GetCellFormat
Returns cell's format.
All
3.5
XL.Sheet.GetCellFormats
Reads all the formats from cells in an area.
All
8.0
XL.Sheet.GetCellPicture
Queries picture for a cell.
All
11.5
XL.Sheet.GetColHidden
Returns whether column is hidden.
All
3.5
XL.Sheet.GetColWidth
Returns column width in points.
All
3.5
XL.Sheet.GetColWidthPixel
Returns column width in pixel.
All
10.2
XL.Sheet.GetDisplayGridlines
Returns whether the gridlines are displayed.
All
3.5
XL.Sheet.GetFirstCol
Returns the first column in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetFirstFilledCol
Returns the first column in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetFirstFilledRow
Returns the first row in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetFirstRow
Returns the first row in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetFooter
Returns the footer text of the sheet when printed.
All
3.5
XL.Sheet.GetFooterMargin
Returns the footer margin in inches.
All
3.5
XL.Sheet.GetGroupSummaryBelow
Returns whether grouping rows summary is below.
All
3.5
XL.Sheet.GetGroupSummaryRight
Returns whether grouping columns summary is right.
All
3.5
XL.Sheet.GetHCenter
Returns whether the sheet is centered horizontally when printed.
All
3.5
XL.Sheet.GetHeader
Returns the header text of the sheet when printed.
All
3.5
XL.Sheet.GetHeaderMargin
Returns the header margin in inches.
All
3.5
XL.Sheet.GetHidden
Returns whether sheet is hidden.
All
3.5
XL.Sheet.GetHorPageBreak
Returns row with horizontal page break at position index.
All
3.5
XL.Sheet.GetHorPageBreakCount
Returns a number of horizontal page breaks in the sheet.
All
3.5
XL.Sheet.GetLandscape
Returns a page orientation mode.
All
3.5
XL.Sheet.GetLastCol
Returns the zero-based index of the column after the last column in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetLastFilledCol
Returns the zero-based index of the column after the last column in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetLastFilledRow
Returns the zero-based index of the row after the last row in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetLastRow
Returns the zero-based index of the row after the last row in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetMarginBottom
Returns the bottom margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginLeft
Returns the left margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginRight
Returns the right margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginTop
Returns the top margin of the sheet in inches.
All
3.5
XL.Sheet.GetMerge
Gets merged cells for cell at row, col.
All
3.5
XL.Sheet.GetName
Returns the name of the sheet.
All
3.5
XL.Sheet.GetNamedRange
Gets the named range coordianates by name.
All
3.5
XL.Sheet.GetPaper
Returns the paper size.
All
3.5
XL.Sheet.GetPicture
Returns a workbook picture index at position index in worksheet.
All
3.5
XL.Sheet.GetPrintArea
Gets the print area.
All
5.1
XL.Sheet.GetPrintFit
Returns whether fit to page option is enabled.
All
3.5
XL.Sheet.GetPrintGridlines
Returns whether the gridlines are printed.
All
3.5
XL.Sheet.GetPrintRepeatCols
Gets repeated columns on each page from colFirst to colLast.
All
5.1
XL.Sheet.GetPrintRepeatRows
Gets repeated rows on each page from rowFirst to rowLast.
All
5.1
XL.Sheet.GetPrintRow
Returns whether the row and column headers are printed.
All
3.5
XL.Sheet.GetPrintZoom
Returns the scaling factor for printing as a percentage.
All
3.5
XL.Sheet.GetProtect
Returns whether sheet is protected.
All
3.5
XL.Sheet.GetRowHeight
Returns row height in points.
All
3.5
XL.Sheet.GetRowHeightPixel
Returns row height in pixels.
All
10.2
XL.Sheet.GetRowHidden
Returns whether row is hidden.
All
3.5
XL.Sheet.GetTabColor
Queries the sheet's tab color.
All
13.1
XL.Sheet.GetTabColorRGB
Queries the sheet's tab RGB color.
All
13.1
XL.Sheet.GetText
Queries the text of a sheet in a workbook.
All
3.5
XL.Sheet.GetTopLeftView
Extracts the first visible row and the leftmost visible column of the sheet.
All
3.5
XL.Sheet.GetVCenter
Returns whether the sheet is centered vertically when printed.
All
3.5
XL.Sheet.GetVerPageBreak
Returns column with vertical page break at position index.
All
3.5
XL.Sheet.GetVerPageBreakCount
Returns a number of vertical page breaks in the sheet.
All
3.5
XL.Sheet.GetZoom
Returns the zoom level of the current view as a percentage.
All
3.5
XL.Sheet.GroupCols
Groups columns from colFirst to colLast.
All
3.5
XL.Sheet.GroupRows
Groups rows from rowFirst to rowLast.
All
3.5
XL.Sheet.HyperlinkIndex
Checks if the cell contains a hyperlink.
All
13.2
XL.Sheet.HyperlinkSize
Returns the number of hyperlinks in the sheet.
All
4.3
XL.Sheet.InsertCol
Inserts columns from colFirst to colLast.
All
3.5
XL.Sheet.InsertRow
Inserts rows from rowFirst to rowLast.
All
3.5
XL.Sheet.IsAutoFilter
Whether this sheet has an auto filter.
All
11.5
XL.Sheet.Merge
Gets the merged cells by index.
All
4.3
XL.Sheet.MergeSize
Returns a number of merged cells in this worksheet.
All
4.3
XL.Sheet.NamedRange
Gets the named range coordinates by index.
All
3.5
XL.Sheet.NamedRangeCount
Returns the number of named ranges in the sheet.
All
3.5
XL.Sheet.PictureCount
Returns a number of pictures in this worksheet.
All
3.5
XL.Sheet.ReadCellsAsMatrix
Reads all the values from cells in an area into a new matrix.
All
13.0
XL.Sheet.RemoveCol
Removes columns from colFirst to colLast.
All
3.5
XL.Sheet.RemoveComment
Removes a comment from a cell.
All
6.5
XL.Sheet.RemoveComments
Removes comments in given area.
All
8.0
XL.Sheet.RemoveDataValidations
Removes all data validations for the sheet.
All
10.5
XL.Sheet.RemoveFilter
Removes the AutoFilter from the sheet.
All
7.2
XL.Sheet.RemovePicture
Removes a picture from a cell.
All
10.2
XL.Sheet.RemovePictureByIndex
Removes a picture by index.
All
10.2
XL.Sheet.RemoveRow
Removes rows from rowFirst to rowLast.
All
3.5
XL.Sheet.RemoveSelection
Removes all selection.
All
13.1
XL.Sheet.RightToLeft
Returns whether the text is displayed in right-to-left mode.
All
7.2
XL.Sheet.RowColToAddr
Converts row and column to a cell reference.
All
3.5
XL.Sheet.RowFormat   New in 14.6
Returns row's format.
All
14.6
XL.Sheet.SelectionRange
Returns a range of the selection.
All
13.1
XL.Sheet.SetActiveCell
Sets an active cell of the sheet.
All
13.1
XL.Sheet.SetAutoFitArea
Sets the borders for autofit column widths feature.
All
5.1
XL.Sheet.SetCellFormat
Sets cell's format.
All
3.5
XL.Sheet.SetCellFormats
Set cell formats in given area.
All
8.0
XL.Sheet.SetCol
Sets column width and format for all columns from colFirst to colLast.
All
3.5
XL.Sheet.SetColHidden
Hides or shows a column.
All
3.5
XL.Sheet.SetColPx
Sets column width in pixels and format for all columns from colFirst to colLast.
All
13.3
XL.Sheet.SetColumn
Sets column width and format for all columns from colFirst to colLast.
All
3.5
XL.Sheet.SetDefaultRowHeight
Sets the default row height measured in point size.
All
13.1
XL.Sheet.SetDisplayGridlines
Sets gridlines for displaying.
All
3.5
XL.Sheet.SetFooter
Sets the footer text for the sheet when printed.
All
3.5
XL.Sheet.SetGroupSummaryBelow
Sets a flag of grouping rows summary.
All
3.5
XL.Sheet.SetGroupSummaryRight
Sets a flag of grouping rows summary.
All
3.5
XL.Sheet.SetHCenter
Sets a flag that the sheet is centered horizontally when printed.
All
3.5
XL.Sheet.SetHeader
Sets the header text of the sheet when printed.
All
3.5
XL.Sheet.SetHidden
Hides/unhides the sheet. Returns false if error occurs.
All
13.4
XL.Sheet.SetHorPageBreak
Sets/removes a horizontal page break.
All
3.5
XL.Sheet.SetLandscape
Sets landscape or portrait mode for printing.
All
3.5
XL.Sheet.SetMarginBottom
Sets the bottom margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginLeft
Sets the left margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginRight
Sets the right margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginTop
Sets the top margin of the sheet in inches.
All
3.5
XL.Sheet.SetMerge
Sets merged cells for range: rowFirst - rowLast, colFirst - colLast.
All
3.5
XL.Sheet.SetName
Sets the name of the sheet.
All
3.5
XL.Sheet.SetNamedRange
Sets the named range.
All
3.5
XL.Sheet.SetPaper
Sets the paper size.
All
3.5
XL.Sheet.SetPictureWithScale
Sets a picture with pictureId identifier at position row and col with scale factor and offsets in pixels.
All
3.5
XL.Sheet.SetPictureWithSize
Sets a picture with pictureId identifier at position row and col with custom size and offsets in pixels.
All
3.5
XL.Sheet.SetPrintArea
Sets the print area.
All
3.5
XL.Sheet.SetPrintFit
Fits sheet width and sheet height to wPages and hPages respectively.
All
3.5
XL.Sheet.SetPrintGridlines
Sets gridlines for printing.
All
3.5
XL.Sheet.SetPrintRepeatCols
Sets repeated columns on each page from colFirst to colLast.
All
3.5
XL.Sheet.SetPrintRepeatRows
Sets repeated rows on each page from rowFirst to rowLast.
All
3.5
XL.Sheet.SetPrintRow
Sets a flag that the row and column headers are printed.
All
3.5
XL.Sheet.SetPrintZoom
Sets the scaling factor for printing as a percentage.
All
3.5
XL.Sheet.SetProtect
Protects/unprotects the sheet.
All
3.5
XL.Sheet.SetProtectEx
Protects/unprotects the sheet with password and enhanced parameters below.
All
7.2
XL.Sheet.SetRightToLeft
Sets the right-to-left mode.
All
7.2
XL.Sheet.SetRow
Sets row height and format.
All
3.5
XL.Sheet.SetRowHidden
Hides or shows a row.
All
3.5
XL.Sheet.SetRowPx
Sets column width in pixels and format for all columns from colFirst to colLast.
All
13.3
XL.Sheet.SetRows
Sets row height and format for multiple rows.
All
11.2
XL.Sheet.SetTabColor
Sets the color for the sheet's tab.
All
7.2
XL.Sheet.SetTabColorRGB
Sets the RGB color for the sheet's tab.
All
7.2
XL.Sheet.SetTopLeftView
Sets the first visible row and the leftmost visible column of the sheet.
All
3.5
XL.Sheet.SetVCenter
ets a flag that the sheet is centered vertically when printed.
All
3.5
XL.Sheet.SetVerPageBreak
Sets/removes a vertical page break.
All
3.5
XL.Sheet.SetZoom
Sets the zoom level of the current view.
All
3.5
XL.Sheet.Split
Splits a sheet at position (row, col).
All
3.5
XL.Sheet.SplitInfo
Gets the split information (position of frozen pane) in the sheet.
All
4.3
XL.Sheet.Table
Gets the table parameters by index.
All
7.2
XL.Sheet.TableSize
Returns the number of tables in the sheet.
All
7.2
XL.Sheet.Type
Returns type of sheet with specified index.
All
7.2
XL.Uninitialize
Uninitializes XL library.
All
10.1

435 functions shown.

These functions require a license (77%).

Release notes

Blog Entries

FileMaker Magazin

Example Databases