Class RangeColumn

A class that represents a single column of cells.

Inheritance

System.Object

Range

RangeColumn

Implements

System.Collections.Generic.IEnumerable<Cell>

System.Collections.IEnumerable

Inherited Members

Range.ClearContents()

Range.GetEnumerator()

Range.ToArray()

Range.Sum()

Range.Max()

Range.Min()

Range.Avg()

Range.AddRange(Range)

Range.AddRange(RangeAddress)

Range.SubtractRange(Range)

Range.SubtractRange(RangeAddress)

Range.RemoveRow(Int32)

Range.RemoveRow(RangeRow)

Range.RemoveColumn(String)

Range.RemoveColumn(Int32)

Range.RemoveColumn(RangeColumn)

Range.InsertRow(Int32)

Range.InsertRows(Int32, Int32)

Range.InsertColumn(Int32)

Range.InsertColumn(String)

Range.InsertColumns(String, Int32)

Range.InsertColumns(Int32, Int32)

Range.SortAscending()

Range.SortDescending()

Range.SortByColumn(String, SortOrder)

Range.SortByColumn(Int32, SortOrder)

Range.Trim()

Range.ToDataTable(Boolean)

Range.SetCellValue(Int32, Int32, Object)

Range.GetValue<TType>()

Range.TryGetValue<TType>(TType)

Range.ToString()

Range.Copy(WorkSheet, String)

Range.Replace(String, String)

Range.SaveAsNamedTable(String, Boolean, TableStyle, Boolean)

Range.SaveAsNamedRange(String, Boolean)

Range.Row(Int32)

Range.Column(Int32)

Range.RangeAddress

Range.RangeAddressAsString

Range.Count

Range.ColumnCount

Range.RowCount

Range.Style

Range.WorkBook

Range.IsEmpty

Range.Rows

Range.Columns

Range.Value

Range.FormatString

Range.Formula

Range.StringValue

Range.DateTimeValue

Range.BoolValue

Range.IntValue

Range.DoubleValue

Range.DecimalValue

Range.FloatValue

Range.Int64Value

Range.LongValue

Range.Int32Value

Range.AllRowsInRange

Range.AllColumnsInRange

Namespace: IronXL

Assembly: IronXL.dll

Syntax

public class RangeColumn : Range, IEnumerable<Cell>, IEnumerable

Properties

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.