com.esri.arcgis.geodatabase
Interface IFeatureProgress

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ExportOperation, IFeatureProgressAdapter

public interface IFeatureProgress
extends EventListener, Serializable

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

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	isCancelled(IFeatureProgressIsCancelledEvent theEvent) Indicates whether the cancel button is pressed.
void	setFeatureClassName(IFeatureProgressSetFeatureClassNameEvent theEvent) Input feature class name.
void	setMaxFeatures(IFeatureProgressSetMaxFeaturesEvent theEvent) Maximum number of features/rows in the input object class.
void	setMinFeatures(IFeatureProgressSetMinFeaturesEvent theEvent) Minimum number of features/rows in the input objectclass.
void	setPosition(IFeatureProgressSetPositionEvent theEvent) Current feature/row that currently converted by the converter.
void	setStepValue(IFeatureProgressSetStepValueEvent theEvent) Current position of conversion.
void	step(IFeatureProgressStepEvent theEvent) Step the progressor interval.

Method Detail

setFeatureClassName

void setFeatureClassName(IFeatureProgressSetFeatureClassNameEvent theEvent)
                         throws IOException,
                                AutomationException

Input feature class name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinFeatures

void setMinFeatures(IFeatureProgressSetMinFeaturesEvent theEvent)
                    throws IOException,
                           AutomationException

Minimum number of features/rows in the input objectclass.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxFeatures

void setMaxFeatures(IFeatureProgressSetMaxFeaturesEvent theEvent)
                    throws IOException,
                           AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

void setPosition(IFeatureProgressSetPositionEvent theEvent)
                 throws IOException,
                        AutomationException

Current feature/row that currently converted by the converter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

void setStepValue(IFeatureProgressSetStepValueEvent theEvent)
                  throws IOException,
                         AutomationException

Current position of conversion.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

void step(IFeatureProgressStepEvent theEvent)
          throws IOException,
                 AutomationException

Step the progressor interval.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelled

boolean isCancelled(IFeatureProgressIsCancelledEvent theEvent)
                    throws IOException,
                           AutomationException

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

Remarks

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Returns:

The pbIsCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.