com.esri.arcgis.carto
Interface IRendererFields

All Superinterfaces:
Serializable
All Known Implementing Classes:
ChartRenderer, DotDensityRenderer

public interface IRendererFields
extends Serializable

Provides access to members that work with the list of fields for renderers that use multiple value fields.

Remarks

This interface provides access to properties and methods for working with fields for renderers that support multiple fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addField(String name, String alias)
          Adds a field to the renderer.
 void clearFields()
          Removes all fields from the renderer.
 void deleteField(String name)
          Removes the specified field from the renderer.
 String getField(int index)
          Field at the specified index.
 String getFieldAlias(int index)
          Field alias at the specified index.
 int getFieldCount()
          Number of fields.
 void setField(int index, String name)
          Field at the specified index.
 void setFieldAlias(int index, String name)
          Field alias at the specified index.
 

Method Detail

getFieldCount

int getFieldCount()
                  throws IOException,
                         AutomationException
Number of fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

String getField(int index)
                throws IOException,
                       AutomationException
Field at the specified index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setField

void setField(int index,
              String name)
              throws IOException,
                     AutomationException
Field at the specified index.

Product Availability

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

Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldAlias

String getFieldAlias(int index)
                     throws IOException,
                            AutomationException
Field alias at the specified index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldAlias

void setFieldAlias(int index,
                   String name)
                   throws IOException,
                          AutomationException
Field alias at the specified index.

Product Availability

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

Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

void addField(String name,
              String alias)
              throws IOException,
                     AutomationException
Adds a field to the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
alias - The alias (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

void deleteField(String name)
                 throws IOException,
                        AutomationException
Removes the specified field from the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearFields

void clearFields()
                 throws IOException,
                        AutomationException
Removes all fields from the renderer.

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.