Interface IFeatureCursor

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to members that hand out enumerated features, field collections and allows for the updating, deleting and inserting of features.

[Guid("D4803EF8-79F4-11D0-97FC-0080C7F79481")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IFeatureCursor

Remarks

The IFeatureCursor interface provides access to a set of features in a feature class. It operates in the same way as ICursor, although it does not inherit from that interface. This saves you from having to use Query-Interface when dealing with features rather than rows.

Feature cursors can be used as an input to IFeatureCursorBuffer, which lets you spatially buffer the features by a distance.

You can also draw the features from a cursor on the display. For more information, see the IFeatureRenderer::Draw method.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Properties

Fields

The fields Collection for this cursor.

IFields Fields { get; }

Property Value

IFields

Remarks

<P>Each table in a database has an ordered collection of fields, there is always at least one field in a table. The ordered collection behaves like a list, so it is possible to access individual fields by a numbered position (or index) in the list.</P> <P>A <STRONG>Fields </STRONG>collection can also exist independently of a table, for example when creating an index on a table you will need to define which fields take part in the index. There are many interfaces which either require or return a <STRONG>Fields </STRONG>collection; these include <STRONG>IClass </STRONG>(therefore also <STRONG>IObjectClass </STRONG>and <STRONG>IFeatureClass</STRONG>), <STRONG>ICursor</STRONG>, <STRONG>IIndex</STRONG>, <STRONG>IFeatureClassDraw</STRONG>, <STRONG>IRowBuffer</STRONG>, <STRONG>ISimpleDataConverter</STRONG>, <STRONG>ITableSort </STRONG>and <STRONG>IValidate</STRONG>.</P>

Methods

DeleteFeature()

Delete the existing Feature in the database corresponding to the current position of the cursor.

void DeleteFeature()

Remarks

The cursor must be initialized to a feature (with the NextFeature() method) before this method can be successfully called.

This should only be called on update cursors. To delete a feature retrieved from a search cursor, call IFeature.Delete on the feature itself.

FindField(string)

The index of the field with the specified name.

int FindField(string Name)

Parameters

Name string

Returns

int

Remarks

If the specified field cannot be found, this method returns a value of -1.

Flush()

Flush any outstanding buffered writes to the database.

void Flush()

Remarks

This method should only be called on insert cursors.

InsertFeature(IFeatureBuffer)

Insert a new Feature into the database using the property values in the input buffer. The ID of the new Feature is returned.

object InsertFeature(IFeatureBuffer buffer)

Parameters

buffer IFeatureBuffer

Returns

object

Remarks

This method should only be called on insert cursors.

NextFeature()

Advance the position of the cursor by one and return the Feature object at that position.

IFeature NextFeature()

Returns

IFeature

Remarks

If you fetch features out of a geodatabase using a cursor (recycling or non recycling), the spatial reference of the feature, as returned by NextFeature, is guaranteed to be in the spatial reference that you specified in the query filter .

 

No guarantee however is made that the geometry of the feature will continue to remain in this spatial reference. In particular, if you use a non recycling cursor, then the feature you fetch will be shared with other consumers and any one of these may change its spatial reference at any time. It is the developers responsibility to test the spatial reference or the geometry you get from the feature (via IFeature::Shape) if you retrieve the geometry at a later time and rely on its spatial reference being a specified spatial reference.

UpdateFeature(IFeature)

Update the existing Feature in the database corresponding to the current position of the cursor.

void UpdateFeature(IFeature Object)

Parameters

Object IFeature

Remarks

This method should only be called on update cursors.