Summary
An ArcGISCollection<T> represents a mutable collection of supported ArcGIS objects. It acts as a lightweight proxy to an underlying native collection and creates managed objects when elements are accessed.
An ArcGISCollection<T> supports foreach iteration, but it is not a List<T>.
Explicit collection specializations are provided for:
- ArcGISBuildingAttributeFilter
- ArcGISElevationSource
- ArcGISLayer
- ArcGISMeshModification
- ArcGISPolygon
Compatible derived types, such as specific layer types, can be passed to supported collection operations where applicable.
Constructors
ArcGISCollection<T>()
Creates an empty ArcGISCollection<T> for a supported element type.
A NotImplementedException is thrown if T is not a supported element type.
Since 1.0.0
Methods
| Signature | Return Type | Summary |
|---|---|---|
Add(T) | Adds an element to the end of the collection. | |
Adds the elements from another collection to the end of this collection. | ||
T | Returns the element at the specified position. | |
Contains(T) | Indicates whether the collection contains the specified element. | |
Indicates whether this collection is equal to another collection. | ||
First() | T | Returns the first element in the collection. |
GetSize() | Returns the number of elements in the collection. | |
IndexOf(T) | Returns the position of the specified element in the collection. | |
Inserts an element at the specified position. | ||
IsEmpty() | Indicates whether the collection contains no elements. | |
Last() | T | Returns the last element in the collection. |
Moves an element from one position to another. | ||
Npos() | Returns the value used to indicate that a position was not found. | |
Removes the element at the specified position. | ||
Removes all elements from the collection. |
Add
ulong Add(T value)
Adds an element to the end of the collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
value | T | The element to add. |
Returns ulong
The position where the element was added.
AddArray
ulong AddArray(ArcGISCollection<T> vector2)
Adds the elements from another collection to the end of this collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
vector2 | ArcGISCollection<T> | The collection containing the elements to add. |
Returns ulong
The position returned after the elements are added.
At
T At(ulong position)
Returns the element at the specified position.
The managed object is created when the element is accessed.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
position | ulong | The zero-based position of the element. |
Returns T
The element at the specified position.
Contains
bool Contains(T value)
Indicates whether the collection contains the specified element.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
value | T | The element to find. |
Returns bool
true if the collection contains the element; otherwise, false.
Equals
bool Equals(ArcGISCollection<T> vector2)
Indicates whether this collection is equal to another collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
vector2 | ArcGISCollection<T> | The collection to compare. |
Returns bool
true if the collections are equal; otherwise, false.
First
T First()
Returns the first element in the collection.
The managed object is created when the element is accessed.
Since 1.0.0
Returns T
The first element in the collection.
GetSize
ulong GetSize()
Returns the number of elements in the collection.
Since 1.0.0
Returns ulong
The number of elements in the collection.
IndexOf
ulong IndexOf(T value)
Returns the position of the specified element in the collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
value | T | The element to find. |
Returns ulong
The position of the element, or Npos if the element is not found.
Insert
Inserts an element at the specified position.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
position | ulong | The zero-based position where the element will be inserted. |
value | T | The element to insert. |
Returns void
This method does not return a value.
IsEmpty
bool IsEmpty()
Indicates whether the collection contains no elements.
Since 1.0.0
Returns bool
true if the collection is empty; otherwise, false.
Last
T Last()
Returns the last element in the collection.
The managed object is created when the element is accessed.
Since 1.0.0
Returns T
The last element in the collection.
Move
Moves an element from one position to another.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
old | ulong | The current zero-based position of the element. |
new | ulong | The new zero-based position of the element. |
Returns void
This method does not return a value.
Npos
ulong Npos()
Returns the value used to indicate that a position was not found.
Since 1.0.0
Returns ulong
The value representing an invalid or unavailable position.