com.esri.arcgis.display
Interface INewEnvelopeFeedback2

All Superinterfaces:

IDisplayFeedback, Serializable

All Known Implementing Classes:

NewEnvelopeFeedback

public interface INewEnvelopeFeedback2
extends IDisplayFeedback, Serializable

Provides access to members that control creating a new envelope.

Remarks

Start begins the feedback operation and takes the starting mouse location, while Stop completes the operation. The inherited MoveTo method should typically be called for each MouseMove event between Start and Stop.

When the Stop method is called, it will return an IGeometry representing a rectangular polygon, that is, a polygon with four segments in a rectangle.

The maximum and minimum of this rectangle come from the coordinates of the point given with Start and the point from the MoveTo method to be called. As a result, if MoveTo is never called, then an empty geometry will be returned; the IsEmpty property from IGeometry will return True.

The Constraint property allows you to specify how the feedback will behave and whether or not the feedback is forced to have a particular shape. The default value is zero, or no constraint. The Constraint property can be set at any time but will not have any effect until MoveTo is called.

Product Availability

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

See Also:

IMoveEnvelopeFeedback, IMoveImageFeedback2, INewBezierCurveFeedback, INewPolygonFeedback, INewMultiPointFeedback, IReshapeFeedback, IMoveImageFeedback, IMoveGeometryFeedback, IResizeEnvelopeFeedback2, INewDimensionFeedback, IResizeEnvelopeFeedback, IPolygonMovePointFeedback, INewLineFeedback, INewCircleFeedback, IVertexFeedback, IMoveLineFeedback, IMovePointFeedback, ILineMovePointFeedback, INewEnvelopeFeedback2, IStretchLineFeedback, INewEnvelopeFeedback, IMovePolygonFeedback

Method Summary

double	getAspectRatio() The aspect ratio for the custom constraint type.
int	getConstraint() The constraint on this rubberbander.
IGeometry	INewEnvelopeFeedback2_stop() Stops the feedback and returns the shape.
void	setAspectRatio(double aspectRatio) The aspect ratio for the custom constraint type.
void	setConstraint(int constrain) The constraint on this rubberbander.
void	start(IPoint point) Begins a normal feedback at the given point.

Methods inherited from interface com.esri.arcgis.display.IDisplayFeedback

getSymbol, moveTo, refresh, setDisplayByRef, setSymbolByRef

Method Detail

start

void start(IPoint point)
           throws IOException,
                  AutomationException

Begins a normal feedback at the given point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstraint

int getConstraint()
                  throws IOException,
                         AutomationException

The constraint on this rubberbander.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriEnvelopeConstraints constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstraint

void setConstraint(int constrain)
                   throws IOException,
                          AutomationException

The constraint on this rubberbander.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

constrain - A com.esri.arcgis.display.esriEnvelopeConstraints constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAspectRatio

double getAspectRatio()
                      throws IOException,
                             AutomationException

The aspect ratio for the custom constraint type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The aspectRatio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAspectRatio

void setAspectRatio(double aspectRatio)
                    throws IOException,
                           AutomationException

The aspect ratio for the custom constraint type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

aspectRatio - The aspectRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

INewEnvelopeFeedback2_stop

IGeometry INewEnvelopeFeedback2_stop()
                                     throws IOException,
                                            AutomationException

Stops the feedback and returns the shape. Shape may not be an envelope if the display is rotated.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.