Table of Contents

Interface IXLRangeAddress

Namespace
SlapKit.Excel.Excel
Assembly
SlapKit.Excel.dll
public interface IXLRangeAddress
Extension Methods

Properties

ColumnSpan

Gets the number of columns in the area covered by the range address.

int ColumnSpan { get; }

Property Value

int

FirstAddress

Gets or sets the first address in the range.

IXLAddress FirstAddress { get; }

Property Value

IXLAddress

The first address.

IsValid

Gets or sets a value indicating whether this range is valid.

bool IsValid { get; }

Property Value

bool

true if this instance is valid; otherwise, false.

LastAddress

Gets or sets the last address in the range.

IXLAddress LastAddress { get; }

Property Value

IXLAddress

The last address.

NumberOfCells

Gets the number of cells in the area covered by the range address.

int NumberOfCells { get; }

Property Value

int

RowSpan

Gets the number of rows in the area covered by the range address.

int RowSpan { get; }

Property Value

int

Worksheet 

IXLWorksheet? Worksheet { get; }

Property Value

IXLWorksheet

Methods

AsRange()

Allocates the current range address in the internal range repository and returns it

IXLRange? AsRange()

Returns

IXLRange

Range of the address or null, if the range is not a valid address.

Contains(IXLAddress) 

bool Contains(IXLAddress address)

Parameters

address IXLAddress

Returns

bool

Intersection(IXLRangeAddress)

Returns the intersection of this range address with another range address on the same worksheet.

IXLRangeAddress Intersection(IXLRangeAddress otherRangeAddress)

Parameters

otherRangeAddress IXLRangeAddress

The other range address.

Returns

IXLRangeAddress

The intersection's range address

Intersects(IXLRangeAddress) 

bool Intersects(IXLRangeAddress otherAddress)

Parameters

otherAddress IXLRangeAddress

Returns

bool

IsEntireColumn()

Determines whether range address spans the entire column.

bool IsEntireColumn()

Returns

bool

true if is entire column; otherwise, false.

IsEntireRow()

Determines whether range address spans the entire row.

bool IsEntireRow()

Returns

bool

true if is entire row; otherwise, false.

IsEntireSheet()

Determines whether the range address spans the entire worksheet.

bool IsEntireSheet()

Returns

bool

true if is entire sheet; otherwise, false.

Relative(IXLRangeAddress, IXLRangeAddress)

Returns a range address so that its offset from the target base address is equal to the offset of the current range address to the source base address. For example, if the current range address is D4:E4, the source base address is A1:C3, then the relative address to the target base address B10:D13 is E14:F14

IXLRangeAddress Relative(IXLRangeAddress sourceRangeAddress, IXLRangeAddress targetRangeAddress)

Parameters

sourceRangeAddress IXLRangeAddress

The source base range address.

targetRangeAddress IXLRangeAddress

The target base range address.

Returns

IXLRangeAddress

The relative range

ToString(XLReferenceStyle) 

string ToString(XLReferenceStyle referenceStyle)

Parameters

referenceStyle XLReferenceStyle

Returns

string

ToString(XLReferenceStyle, bool) 

string ToString(XLReferenceStyle referenceStyle, bool includeSheet)

Parameters

referenceStyle XLReferenceStyle
includeSheet bool

Returns

string

ToStringFixed() 

string ToStringFixed()

Returns

string

ToStringFixed(XLReferenceStyle) 

string ToStringFixed(XLReferenceStyle referenceStyle)

Parameters

referenceStyle XLReferenceStyle

Returns

string

ToStringFixed(XLReferenceStyle, bool) 

string ToStringFixed(XLReferenceStyle referenceStyle, bool includeSheet)

Parameters

referenceStyle XLReferenceStyle
includeSheet bool

Returns

string

ToStringRelative() 

string ToStringRelative()

Returns

string

ToStringRelative(bool) 

string ToStringRelative(bool includeSheet)

Parameters

includeSheet bool

Returns

string