Class Range

Namespace

Openize.Cells

Assembly

Openize.OpenXMLSDK.dll

public class Range

Inheritance

object

Range

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Range(Worksheet, uint, uint, uint, uint)

Initializes a new instance of the Range class.

public Range(Worksheet worksheet, uint startRowIndex, uint startColumnIndex, uint endRowIndex, uint endColumnIndex)

Parameters

worksheet Worksheet

The worksheet to which this range belongs.

startRowIndex uint

The starting row index of the range.

startColumnIndex uint

The starting column index of the range.

endRowIndex uint

The ending row index of the range.

endColumnIndex uint

The ending column index of the range.

Exceptions

ArgumentNullException

Thrown if the provided worksheet is null.

ArgumentOutOfRangeException

Thrown if the start or end row/column indices are out of range.

Properties

ColumnCount

Gets the count of columns in the range. This property calculates the column count based on the start and end column indices.

public uint ColumnCount { get; }

Property Value

uint

The count of columns in the range.

Exceptions

InvalidOperationException

Thrown if the end column index is less than the start column index.

EndColumnIndex

public uint EndColumnIndex { get; }

Property Value

uint

EndRowIndex

public uint EndRowIndex { get; }

Property Value

uint

RowCount

Gets the count of rows in the range. This property calculates the row count based on the start and end row indices.

public uint RowCount { get; }

Property Value

uint

The count of rows in the range.

Exceptions

InvalidOperationException

Thrown if the end row index is less than the start row index.

StartColumnIndex

public uint StartColumnIndex { get; }

Property Value

uint

StartRowIndex

public uint StartRowIndex { get; }

Property Value

uint

Methods

AddDropdownListValidation(string[])

Adds dropdown list validation with the specified options to all cells within the range.

public void AddDropdownListValidation(string[] options)

Parameters

options string[]

The list of options for the dropdown validation.

Exceptions

ArgumentNullException

Thrown if the options array is null or empty.

InvalidOperationException

Thrown if adding dropdown validation fails for any cell within the range.

ApplyValidation(ValidationRule)

public void ApplyValidation(ValidationRule rule)

Parameters

rule ValidationRule

ClearCells()

Clears the values and resets the style of all cells within the range.

public void ClearCells()

Exceptions

InvalidOperationException

Thrown if any cell within the range is not properly initialized or accessible.

MergeCells()

Merges all cells within the range into a single cell.

public void MergeCells()

Exceptions

InvalidOperationException

Thrown if the merge operation fails, for example, if the cells cannot be merged.

SetValue(string)

Sets the specified value to all cells within the range.

public void SetValue(string value)

Parameters

value string

The value to set in each cell of the range.

Exceptions

InvalidOperationException

Thrown if any cell within the range is not properly initialized or accessible.