Class Columns

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

Inheritance

System.Object

WorksheetEntityBase

RowsColumnsBase

Columns

Inherited Members

RowsColumnsBase.Insert(Int32)

RowsColumnsBase.Insert(Int32, Int32)

RowsColumnsBase.Remove(Int32)

RowsColumnsBase.Remove(Int32, Int32)

RowsColumnsBase.Cells

WorksheetEntityBase.Worksheet

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class Columns : RowsColumnsBase

Properties

Count

The total number of columns in the worksheet.

Declaration

public override int Count { get; }

Property Value

System.Int32 The row / column count.

Overrides

RowsColumnsBase.Count

Item[IEnumerable<CellRange>]

Accesses the columns intersecting a collection of cell ranges.

Declaration

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

Parameters

System.Collections.Generic.IEnumerable<CellRange> cellRanges

Property Value

ColumnSelection The column selection.

Item[Int32]

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

Declaration

public ColumnSelection this[int index] { get; }

Parameters

System.Int32 index

Property Value

ColumnSelection The column selection.

Item[Int32, Int32]

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

Declaration

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

Parameters

System.Int32 fromIndex

System.Int32 toIndex

Property Value

ColumnSelection The column selection.

Item[CellIndex]

Accesses the column containing the specified cell index.

Declaration

public ColumnSelection this[CellIndex cellIndex] { get; }

Parameters

CellIndex cellIndex

Property Value

ColumnSelection The column selection.

Item[CellRange]

Accesses the columns intersecting the specified cell range.

Declaration

public ColumnSelection this[CellRange cellRange] { get; }

Parameters

CellRange cellRange

Property Value

ColumnSelection The column selection.

Methods

CanInsert(Int32, Int32)

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

Declaration

public override bool CanInsert(int index, int itemCount)

Parameters

System.Int32 index The index.

System.Int32 itemCount The item count.

Returns

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

Overrides

RowsColumnsBase.CanInsert(Int32, Int32)

GetColumnSelection(IEnumerable<CellRange>)

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

Declaration

public ColumnSelection GetColumnSelection(IEnumerable<CellRange> cellRanges)

Parameters

System.Collections.Generic.IEnumerable<CellRange> cellRanges The cell ranges.

Returns

ColumnSelection The column selection.

GetColumnSelection(Int32)

Creates a selection for the column at the specified index.

Declaration

public ColumnSelection GetColumnSelection(int index)

Parameters

System.Int32 index The index.

Returns

ColumnSelection The column selection.

GetColumnSelection(Int32, Int32)

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

Declaration

public ColumnSelection GetColumnSelection(int fromIndex, int toIndex)

Parameters

System.Int32 fromIndex From index.

System.Int32 toIndex To index.

Returns

ColumnSelection The column selection.

GetColumnSelection(CellIndex)

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

Declaration

public ColumnSelection GetColumnSelection(CellIndex cellIndex)

Parameters

CellIndex cellIndex Index of the cell.

Returns

ColumnSelection The column selection.

GetColumnSelection(CellRange)

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

Declaration

public ColumnSelection GetColumnSelection(CellRange cellRange)

Parameters

CellRange cellRange The cell range.

Returns

ColumnSelection The column selection.

GetDefaultWidth()

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

Declaration

public ColumnWidth GetDefaultWidth()

Returns

ColumnWidth The column width

InsertOverride(Int32, Int32)

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

Declaration

protected override bool InsertOverride(int index, int itemCount)

Parameters

System.Int32 index The index.

System.Int32 itemCount The item count.

Returns

System.Boolean

Overrides

RowsColumnsBase.InsertOverride(Int32, Int32)

RemoveOverride(Int32, Int32)

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

Declaration

protected override void RemoveOverride(int index, int itemCount)

Parameters

System.Int32 index The index.

System.Int32 itemCount The item count.

Overrides

RowsColumnsBase.RemoveOverride(Int32, Int32)

SetDefaultWidth(ColumnWidth)

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

Declaration

public void SetDefaultWidth(ColumnWidth width)

Parameters

ColumnWidth width The width.

Events

ColumnsWidthChanged

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

Declaration

public event EventHandler<RowColumnPropertyChangedEventArgs> ColumnsWidthChanged

Event Type

System.EventHandler<RowColumnPropertyChangedEventArgs>

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)