com.esri.arcgis.schematic
Interface ISchematicAnalystTraceHighlight

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAnalystTraceHighlightProxy, SchematicAnalystFindConnected, SchematicAnalystFindLoops, SchematicAnalystFindOverlappingLinks, SchematicAnalystFindPath

public interface ISchematicAnalystTraceHighlight
extends Serializable

Provides access to members that control the schematic analyst trace result highlighting.

Product Availability

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

See Also:

ISchematicAnalystTraceResult

Method Summary

int	getLinkColor() Color of the highlithted links.
int	getLinkStyle() Style of the highlithted links.
double	getLinkWidth() Width of the highlithted links.
boolean	isLinkColorSet() Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.
boolean	isLinkStyleSet() Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.
boolean	isLinkWidthSet() Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.
void	setLinkColor(int pVal) Color of the highlithted links.
void	setLinkColorSet(boolean pVal) Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.
void	setLinkStyle(int pVal) Style of the highlithted links.
void	setLinkStyleSet(boolean pVal) Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.
void	setLinkWidth(double pVal) Width of the highlithted links.
void	setLinkWidthSet(boolean pVal) Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.

Method Detail

getLinkColor

int getLinkColor()
                 throws IOException,
                        AutomationException

Color of the highlithted links.

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.

See Also:

ISchematicAnalystTraceHighlight.getLinkStyle(), ISchematicAnalystTraceHighlight.isLinkColorSet()

setLinkColor

void setLinkColor(int pVal)
                  throws IOException,
                         AutomationException

Color of the highlithted links.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkStyle

int getLinkStyle()
                 throws IOException,
                        AutomationException

Style of the highlithted links.

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.

See Also:

ISchematicAnalystTraceHighlight.isLinkStyleSet(), ISchematicAnalystTraceHighlight.getLinkColor()

setLinkStyle

void setLinkStyle(int pVal)
                  throws IOException,
                         AutomationException

Style of the highlithted links.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkWidth

double getLinkWidth()
                    throws IOException,
                           AutomationException

Width of the highlithted links.

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.

See Also:

ISchematicAnalystTraceHighlight.isLinkWidthSet()

setLinkWidth

void setLinkWidth(double pVal)
                  throws IOException,
                         AutomationException

Width of the highlithted links.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkColorSet

boolean isLinkColorSet()
                       throws IOException,
                              AutomationException

Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.

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.

See Also:

ISchematicAnalystTraceHighlight.getLinkColor()

setLinkColorSet

void setLinkColorSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the highlighting color currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkStyleSet

boolean isLinkStyleSet()
                       throws IOException,
                              AutomationException

Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.

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.

See Also:

ISchematicAnalystTraceHighlight.getLinkStyle()

setLinkStyleSet

void setLinkStyleSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the highlighting style currently set must be used to highlight the links detected by the trace operation.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLinkWidthSet

boolean isLinkWidthSet()
                       throws IOException,
                              AutomationException

Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.

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.

See Also:

ISchematicAnalystTraceHighlight.getLinkWidth()

setLinkWidthSet

void setLinkWidthSet(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the link width currently specified must be used to highlight the links detected by the trace operation.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.