Class XlsWorksheetsCollection

Namespace

Spire.Xls.Core.Spreadsheet.Collections

Assembly

Spire.XLS.dll

public class XlsWorksheetsCollection : CollectionExtended<IWorksheet>, IList<IWorksheet>, ICollection<IWorksheet>, IEnumerable<IWorksheet>, IExcelApplication, IWorksheets, IEnumerable, ICloneParent

Inheritance

object

CollectionBase<IWorksheet>

CollectionExtended<IWorksheet>

XlsWorksheetsCollection

Implements

IList<IWorksheet>

ICollection<IWorksheet>

IEnumerable<IWorksheet>

IExcelApplication

IWorksheets

IEnumerable

ICloneParent

Derived

WorksheetsCollection

Inherited Members

CollectionExtended<IWorksheet>.OnClear()

CollectionExtended<IWorksheet>.OnClearComplete()

CollectionExtended<IWorksheet>.OnInsert(int, IWorksheet)

CollectionExtended<IWorksheet>.OnInsertComplete(int, IWorksheet)

CollectionExtended<IWorksheet>.OnRemove(int, IWorksheet)

CollectionExtended<IWorksheet>.OnRemoveComplete(int, IWorksheet)

CollectionExtended<IWorksheet>.OnSet(int, IWorksheet, IWorksheet)

CollectionExtended<IWorksheet>.OnSetComplete(int, IWorksheet, IWorksheet)

CollectionExtended<IWorksheet>.FindParent(Type)

CollectionExtended<IWorksheet>.FindParent(Type, bool)

CollectionExtended<IWorksheet>.SetParent(object)

CollectionExtended<IWorksheet>.Clone(object)

CollectionExtended<IWorksheet>.EnsureCapacity(int)

CollectionExtended<IWorksheet>.GenerateDefaultName(ICollection<IWorksheet>, string)

CollectionExtended<IWorksheet>.GenerateDefaultName(ICollection, string)

CollectionExtended<IWorksheet>.GenerateDefaultName(string, params ICollection[])

CollectionExtended<IWorksheet>.ChangeName(IDictionary, XlsEventArgs)

CollectionExtended<IWorksheet>.Parent

CollectionExtended<IWorksheet>.Changed

CollectionBase<IWorksheet>.Insert(int, IWorksheet)

CollectionBase<IWorksheet>.GetEnumerator()

CollectionBase<IWorksheet>.IndexOf(IWorksheet)

CollectionBase<IWorksheet>.Add(IWorksheet)

CollectionBase<IWorksheet>.Contains(IWorksheet)

CollectionBase<IWorksheet>.CopyTo(IWorksheet[], int)

CollectionBase<IWorksheet>.Capacity

CollectionBase<IWorksheet>.Count

CollectionBase<IWorksheet>.InnerList

CollectionBase<IWorksheet>.List

CollectionBase<IWorksheet>.IsReadOnly

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

IsRightToLeft

public bool IsRightToLeft { get; set; }

Property Value

bool

this[int]

public IWorksheet this[int Index] { get; }

Parameters

Index int

Property Value

IWorksheet

this[string]

public IWorksheet this[string sheetName] { get; }

Parameters

sheetName string

Property Value

IWorksheet

UseHashForWorksheetLookup

Toggles worksheet search algorithm when searching worksheet by name.

public bool UseHashForWorksheetLookup { get; set; }

Property Value

bool

UseRangesCache

Indicates whether all created range objects should be cached.

public bool UseRangesCache { get; set; }

Property Value

bool

Methods

Add(string)

public IWorksheet Add(string sheetName)

Parameters

sheetName string

Returns

IWorksheet

AddCopy(IWorksheet)

Adds copy of worksheet.

public IWorksheet AddCopy(IWorksheet sheet)

Parameters

sheet IWorksheet

Worksheet to copy.

Returns

IWorksheet

Copy of worksheet that was added.

AddCopy(IWorksheet, WorksheetCopyType)

public IWorksheet AddCopy(IWorksheet sheet, WorksheetCopyType flags)

Parameters

sheet IWorksheet

flags WorksheetCopyType

Returns

IWorksheet

AddCopy(IWorksheets)

public void AddCopy(IWorksheets worksheets)

Parameters

worksheets IWorksheets

AddCopy(IWorksheets, WorksheetCopyType)

public void AddCopy(IWorksheets worksheets, WorksheetCopyType flags)

Parameters

worksheets IWorksheets

flags WorksheetCopyType

AddCopy(int)

public IWorksheet AddCopy(int sheetIndex)

Parameters

sheetIndex int

Returns

IWorksheet

AddCopy(int, WorksheetCopyType)

Add a copy of the specified worksheet to the worksheet collection.

public IWorksheet AddCopy(int sheetIndex, WorksheetCopyType flags)

Parameters

sheetIndex int

Index of the workbook that should be copied

flags WorksheetCopyType

Represents copy options flags.

Returns

IWorksheet

Returns copied sheet.

AddCopyAfter(IWorksheet)

public IWorksheet AddCopyAfter(IWorksheet toCopy)

Parameters

toCopy IWorksheet

Returns

IWorksheet

AddCopyAfter(IWorksheet, IWorksheet)

public IWorksheet AddCopyAfter(IWorksheet toCopy, IWorksheet sheetBefore)

Parameters

toCopy IWorksheet

sheetBefore IWorksheet

Returns

IWorksheet

AddCopyBefore(IWorksheet)

public IWorksheet AddCopyBefore(IWorksheet toCopy)

Parameters

toCopy IWorksheet

Returns

IWorksheet

AddCopyBefore(IWorksheet, IWorksheet)

public IWorksheet AddCopyBefore(IWorksheet toCopy, IWorksheet sheetAfter)

Parameters

toCopy IWorksheet

sheetAfter IWorksheet

Returns

IWorksheet

Clear()

public void Clear()

Create()

public IWorksheet Create()

Returns

IWorksheet

Create(string)

public IWorksheet Create(string name)

Parameters

name string

Returns

IWorksheet

FindAll(bool)

protected CellRange[] FindAll(bool findValue)

Parameters

findValue bool

Returns

CellRange[]

FindAll(DateTime)

protected CellRange[] FindAll(DateTime findValue)

Parameters

findValue DateTime

Returns

CellRange[]

FindAll(double, FindType)

protected CellRange[] FindAll(double findValue, FindType flags)

Parameters

findValue double

flags FindType

Returns

CellRange[]

FindAll(string, FindType)

protected CellRange[] FindAll(string findValue, FindType flags)

Parameters

findValue string

flags FindType

Returns

CellRange[]

FindAll(string, FindType, ExcelFindOptions)

public CellRange[] FindAll(string findValue, FindType flags, ExcelFindOptions findOptions)

Parameters

findValue string

flags FindType

findOptions ExcelFindOptions

Returns

CellRange[]

FindAll(TimeSpan)

protected CellRange[] FindAll(TimeSpan findValue)

Parameters

findValue TimeSpan

Returns

CellRange[]

FindFirst(bool)

protected IXLSRange FindFirst(bool findValue)

Parameters

findValue bool

Returns

IXLSRange

FindFirst(DateTime)

protected IXLSRange FindFirst(DateTime findValue)

Parameters

findValue DateTime

Returns

IXLSRange

FindFirst(double, FindType)

protected IXLSRange FindFirst(double findValue, FindType flags)

Parameters

findValue double

flags FindType

Returns

IXLSRange

FindFirst(string, FindType)

protected IXLSRange FindFirst(string findValue, FindType flags)

Parameters

findValue string

flags FindType

Returns

IXLSRange

FindFirst(string, FindType, ExcelFindOptions)

public IXLSRange FindFirst(string findValue, FindType flags, ExcelFindOptions findOptions)

Parameters

findValue string

flags FindType

findOptions ExcelFindOptions

Returns

IXLSRange

FindFirst(TimeSpan)

protected IXLSRange FindFirst(TimeSpan findValue)

Parameters

findValue TimeSpan

Returns

IXLSRange

InnerAdd(IWorksheet)

public void InnerAdd(IWorksheet sheet)

Parameters

sheet IWorksheet

InnerRemove(int)

protected void InnerRemove(int index)

Parameters

index int

Move(int, int)

public void Move(int oldIndex, int newIndex)

Parameters

oldIndex int

newIndex int

Remove(IWorksheet)

public void Remove(IWorksheet sheet)

Parameters

sheet IWorksheet

Remove(int)

Removes specified worksheet from the collection.

public void Remove(int index)

Parameters

index int

Index of the sheet to remove.

Remove(string)

Removes specified worksheet from the collection.

public void Remove(string sheetName)

Parameters

sheetName string

Name of the sheet to remove.

RemoveAt(int)

Removes specified worksheet from the collection.

public void RemoveAt(int index)

Parameters

index int

Index of the sheet to remove.

UpdateSheetIndex(XlsWorksheet, int)

[Obsolete("the method is not implemented")]
public void UpdateSheetIndex(XlsWorksheet sheet, int iOldRealIndex)

Parameters

sheet XlsWorksheet

iOldRealIndex int

UpdateStringIndexes(List<int>)

[Obsolete("the method is not implemented")]
public void UpdateStringIndexes(List<int> newIndexes)

Parameters

newIndexes List<int>