com.esri.arcgis.schematic
Interface INgFilterEffect

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgFilterEffectProxy, NgFilterEffect

public interface INgFilterEffect
extends Serializable

Provides access to members that control the property filter's graphic effects.

Product Availability

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

Method Summary

int	getEffectType() Type of the effect (see esriNgFilterEffect).
Object	getEffectValue() Value of the effect.
String	getSubSymbolName() Name of the sub-symbol on which the effect applies.

Method Detail

getEffectType

int getEffectType()
                  throws IOException,
                         AutomationException

Type of the effect (see esriNgFilterEffect).

Description

The value set for this effect is defined by the EffectValue property. If the SubSymbolName property is set, the effect type concerns this sub-symbol.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriNgFilterEffect constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEffectValue

Object getEffectValue()
                      throws IOException,
                             AutomationException

Value of the effect.

Description

The type of effect is defined by the EffectType property. If the SubSymbolName property is set, the effect value apply to this sub-symbol.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubSymbolName

String getSubSymbolName()
                        throws IOException,
                               AutomationException

Name of the sub-symbol on which the effect applies.

Description

If this property is set, the EffectType and EffectValue properties apply to this sub-symbol.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.