Query.Within(TCoordinates) Method

Query.Within<TCoordinates> Method

Tests that the value of the named element is within the specified geometry (see $within).

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.3.0

Syntax

Copy

public static IMongoQuery Within<TCoordinates>(
	string name,
	GeoJsonPolygon<TCoordinates> polygon
)
where TCoordinates : GeoJsonCoordinates

Public Shared Function Within(Of TCoordinates As GeoJsonCoordinates) ( 
	name As String,
	polygon As GeoJsonPolygon(Of TCoordinates)
) As IMongoQuery

static member Within : 
        name : string * 
        polygon : GeoJsonPolygon<'TCoordinates> -> IMongoQuery  when 'TCoordinates : GeoJsonCoordinates

Parameters

name: Type: System.String
The name of the element to test.
polygon: Type: MongoDB.Driver.GeoJsonObjectModel.GeoJsonPolygon<TCoordinates>
The polygon.

Type Parameters

TCoordinates: The type of the coordinates.

Return Value

Type: IMongoQuery
An IMongoQuery.

Reference

Query Class

MongoDB.Driver.Builders Namespace