Class QueryFilterClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("FDFEBD95-ED75-11D0-9A95-080009EC734B")]
public class QueryFilterClass : QueryFilter, IQueryFilter2, IQueryFilter, IQueryFilterDefinition4, IQueryFilterDefinition3, IQueryFilterDefinition2, IQueryFilterDefinition, IQueryFilterFIDSet, IClone, IPersistStream, IPersist, IXMLSerialize
Inheritance
QueryFilterClass
Implements
Inherited Members

Constructors

QueryFilterClass()

public QueryFilterClass()

Explicit Interface Implementations

AddField(string)

Appends a single field name to the list of sub-fields.

virtual void AddField(string subField)

Parameters

subField string

Remarks

The AddField method can be used to add a field to the SubFields list before the query is executed. Adding a field will clear the default "*" value from the SubFields. Setting it back to this original "*" can be done either by setting Subfields to "*" or to "".

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

FIDSet

The FID set used to filter results.

virtual IFIDSet FIDSet { get; set; }

Returns

IFIDSet

FilterDefs

The filter definitions specified for this query filter.

virtual IFilterDefs FilterDefs { get; set; }

Returns

IFilterDefs

Remarks

The FilterDefs property contains the set of FilterDefs objects that will be applied to the query.

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetPaginationClause(out int, out int)

A clause that controls query pagination.

virtual void GetPaginationClause(out int Offset, out int RowCount)

Parameters

Offset int
RowCount int

GetResultPaginationToken(out string)

Search_after token token from pagination query with search_after.

virtual void GetResultPaginationToken(out string paginationToken)

Parameters

paginationToken string

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

GetUseResultPaginationToken()

Flag to use search_after token from pagination query with search_after.

virtual bool GetUseResultPaginationToken()

Returns

bool

IQueryFilter2_AddField(string)

virtual void IQueryFilter2_AddField(string subField)

Parameters

subField string

IQueryFilter2_OutputSpatialReference[string]

virtual ISpatialReference IQueryFilter2_OutputSpatialReference[string FieldName] { get; set; }

Parameters

FieldName string

Returns

ISpatialReference

IQueryFilter2_SubFields

virtual string IQueryFilter2_SubFields { get; set; }

Returns

string

IQueryFilter2_WhereClause

virtual string IQueryFilter2_WhereClause { get; set; }

Returns

string

IQueryFilterDefinition2_FilterDefs

virtual IFilterDefs IQueryFilterDefinition2_FilterDefs { get; set; }

Returns

IFilterDefs

IQueryFilterDefinition2_PostfixClause

virtual string IQueryFilterDefinition2_PostfixClause { get; set; }

Returns

string

IQueryFilterDefinition3_FilterDefs

virtual IFilterDefs IQueryFilterDefinition3_FilterDefs { get; set; }

Returns

IFilterDefs

IQueryFilterDefinition3_PostfixClause

virtual string IQueryFilterDefinition3_PostfixClause { get; set; }

Returns

string

IQueryFilterDefinition3_PrefixClause

virtual string IQueryFilterDefinition3_PrefixClause { get; set; }

Returns

string

IQueryFilterDefinition4_FilterDefs

virtual IFilterDefs IQueryFilterDefinition4_FilterDefs { get; set; }

Returns

IFilterDefs

IQueryFilterDefinition4_GetPaginationClause(out int, out int)

virtual void IQueryFilterDefinition4_GetPaginationClause(out int Offset, out int RowCount)

Parameters

Offset int
RowCount int

IQueryFilterDefinition4_PostfixClause

virtual string IQueryFilterDefinition4_PostfixClause { get; set; }

Returns

string

IQueryFilterDefinition4_PrefixClause

virtual string IQueryFilterDefinition4_PrefixClause { get; set; }

Returns

string

IQueryFilterDefinition4_SetPaginationClause(int, int)

virtual void IQueryFilterDefinition4_SetPaginationClause(int Offset, int RowCount)

Parameters

Offset int
RowCount int

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

OutputSpatialReference[string]

The spatial reference in which to output geometry for a given field.

virtual ISpatialReference OutputSpatialReference[string FieldName] { get; set; }

Parameters

FieldName string

Returns

ISpatialReference

PostfixClause

A clause that will be appended to the SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

virtual string PostfixClause { get; set; }

Returns

string

Remarks

The PostfixClause property allows for a postfix clause to be added to a query filter.  The PostfixClause property is a string property. It can be used to specify an ORDER BY clause for the query. Historically, this clause has not been supported due to issues with placement in the SQL generated for spatial and/or versioned queries. This property ensures proper placement of the clause in the SQL generated by the system.

PrefixClause

A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST. Most commonly used for clauses like DISTINCT or ALL.

virtual string PrefixClause { get; set; }

Returns

string

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SetPaginationClause(int, int)

A clause that controls query pagination.

virtual void SetPaginationClause(int Offset, int RowCount)

Parameters

Offset int
RowCount int

SetResultPaginationToken(string)

Search_after token token from pagination query with search_after.

virtual void SetResultPaginationToken(string paginationToken)

Parameters

paginationToken string

SetUseResultPaginationToken(bool)

Flag to use search_after token from pagination query with search_after.

virtual void SetUseResultPaginationToken(bool usePaginationToken)

Parameters

usePaginationToken bool

SpatialResolution

The spatial resolution in which to output geometry.

virtual double SpatialResolution { get; set; }

Returns

double

SubFields

The comma delimited list of field names for the filter.

virtual string SubFields { get; set; }

Returns

string

Remarks

When accessing rows from a subset of data defined by a query filter, all the fields will be present, but just those specified by SubFields will be populated with values. This ensures that the field index positions for an object remain constant no matter how it was hydrated.

When editing data, always use "*" for the SubFields property.

WhereClause

The where clause for the filter.

virtual string WhereClause { get; set; }

Returns

string