Class List
A list of Values for serialization by an IConfigProvider. Use List() or From(IEnumerable<Value>) to create.
Inherited Members
Namespace: IPA.Config.Data
Assembly: IPA.Loader.dll
Syntax
public sealed class List : Value, IList<Value>, ICollection<Value>, IEnumerable<Value>, IEnumerable
Properties
| Improve this Doc View SourceCount
Gets the number of elements in the List.
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
Int32 |
See Also
| Improve this Doc View SourceItem[Int32]
Gets the value at the given index in this List.
Declaration
public Value this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | the index to retrieve the Value at |
Property Value
Type | Description |
---|---|
Value | the Value at |
See Also
Methods
| Improve this Doc View SourceAdd(Value)
Declaration
public void Add(Value item)
Parameters
Type | Name | Description |
---|---|---|
Value | item | the Value to add |
See Also
AddRange(IEnumerable<Value>)
Declaration
public void AddRange(IEnumerable<Value> vals)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<Value> | vals | the range of Values to add |
Clear()
Clears the List.
Declaration
public void Clear()
See Also
Contains(Value)
Checks if the List contains a certian item.
Declaration
public bool Contains(Value item)
Parameters
Type | Name | Description |
---|---|---|
Value | item | the Value to check for |
Returns
Type | Description |
---|---|
Boolean | true if the item was founc, otherwise false |
See Also
CopyTo(Value[], Int32)
Declaration
public void CopyTo(Value[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
Value[] | array | the Array to copy to |
Int32 | arrayIndex | the starting index to copy to |
See Also
| Improve this Doc View SourceGetEnumerator()
Gets an enumerator to enumerate the List.
Declaration
public IEnumerator<Value> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<Value> | an IEnumerator<T> for this List |
See Also
| Improve this Doc View SourceIndexOf(Value)
Declaration
public int IndexOf(Value item)
Parameters
Type | Name | Description |
---|---|---|
Value | item | the Value to search for |
Returns
Type | Description |
---|---|
Int32 | the index that the |
See Also
Insert(Int32, Value)
Inserts a Value at an index.
Declaration
public void Insert(int index, Value item)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | the index to insert at |
Value | item | the Value to insert |
See Also
Remove(Value)
Declaration
public bool Remove(Value item)
Parameters
Type | Name | Description |
---|---|---|
Value | item | the Value to remove |
Returns
Type | Description |
---|---|
Boolean | true if the item was removed, false otherwise |
See Also
RemoveAt(Int32)
Removes a Value at an index.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | the index to remove a Value at |
See Also
| Improve this Doc View SourceToString()
Converts this Value into a human-readable format.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | a comma-seperated list of the result of ToString() wrapped in square brackets |
Overrides
Explicit Interface Implementations
| Improve this Doc View SourceICollection<Value>.IsReadOnly
Declaration
bool ICollection<Value>.IsReadOnly { get; }
Returns
Type | Description |
---|---|
Boolean |
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator |