Class SectionSet<T>
- Namespace
- ChartTools.IO.Sections
- Assembly
- ChartTools.dll
public abstract class SectionSet<T> : IList<Section<T>>, ICollection<Section<T>>, IEnumerable<Section<T>>, IEnumerable
Type Parameters
T
- Inheritance
-
SectionSet<T>
- Implements
-
ICollection<Section<T>>IEnumerable<Section<T>>
- Derived
- Inherited Members
- Extension Methods
Properties
Count
Gets the number of elements contained in the ICollection<T>.
public int Count { get; }
Property Value
- int
The number of elements contained in the ICollection<T>.
IsReadOnly
Gets a value indicating whether the ICollection<T> is read-only.
public bool IsReadOnly { get; }
Property Value
- bool
true if the ICollection<T> is read-only; otherwise, false.
this[int]
Gets or sets the element at the specified index.
public Section<T> this[int index] { get; set; }
Parameters
index
intThe zero-based index of the element to get or set.
Property Value
- Section<T>
The element at the specified index.
Exceptions
- ArgumentOutOfRangeException
index
is not a valid index in the IList<T>.- NotSupportedException
The property is set and the IList<T> is read-only.
ReservedHeaders
public abstract ReservedSectionHeaderSet ReservedHeaders { get; }
Property Value
Methods
Add(Section<T>)
Adds an item to the ICollection<T>.
public void Add(Section<T> item)
Parameters
item
Section<T>The object to add to the ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
Clear()
Removes all items from the ICollection<T>.
public void Clear()
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
Contains(Section<T>)
Determines whether the ICollection<T> contains a specific value.
public bool Contains(Section<T> item)
Parameters
item
Section<T>The object to locate in the ICollection<T>.
Returns
- bool
true if
item
is found in the ICollection<T>; otherwise, false.
CopyTo(Section<T>[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
public void CopyTo(Section<T>[] array, int arrayIndex)
Parameters
array
Section<T>[]The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
arrayIndex
intThe zero-based index in
array
at which copying begins.
Exceptions
- ArgumentNullException
array
is null.- ArgumentOutOfRangeException
arrayIndex
is less than 0.- ArgumentException
The number of elements in the source ICollection<T> is greater than the available space from
arrayIndex
to the end of the destinationarray
.
Get(string)
public Section<T>? Get(string header)
Parameters
header
string
Returns
- Section<T>
GetEnumerator()
Returns an enumerator that iterates through the collection.
public IEnumerator<Section<T>> GetEnumerator()
Returns
- IEnumerator<Section<T>>
An enumerator that can be used to iterate through the collection.
IndexOf(Section<T>)
Determines the index of a specific item in the IList<T>.
public int IndexOf(Section<T> item)
Parameters
Returns
- int
The index of
item
if found in the list; otherwise, -1.
Insert(int, Section<T>)
Inserts an item to the IList<T> at the specified index.
public void Insert(int index, Section<T> item)
Parameters
index
intThe zero-based index at which
item
should be inserted.item
Section<T>The object to insert into the IList<T>.
Exceptions
- ArgumentOutOfRangeException
index
is not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.
Remove(Section<T>)
Removes the first occurrence of a specific object from the ICollection<T>.
public bool Remove(Section<T> item)
Parameters
item
Section<T>The object to remove from the ICollection<T>.
Returns
- bool
true if
item
was successfully removed from the ICollection<T>; otherwise, false. This method also returns false ifitem
is not found in the original ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
RemoveAt(int)
Removes the IList<T> item at the specified index.
public void RemoveAt(int index)
Parameters
index
intThe zero-based index of the item to remove.
Exceptions
- ArgumentOutOfRangeException
index
is not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.