Class LengthPercentageOrNumberList
public class LengthPercentageOrNumberList : IList<LengthPercentageOrNumber>, ICollection<LengthPercentageOrNumber>, IEnumerable<LengthPercentageOrNumber>, IEnumerable
- Inheritance
-
LengthPercentageOrNumberList
- Implements
- Inherited Members
Constructors
LengthPercentageOrNumberList(Shape, string, LengthOrientation)
Creates a new instance of LengthPercentageOrNumberList with the specified owner and orientation.
public LengthPercentageOrNumberList(Shape owner, string value, LengthOrientation orientation = LengthOrientation.None)
Parameters
ownerShapeThe element that the length list is associated with.
valuestringA string representation of a length list
orientationLengthOrientationUsed to establish the context of the lengths. Should be Horizontal for inherntly horizontal values like 'x' and 'dx'. Should be Vertical for inherntly vertical values like 'y' and 'dy'. Should be None for other values.
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 LengthPercentageOrNumber this[int index] { get; set; }
Parameters
indexintThe zero-based index of the element to get or set.
Property Value
- LengthPercentageOrNumber
The element at the specified index.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The property is set and the IList<T> is read-only.
Methods
Add(LengthPercentageOrNumber)
Adds an item to the ICollection<T>.
public void Add(LengthPercentageOrNumber item)
Parameters
itemLengthPercentageOrNumberThe 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(LengthPercentageOrNumber)
Determines whether the ICollection<T> contains a specific value.
public bool Contains(LengthPercentageOrNumber item)
Parameters
itemLengthPercentageOrNumberThe object to locate in the ICollection<T>.
Returns
- bool
true if
itemis found in the ICollection<T>; otherwise, false.
CopyTo(LengthPercentageOrNumber[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
public void CopyTo(LengthPercentageOrNumber[] array, int arrayIndex)
Parameters
arrayLengthPercentageOrNumber[]The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
arrayIndexintThe zero-based index in
arrayat which copying begins.
Exceptions
- ArgumentNullException
arrayis null.- ArgumentOutOfRangeException
arrayIndexis less than 0.- ArgumentException
The number of elements in the source ICollection<T> is greater than the available space from
arrayIndexto the end of the destinationarray.
Empty(Shape, LengthOrientation)
public static LengthPercentageOrNumberList Empty(Shape owner, LengthOrientation orientation = LengthOrientation.None)
Parameters
ownerShapeorientationLengthOrientation
Returns
GetEnumerator()
Returns an enumerator that iterates through the collection.
public IEnumerator<LengthPercentageOrNumber> GetEnumerator()
Returns
- IEnumerator<LengthPercentageOrNumber>
An enumerator that can be used to iterate through the collection.
IndexOf(LengthPercentageOrNumber)
Determines the index of a specific item in the IList<T>.
public int IndexOf(LengthPercentageOrNumber item)
Parameters
itemLengthPercentageOrNumberThe object to locate in the IList<T>.
Returns
- int
The index of
itemif found in the list; otherwise, -1.
Insert(int, LengthPercentageOrNumber)
Inserts an item to the IList<T> at the specified index.
public void Insert(int index, LengthPercentageOrNumber item)
Parameters
indexintThe zero-based index at which
itemshould be inserted.itemLengthPercentageOrNumberThe object to insert into the IList<T>.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.
Remove(LengthPercentageOrNumber)
Removes the first occurrence of a specific object from the ICollection<T>.
public bool Remove(LengthPercentageOrNumber item)
Parameters
itemLengthPercentageOrNumberThe object to remove from the ICollection<T>.
Returns
- bool
true if
itemwas successfully removed from the ICollection<T>; otherwise, false. This method also returns false ifitemis 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
indexintThe zero-based index of the item to remove.
Exceptions
- ArgumentOutOfRangeException
indexis not a valid index in the IList<T>.- NotSupportedException
The IList<T> is read-only.