com.esri.arcgis.display
Interface IEnumColors

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEnumColorsProxy

public interface IEnumColors
extends Serializable

Provides access to members that enumerate through Color objects.

Description

IEnumColors is an interface for retrieving a sequence of colors, usually generated by an IColorRamp .

Product Availability

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

See Also:

ICmykColor, IColor, IEnumColors, ICieLabConversion

Method Summary

IColor	next() Returns the next color.
void	reset() Resets the enumerator to the beginning.

Method Detail

next

IColor next()
            throws IOException,
                   AutomationException

Returns the next color.

Description

Next returns the next color in the IEnumColors object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the enumerator to the beginning.

Description

Reset returns the cursor that navigates the IEnumColors object to the first color. Thus, the next time the Next method is used, the first color in the IEnumColors object will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.