com.esri.arcgis.schematic
Interface INgAttributeField

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgAttributeFieldProxy, NgAttributeField

public interface INgAttributeField
extends Serializable

Provides access to members that control the attribute field.

Description

An attribute field is a specific attribute whose values are found in a field or a set of fields returned by the query set for the object type (that is, the element type or the diagram type) it is related to.

Product Availability

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

See Also:
INgAttribute

Method Summary
 INgNames getFieldNames()
          List of the field names that build the attribute field.
 String getName()
          Name of the attribute field.
 void setFieldNames(INgNames pVal)
          List of the field names that build the attribute field.
 void setName(String pVal)
          Name of the attribute field.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the attribute field.

Description

This name is defined when the field attribute is created
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

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.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the attribute field.

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.

getFieldNames

INgNames getFieldNames()
                       throws IOException,
                              AutomationException
List of the field names that build the attribute field. These fields must be returned by the query set for the related object type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldNames

void setFieldNames(INgNames pVal)
                   throws IOException,
                          AutomationException
List of the field names that build the attribute field. These fields must be returned by the query set for the related object type.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgNames (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.