Class SvgElementCollection

Namespace

Svg

Assembly

Svg.dll

Represents a collection of SvgElements.

public sealed class SvgElementCollection : IList<SvgElement>, ICollection<SvgElement>, IEnumerable<SvgElement>, IEnumerable

Inheritance

object

SvgElementCollection

Implements

IList<SvgElement>

ICollection<SvgElement>

IEnumerable<SvgElement>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.Descendants<T>(IEnumerable<T>)

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 SvgElement this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

SvgElement

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.

Methods

Add(SvgElement)

Adds an item to the ICollection<T>.

public void Add(SvgElement item)

Parameters

item SvgElement

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

AddAndForceUniqueID(SvgElement, bool, bool, Action<SvgElement, string, string>)

public void AddAndForceUniqueID(SvgElement item, bool autoForceUniqueID = true, bool autoFixChildrenID = true, Action<SvgElement, string, string> logElementOldIDNewID = null)

Parameters

item SvgElement

autoForceUniqueID bool

autoFixChildrenID bool

logElementOldIDNewID Action<SvgElement, string, string>

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(SvgElement)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(SvgElement item)

Parameters

item SvgElement

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(SvgElement[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(SvgElement[] array, int arrayIndex)

Parameters

array SvgElement[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The 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 destination array.

FindSvgElementOf<T>()

expensive recursive search for first node of type T

public T FindSvgElementOf<T>() where T : SvgElement

Returns

T

Type Parameters

T

FindSvgElementsOf<T>()

expensive recursive search for nodes of type T

public IEnumerable<T> FindSvgElementsOf<T>() where T : SvgElement

Returns

IEnumerable<T>

Type Parameters

T

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<SvgElement> GetEnumerator()

Returns

IEnumerator<SvgElement>

An enumerator that can be used to iterate through the collection.

GetSvgElementOf<T>()

public T GetSvgElementOf<T>() where T : SvgElement

Returns

T

Type Parameters

T

IndexOf(SvgElement)

Returns the index of the specified SvgElement in the collection.

public int IndexOf(SvgElement item)

Parameters

item SvgElement

The SvgElement to search for.

Returns

int

The index of the element if it is present; otherwise -1.

Insert(int, SvgElement)

Inserts the given SvgElement to the collection at the specified index.

public void Insert(int index, SvgElement item)

Parameters

index int

The index that the item should be added at.

item SvgElement

The SvgElement to be added.

InsertAndForceUniqueID(int, SvgElement, bool, bool, Action<SvgElement, string, string>)

public void InsertAndForceUniqueID(int index, SvgElement item, bool autoForceUniqueID = true, bool autoFixChildrenID = true, Action<SvgElement, string, string> logElementOldIDNewID = null)

Parameters

index int

item SvgElement

autoForceUniqueID bool

autoFixChildrenID bool

logElementOldIDNewID Action<SvgElement, string, string>

Remove(SvgElement)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(SvgElement item)

Parameters

item SvgElement

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 if item 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 int

The 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.