Interface IFeatureProgress

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

Provides access to members used to handle events from converting featureclass/table.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("29D3B6DD-3917-11D2-AADF-00C04FA33C20")]
public interface IFeatureProgress

Remarks

The IFeatureProgress interface handles events that are fired by a data conversion or object-loading process.

The various properties, other than IsCancelled, are automatically initialized when data conversion starts. However, it is important to note that you can get these values, but you cannot set them.

Property/Method Description
FeatureClassName Input feature class name.
MinFeatures Minimum number of features/rows in the input object class.
MaxFeatures Maximum number of features/rows in the input object class.
Position Current feature/row that is being converted.
StepValue The number of converted features that are needed to cause the firing of the Step method.
Step

The Step method is fired automatically for every x number of features, where x is the value of StepValue. You can use this event to keep a count of how many features have been converted. The IsCancelled, property is fetched by the converter after every call to Step.

IsCancelled Indicates whether the cancel button is pressed.  The data conversion will be
cancelled if the user presses the cancel button.
[C#]

See the KB article, "HowTo: Use IFeatureProgress and IReplicaProgress properties in .NET" for more information about using this interface in .NET.

[Visual Basic .NET]

See the KB article, "HowTo: Use IFeatureProgress and IReplicaProgress properties in .NET" for more information about using this interface in .NET.

Properties

FeatureClassName

Input feature class name.

string FeatureClassName { set; }

Property Value

string

IsCancelled

Indicates whether the cancel button is pressed. The data conversion will be cancelled if the user press the cancel button.

bool IsCancelled { get; }

Property Value

bool

Remarks

The IsCancelled, property is fetched by the converter after every call to Step.

MaxFeatures

Maximum number of features/rows in the input object class.

long MaxFeatures { set; }

Property Value

long

MinFeatures

Minimum number of features/rows in the input objectclass.

long MinFeatures { set; }

Property Value

long

Position

Current feature/row that currently converted by the converter.

long Position { set; }

Property Value

long

StepValue

Current position of conversion.

long StepValue { set; }

Property Value

long

Methods

Step()

Step the progressor interval.

void Step()

Remarks

The Step method is fired automatically for every x number of features,where x is the value of StepValue. You can use this event to keep a count of how many features have been converted. The IsCancelled, property is fetched by the converter after every call to Step.