Table of Contents

Interface IXLNamedRange

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

Properties

Comment

Gets or sets the comment for this named range.

string Comment { get; set; }

Property Value

string

The comment for this named range.

IsValid

Checks if the named range contains invalid references (#REF!).

bool IsValid { get; }

Property Value

bool

Name

Gets or sets the name of the range.

string Name { get; set; }

Property Value

string

The name of the range.

Ranges

Gets the ranges associated with this named range.

Note: A named range can point to multiple ranges.

IXLRanges Ranges { get; }

Property Value

IXLRanges

RefersTo 

string RefersTo { get; set; }

Property Value

string

Scope

Gets the scope of this named range.

XLNamedRangeScope Scope { get; }

Property Value

XLNamedRangeScope

Visible

Gets or sets the visibility of this named range.

bool Visible { get; set; }

Property Value

bool

true if visible; otherwise, false.

Methods

Add(IXLRange)

Adds the specified range to this named range.

Note: A named range can point to multiple ranges.

IXLRanges Add(IXLRange range)

Parameters

range IXLRange

The range to add.

Returns

IXLRanges

Add(IXLRanges)

Adds the specified ranges to this named range.

Note: A named range can point to multiple ranges.

IXLRanges Add(IXLRanges ranges)

Parameters

ranges IXLRanges

The ranges to add.

Returns

IXLRanges

Add(XLWorkbook, string)

Adds the specified range to this named range.

Note: A named range can point to multiple ranges.

IXLRanges Add(XLWorkbook workbook, string rangeAddress)

Parameters

workbook XLWorkbook

Workbook containing the range

rangeAddress string

The range address to add.

Returns

IXLRanges

Clear()

Clears the list of ranges associated with this named range.

(it does not clear the cells)

void Clear()

CopyTo(IXLWorksheet) 

IXLNamedRange CopyTo(IXLWorksheet targetSheet)

Parameters

targetSheet IXLWorksheet

Returns

IXLNamedRange

Delete()

Deletes this named range (not the cells).

void Delete()

Remove(IXLRange)

Removes the specified range from this named range.

Note: A named range can point to multiple ranges.

void Remove(IXLRange range)

Parameters

range IXLRange

The range to remove.

Remove(IXLRanges)

Removes the specified ranges from this named range.

Note: A named range can point to multiple ranges.

void Remove(IXLRanges ranges)

Parameters

ranges IXLRanges

The ranges to remove.

Remove(string)

Removes the specified range from this named range.

Note: A named range can point to multiple ranges.

void Remove(string rangeAddress)

Parameters

rangeAddress string

The range address to remove.

SetRefersTo(IXLRangeBase) 

IXLNamedRange SetRefersTo(IXLRangeBase range)

Parameters

range IXLRangeBase

Returns

IXLNamedRange

SetRefersTo(IXLRanges) 

IXLNamedRange SetRefersTo(IXLRanges ranges)

Parameters

ranges IXLRanges

Returns

IXLNamedRange

SetRefersTo(string) 

IXLNamedRange SetRefersTo(string range)

Parameters

range string

Returns

IXLNamedRange