Struct NpgsqlPolygon
- Namespace
- NpgsqlTypes
- Assembly
- Npgsql.dll
Represents a PostgreSQL Polygon type.
public struct NpgsqlPolygon : IList<NpgsqlPoint>, ICollection<NpgsqlPoint>, IEnumerable<NpgsqlPoint>, IEnumerable, IEquatable<NpgsqlPolygon>
- Implements
- Inherited Members
Constructors
NpgsqlPolygon()
public NpgsqlPolygon()
NpgsqlPolygon(params NpgsqlPoint[])
public NpgsqlPolygon(params NpgsqlPoint[] points)
Parameters
pointsNpgsqlPoint[]
NpgsqlPolygon(IEnumerable<NpgsqlPoint>)
public NpgsqlPolygon(IEnumerable<NpgsqlPoint> points)
Parameters
pointsIEnumerable<NpgsqlPoint>
NpgsqlPolygon(int)
public NpgsqlPolygon(int capacity)
Parameters
capacityint
Properties
Capacity
public int Capacity { get; }
Property Value
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 NpgsqlPoint this[int index] { get; set; }
Parameters
indexintThe zero-based index of the element to get or set.
Property Value
- NpgsqlPoint
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(NpgsqlPoint)
Adds an item to the ICollection<T>.
public void Add(NpgsqlPoint item)
Parameters
itemNpgsqlPointThe 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(NpgsqlPoint)
Determines whether the ICollection<T> contains a specific value.
public bool Contains(NpgsqlPoint item)
Parameters
itemNpgsqlPointThe object to locate in the ICollection<T>.
Returns
- bool
true if
itemis found in the ICollection<T>; otherwise, false.
CopyTo(NpgsqlPoint[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
public void CopyTo(NpgsqlPoint[] array, int arrayIndex)
Parameters
arrayNpgsqlPoint[]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.
Equals(NpgsqlPolygon)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(NpgsqlPolygon other)
Parameters
otherNpgsqlPolygonAn object to compare with this object.
Returns
Equals(object?)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object? obj)
Parameters
objobjectThe object to compare with the current instance.
Returns
- bool
true if
objand this instance are the same type and represent the same value; otherwise, false.
GetEnumerator()
Returns an enumerator that iterates through the collection.
public IEnumerator<NpgsqlPoint> GetEnumerator()
Returns
- IEnumerator<NpgsqlPoint>
An enumerator that can be used to iterate through the collection.
GetHashCode()
Returns the hash code for this instance.
public override int GetHashCode()
Returns
- int
A 32-bit signed integer that is the hash code for this instance.
IndexOf(NpgsqlPoint)
Determines the index of a specific item in the IList<T>.
public int IndexOf(NpgsqlPoint item)
Parameters
itemNpgsqlPointThe object to locate in the IList<T>.
Returns
- int
The index of
itemif found in the list; otherwise, -1.
Insert(int, NpgsqlPoint)
Inserts an item to the IList<T> at the specified index.
public void Insert(int index, NpgsqlPoint item)
Parameters
indexintThe zero-based index at which
itemshould be inserted.itemNpgsqlPointThe 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(NpgsqlPoint)
Removes the first occurrence of a specific object from the ICollection<T>.
public bool Remove(NpgsqlPoint item)
Parameters
itemNpgsqlPointThe 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.
ToString()
Returns the fully qualified type name of this instance.
public override string ToString()
Returns
- string
The fully qualified type name.
Operators
operator ==(NpgsqlPolygon, NpgsqlPolygon)
public static bool operator ==(NpgsqlPolygon x, NpgsqlPolygon y)
Parameters
Returns
operator !=(NpgsqlPolygon, NpgsqlPolygon)
public static bool operator !=(NpgsqlPolygon x, NpgsqlPolygon y)