| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.SetColumn
Sets column width and format for all columns from colFirst to colLast.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.SetColumn"; bookRef; sheetIndex; colFirst; colLast; width { ; format; hidden } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref | |
| sheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 | |
| colFirst | The first column. First column has index 0. | $column | |
| colLast | The last column. | $column | |
| width | The width of the column. Value -1 is used for autofit column widths. |
5 | |
| format | The format index to use. You can use XL.Book.AddFormat to create new formats. |
$format | Optional |
| hidden | Whether to hide column. Default is 0. | 0 | Optional |
Result
Returns OK or error.
Description
Sets column width and format for all columns from colFirst to colLast.Column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. Columns may be hidden.
See also
- XL.Book.SheetCount
- XL.Format.SetNumFormat
- XL.LoadBook
- XL.Sheet.SetCellFormat
- XL.Sheet.SetColHidden
- XL.Sheet.SetColPx
- XL.Sheet.SetFooter
- XL.Sheet.SetHidden
- XL.Sheet.SetRowPx
- XL.Sheet.SetZoom
Release notes
- Version 13.0
- Fixed XL.Sheet.SetColumn and XL.Sheet.SetRow to better.
Blog Entries
This function checks for a license.
Created 18th August 2014, last changed 26th July 2019
