Class RangeColumn
A class that represents a single column of cells.
Inherited Members
Namespace: IronXL
Assembly: IronXL.dll
Syntax
public class RangeColumn : Range, IEnumerable<Cell>, IEnumerableProperties
ColumnLetter
Gets the letter anme of the column.
Declaration
public string ColumnLetter { get; }Property Value
| Type | Description |
|---|---|
| System.String |
ColumnNumber
0-based index of the column.
Declaration
public int ColumnNumber { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Hidden
Gets or sets a value indicating whether this column is hidden.
Declaration
public bool Hidden { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Width
Gets or sets the width of the column.
Declaration
public int Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
AutoSizeColumn()
Changes width of the column to fit the content based on font measurements.
This method measures the text in the cell based on the font that is used for the cell.
If the exact font is not found on the machine, it will try to measure with a default font (Arial).
------------------------------------------------
Usage:
// Auto-size column B to fit its content
var workbook = WorkBook.Load("example.xlsx");
var sheet = workbook.DefaultWorkSheet;
var column = sheet.GetColumn(1); // Column B (0-indexed)
column.AutoSizeColumn();
workbook.SaveAs("autosized.xlsx");------------------------------------------------
Declaration
public void AutoSizeColumn()Remarks
Important Considerations:
⚠️ Font Availability: The exact font must be installed on the system for accurate measurements.
📝 Note: This overload does not consider merged cells. Use AutoSizeColumn(true) to include merged cells.
Related Documentation:📖 How-To Guide:AutoSize Rows and Columns Guide
📚 API Reference:RangeColumn API Documentation
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | Thrown when the column cannot be auto-sized. |
| SixLabors.Fonts.FontException | Thrown when no fonts are found installed on the machine. |
AutoSizeColumn(Boolean)
Changes width of the column to fit the content based on font measurements.
This method measures the text in the cell based on the font that is used for the cell.
If the exact font is not found on the machine, it will try to measure with a default font (Arial).
------------------------------------------------
Usage:
// Auto-size column B including merged cells
var workbook = WorkBook.Load("example.xlsx");
var sheet = workbook.DefaultWorkSheet;
var column = sheet.GetColumn(1); // Column B (0-indexed)
column.AutoSizeColumn(true); // Include merged cells
workbook.SaveAs("autosized.xlsx");------------------------------------------------
Declaration
public void AutoSizeColumn(bool useMergedCells)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | useMergedCells | If true, the width of merged cells will be taken into account. |
Remarks
Important Considerations:
⚠️ Font Availability: The exact font must be installed on the system for accurate measurements.
📝 Merged Cells: When useMergedCells is true, the width calculation considers cells that span multiple columns.
🎯 Long Text: Ensures column width accommodates the longest text content in the column.
Related Documentation:📖 How-To Guide:AutoSize Rows and Columns Guide
📚 API Reference:RangeColumn API Documentation
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | Thrown when the column cannot be auto-sized. |
| SixLabors.Fonts.FontException | Thrown when no fonts are found installed on the machine. |
RemoveColumn()
Removes the column from the worksheet.
Declaration
public void RemoveColumn()