Share via

  • Article

SqlGeometry Class

The SqlGeometry type represents data in a Euclidean (flat) coordinate system.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Types.SqlGeometry

Namespace:  Microsoft.SqlServer.Types
Assembly:  Microsoft.SqlServer.Types (in Microsoft.SqlServer.Types.dll)

Syntax

'Declaration
<SerializableAttribute> _
<SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered := False,  _
    MaxByteSize := , IsFixedLength := False)> _
<CLSCompliantAttribute(True)> _
Public NotInheritable Class SqlGeometry _
    Implements INullable, IBinarySerialize
'Usage
Dim instance As SqlGeometry

[SerializableAttribute]
[SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered = false, 
    MaxByteSize = , IsFixedLength = false)]
[CLSCompliantAttribute(true)]
public sealed class SqlGeometry : INullable, 
    IBinarySerialize

[SerializableAttribute]
[SqlUserDefinedTypeAttribute(Format::UserDefined, IsByteOrdered = false, 
    MaxByteSize = , IsFixedLength = false)]
[CLSCompliantAttribute(true)]
public ref class SqlGeometry sealed : INullable, 
    IBinarySerialize

[<SealedAttribute>]
[<SerializableAttribute>]
[<SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered = false, 
    MaxByteSize = , IsFixedLength = false)>]
[<CLSCompliantAttribute(true)>]
type SqlGeometry =  
    class
        interface INullable
        interface IBinarySerialize
    end

public final class SqlGeometry implements INullable, IBinarySerialize

The SqlGeometry type exposes the following members.

Constructors

  Name Description
Public method SqlGeometry Initializes a new instance of the SqlGeometry class.

Top

Properties

  Name Description
Public property IsNull Gets a value that indicates whether the SqlGeometry object is null.
Public property M Gets the M (measure) value of the SqlGeometry instance. The semantics of the measure value are user-defined.
Public propertyStatic member Null Gets a read-only property providing a null instance of the SqlGeometry type.
Public property STSrid Gets or sets an integer that represents the Spatial Reference Identifier (SRID) of the instance.
Public property STX Gets the X-coordinate property of a Point instance.
Public property STY Gets the Y-coordinate property of a Point instance.
Public property Z Gets the Z (elevation) value of the instance. The semantics of the elevation value are user-defined.

Top

Methods

  Name Description
Public method AsGml Returns the Geography Markup Language (GML) representation of a SqlGeometry instance.
Public method AsTextZM Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeometry instance, augmented with any Z (elevation) and M (measure) values carried by the instance.
Public method BufferWithTolerance Returns a geometric object that represents the union of all point values whose distance from a SqlGeometry instance is less than or equal to a specified value, allowing for a specified tolerance.
Public method Equals (Inherited from Object.)
Public method Filter Offers a fast, index-only intersection method to determine if a SqlGeometry instance intersects another SqlGeometry instance, assuming an index is available.
Protected method Finalize (Inherited from Object.)
Public methodStatic member GeomFromGml Constructs a SqlGeometry instance given a representation in the SQL Server subset of the Geography Markup Language (GML).
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method InstanceOf Tests if the SqlGeometry instance is the same as the specified type.
Public method MakeValid Converts an invalid SqlGeometry instance into a SqlGeometry instance with a valid Open Geospatial Consortium (OGC) type.
Protected method MemberwiseClone (Inherited from Object.)
Public methodStatic member Parse Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation.
Public methodStatic member Point Constructs a SqlGeometry instance that represents a Point instance from its X and Y values and an SRID.
Public method Populate Applies a geometry type call sequence to an IGeometrySink object. The call sequence is a sequential set of figures, lines, and points. SqlGeometry
Public method Read Reads a binary representation of a geometry type into a SqlGeometry object. SqlGeometry
Public method Reduce Returns an approximation of the given SqlGeometry instance produced by running the Douglas-Peucker algorithm on the instance with the given tolerance.
Public method STArea Returns the total surface area of a SqlGeometry instance.
Public method STAsBinary Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a SqlGeometry instance. This value will not contain any Z or M values carried by the instance.
Public method STAsText Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeometry instance. This text will not contain any Z (elevation) or M (measure) values carried by the instance.
Public method STBoundary Returns the boundary of a SqlGeometry instance.
Public method STBuffer Returns a geometric object that represents the union of all points whose distance from a SqlGeometry instance is less than or equal to a specified value.
Public method STCentroid Returns the geometric center of a SqlGeometry instance consisting of one or more polygons.
Public method STContains Specifies whether the calling SqlGeometry instance completely contains another SqlGeometry.
Public method STConvexHull Returns an object that represents the convex hull of a SqlGeometry instance.
Public method STCrosses Determines whether the calling SqlGeometry instance crosses the specified SqlGeometry instance.
Public method STDifference Returns an object that represents the points from one SqlGeometry instance that do not lie within another SqlGeometry instance.
Public method STDimension Returns the maximum dimension of a SqlGeometry instance.
Public method STDisjoint Determines whether the calling SqlGeometry instance is disjointed when compared against the specified SqlGeometry.
Public method STDistance Returns the shortest distance between a point in a SqlGeometry instance and a point in the specified SqlGeometry instance.
Public method STEndPoint Returns the end point of a SqlGeometry instance.
Public method STEnvelope Returns the minimum axis-aligned bounding rectangle of the instance.
Public method STEquals Determines whether the specified SqlGeometry has a point set identical to the calling SqlGeometry.
Public method STExteriorRing Returns the exterior ring of a SqlGeometry instance that is a polygon.
Public methodStatic member STGeomCollFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STGeomCollFromWKB Returns a SqlGeometry collection instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public method STGeometryN Returns the specified SqlGeometry in a SqlGeometry collection.
Public method STGeometryType Returns the Open Geospatial Consortium (OGC) type name represented by a geometry instance. SqlGeometry
Public methodStatic member STGeomFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STGeomFromWKB Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public method STInteriorRingN Returns the specified interior ring of a Polygon SqlGeometry instance.
Public method STIntersection Returns an object that represents the points where a SqlGeometry instance intersects another SqlGeometry instance.
Public method STIntersects Determines whether the calling SqlGeometry instance intersects another SqlGeometry.
Public method STIsClosed Determines whether the start and end points of the calling SqlGeometry are the same.
Public method STIsEmpty Indicates whether the calling SqlGeometry instance is empty.
Public method STIsRing Determines whether the calling SqlGeometry instance is a ring.
Public method STIsSimple Determines whether the calling SqlGeometry instance is simple.
Public method STIsValid Determines whether the SqlGeometry instance is well-formed.
Public method STLength Returns the total length of the elements in a SqlGeometry instance.
Public methodStatic member STLineFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STLineFromWKB Returns a SqlGeometry LineString instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public methodStatic member STMLineFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STMLineFromWKB Returns a SqlGeometry MultiLineString instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public methodStatic member STMPointFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STMPointFromWKB Returns a SqlGeometry Point instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public methodStatic member STMPolyFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STMPolyFromWKB Returns a SqlGeometry MultiPolygon instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public method STNumGeometries Returns the number of SqlGeometry that comprise a SqlGeometry instance.
Public method STNumInteriorRing Returns the number of interior rings of a Polygon SqlGeometry instance.
Public method STNumPoints Returns the sum of the number of points in each of the figures in a SqlGeometry instance.
Public method STOverlaps Determines whether the specified SqlGeometry overlaps the current SqlGeometry.
Public methodStatic member STPointFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STPointFromWKB Returns a SqlGeometry Point instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public method STPointN Returns a specified point in a SqlGeometry instance.
Public method STPointOnSurface Returns an arbitrary point located within the interior of a SqlGeometry instance.
Public methodStatic member STPolyFromText Returns a SqlGeometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance.
Public methodStatic member STPolyFromWKB Returns a SqlGeometry Polygon instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
Public method STRelate Determines whether the calling SqlGeometry is related to the specified SqlGeometry.
Public method STStartPoint Returns the start point of a SqlGeometry instance.
Public method STSymDifference Returns an object that represents all points that are either in one SqlGeometry instance or another SqlGeometry instance, but not those points that lie in both instances.
Public method STTouches Determines whether the specified SqlGeometry touches the current SqlGeometry.
Public method STUnion Returns an object that represents the union of a SqlGeometry instance with another SqlGeometry instance.
Public method STWithin Determines whether the current SqlGeometry is completely within the specified SqlGeometry instance.
Public method ToString Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeometry instance augmented with any Z (elevation) and M (measure) values carried by the instance. (Overrides Object.ToString().)
Public method Write Writes a SqlGeometry instance to a binary stream. SqlGeometry

Top

Remarks

SQL Server 2008 supports a set of methods for the geometry spatial data type. These methods include methods on geometry that are defined by the Open Geospatial Consortium (OGC) standard and a set of Microsoft extensions to that standard.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.