New to Telerik Document Processing? Start a free 30-day trial

Columns

Class

Manages all columns in a worksheet, providing access to column properties, widths, and visibility.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class Columns : RowsColumnsBase

Inheritance: objectWorksheetEntityBaseRowsColumnsBaseColumns

Inherited Members RowsColumnsBase.Insert(int)RowsColumnsBase.Insert(int, int)RowsColumnsBase.Remove(int)RowsColumnsBase.Remove(int, int)RowsColumnsBase.CellsWorksheetEntityBase.Worksheet...

Events

ColumnsWidthChanged

EventHandler<RowColumnPropertyChangedEventArgs>

Raised when one or more column widths change, providing the affected column index range.

public event EventHandler<RowColumnPropertyChangedEventArgs> ColumnsWidthChanged

Methods

CanInsert(int, int)

bool

Checks whether the specified number of columns can be inserted at the given index without exceeding worksheet limits.

public override bool CanInsert(int index, int itemCount)

Parameters:indexint

The index.

itemCountint

The item count.

Returns:

bool

The value indicating whether this instance can be inserted at the specified index

Overrides: RowsColumnsBase.CanInsert(int, int)

GetColumnSelection(CellIndex)

ColumnSelection

Creates a selection for the column containing the specified cell index.

public ColumnSelection GetColumnSelection(CellIndex cellIndex)

Parameters:cellIndexCellIndex

Index of the cell.

Returns:

ColumnSelection

The column selection.

GetColumnSelection(CellRange)

ColumnSelection

Creates a selection for the columns intersecting the specified cell range.

public ColumnSelection GetColumnSelection(CellRange cellRange)

Parameters:cellRangeCellRange

The cell range.

Returns:

ColumnSelection

The column selection.

GetColumnSelection(IEnumerable<CellRange>)

ColumnSelection

Creates a selection for the columns intersecting a collection of cell ranges.

public ColumnSelection GetColumnSelection(IEnumerable<CellRange> cellRanges)

Parameters:cellRangesIEnumerable<CellRange>

The cell ranges.

Returns:

ColumnSelection

The column selection.

GetColumnSelection(int, int)

ColumnSelection

Creates a selection for the range of columns between the start and end indices.

public ColumnSelection GetColumnSelection(int fromIndex, int toIndex)

Parameters:fromIndexint

From index.

toIndexint

To index.

Returns:

ColumnSelection

The column selection.

GetColumnSelection(int)

ColumnSelection

Creates a selection for the column at the specified index.

public ColumnSelection GetColumnSelection(int index)

Parameters:indexint

The index.

Returns:

ColumnSelection

The column selection.

GetDefaultWidth()

ColumnWidth

Retrieves the default width applied to all columns without explicit width settings.

public ColumnWidth GetDefaultWidth()

Returns:

ColumnWidth

The column width

InsertOverride(int, int)

bool

Inserts the specified number of columns at the given index, shifting existing columns to the right.

protected override bool InsertOverride(int index, int itemCount)

Parameters:indexint

The index.

itemCountint

The item count.

Returns:

bool

Overrides: RowsColumnsBase.InsertOverride(int, int)

RemoveOverride(int, int)

Removes the specified number of columns starting at the given index, shifting remaining columns to the left.

protected override void RemoveOverride(int index, int itemCount)

Parameters:indexint

The index.

itemCountint

The item count.

Overrides: RowsColumnsBase.RemoveOverride(int, int)

SetDefaultWidth(ColumnWidth)

Sets the default width for all columns without explicit width settings.

public void SetDefaultWidth(ColumnWidth width)

Parameters:widthColumnWidth

The width.

Properties

Count

int

The total number of columns in the worksheet.

public override int Count { get; }

Property Value:

The row / column count.

Overrides: RowsColumnsBase.Count

this[CellIndex]

ColumnSelection

Accesses the column containing the specified cell index.

public ColumnSelection this[CellIndex cellIndex] { get; }

Parameters:cellIndexCellIndexProperty Value:

The column selection.

this[CellRange]

ColumnSelection

Accesses the columns intersecting the specified cell range.

public ColumnSelection this[CellRange cellRange] { get; }

Parameters:cellRangeCellRangeProperty Value:

The column selection.

this[IEnumerable<CellRange>]

ColumnSelection

Accesses the columns intersecting a collection of cell ranges.

public ColumnSelection this[IEnumerable<CellRange> cellRanges] { get; }

Parameters:cellRangesIEnumerable<CellRange>Property Value:

The column selection.

this[int, int]

ColumnSelection

Accesses a range of columns by start and end indices, returning a selection for batch operations.

public ColumnSelection this[int fromIndex, int toIndex] { get; }

Parameters:fromIndexinttoIndexintProperty Value:

The column selection.

this[int]

ColumnSelection

Accesses a single column by index, returning a selection for applying properties or operations.

public ColumnSelection this[int index] { get; }

Parameters:indexintProperty Value:

The column selection.