com.esri.arcgis.display
Interface IGeometricEffects

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasicFillSymbol, BasicLineSymbol, BasicMarkerSymbol, RepresentationRule

public interface IGeometricEffects
extends Serializable

Provides access to members that control the geometric effect list.

Remarks

IGeometricEffects interface has methods useful for managing a collection of geometric effects which are present in a RepresentationRule or in basic symbols present within the representation rule such as BasicLineSymbol, BasicFillSymbol and BasicMarkerSymbol objects.

GeometricEffect is a special process that dynamically alters the geometry of feature representation. A single representation rule can contain multiple geometric effects, functioning in sequence to create a complex symbol. IGeometricEffects interface is useful to browse through individual geometric effects participating in a single rule. use IGeometricEffect interface to access a chain of effects as a single geometric effect.

For example, if there are two geometric effects GeometricEffectDash and GeometricEffectOffset applied on linestrokes in sequential order, then you can use IGeometricEffects interface to access both effects. However, you can also use IGeometricEffect interface to get the result of applying a combination of Dash and Offset effects as a single effect.

Product Availability

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

Method Summary

void	add(IGeometricEffect geomEffect) Adds a new geometric effect.
int	getCount() Number of geometric effects.
IGeometricEffect	getElement(int index) The geometric effect at the specified position.
void	insert(int index, IGeometricEffect geomEffect) Inserts a new geometric effect.
void	remove(int index) Removes a geometric effect.
void	removeAll() Removes all geometric effects.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of geometric effects.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IGeometricEffect getElement(int index)
                            throws IOException,
                                   AutomationException

The geometric effect at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.IGeometricEffect

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGeometricEffect geomEffect)
            throws IOException,
                   AutomationException

Inserts a new geometric effect.

Product Availability

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

Parameters:

index - The index (in)

geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IGeometricEffect geomEffect)
         throws IOException,
                AutomationException

Adds a new geometric effect.

Product Availability

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

Parameters:

geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes a geometric effect.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all geometric effects.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.