com.esri.arcgis.carto
Interface IHighlightSuppressionAction

All Superinterfaces:

Serializable

All Known Implementing Classes:

HighlightSuppressionAction

public interface IHighlightSuppressionAction
extends Serializable

Provides access to properties and methods needed to manage the highlight/suppression action.

Product Availability

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

Method Summary

void	clearObjectArray() Clears object array of all previous entries.
boolean	containsFeature(int oID) Indicates whether or not feature is contained in the action.
int	getActionType() Indicates what type of action will be performed.
ISymbol	getHighlightSymbol() Symbol used to highlight the feature meeting highlight action criteria.
boolean	isSuppression() Indicates whether or not the highlight-suppression action is set to suppress features.
void	setActionType(int pVal) Indicates what type of action will be performed.
void	setHighlightSymbolByRef(ISymbol pVal) Symbol used to highlight the feature meeting highlight action criteria.

Method Detail

getActionType

int getActionType()
                  throws IOException,
                         AutomationException

Indicates what type of action will be performed.

Product Availability

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

Returns:

A com.esri.arcgis.carto.enumHighlightSuppression constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionType

void setActionType(int pVal)
                   throws IOException,
                          AutomationException

Indicates what type of action will be performed.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.carto.enumHighlightSuppression constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHighlightSymbol

ISymbol getHighlightSymbol()
                           throws IOException,
                                  AutomationException

Symbol used to highlight the feature meeting highlight action criteria.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHighlightSymbolByRef

void setHighlightSymbolByRef(ISymbol pVal)
                             throws IOException,
                                    AutomationException

Symbol used to highlight the feature meeting highlight action criteria.

Product Availability

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

Parameters:

pVal - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuppression

boolean isSuppression()
                      throws IOException,
                             AutomationException

Indicates whether or not the highlight-suppression action is set to suppress features.

Product Availability

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

Returns:

The bResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

containsFeature

boolean containsFeature(int oID)
                        throws IOException,
                               AutomationException

Indicates whether or not feature is contained in the action.

Product Availability

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

Parameters:

oID - The oID (in)

Returns:

The bResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearObjectArray

void clearObjectArray()
                      throws IOException,
                             AutomationException

Clears object array of all previous entries.

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.