com.esri.arcgis.schematic
Interface INgAttributeFormatted

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgAttributeFormattedProxy, NgAttributeFormatted

public interface INgAttributeFormatted
extends Serializable

Provides access to members that control the attribute formatted.

Description

An attribute formatted lets you spawn a new attribute by formatting existing attributes and/or formatting string.

Product Availability

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

See Also:
INgAttribute

Method Summary
 INgAttributes getAttributes()
          List of the attributes to be formatted.
 String getFormat()
          C-language compliant format of the resulting attribute.
 String getName()
          Name of the attribute formatted.
 void setAttributes(INgAttributes pVal)
          List of the attributes to be formatted.
 void setFormat(String pVal)
          C-language compliant format of the resulting attribute.
 void setName(String pVal)
          Name of the attribute formatted.
 

Method Detail

getName

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

Description

This name is defined when the formatted 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 formatted.

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.

getFormat

String getFormat()
                 throws IOException,
                        AutomationException
C-language compliant format of the resulting attribute.

Remarks

Use %s when the values of the concatenated attribute are string values, %e for double values and %d for integer values.

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.

setFormat

void setFormat(String pVal)
               throws IOException,
                      AutomationException
C-language compliant format of the resulting attribute.

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.

getAttributes

INgAttributes getAttributes()
                            throws IOException,
                                   AutomationException
List of the attributes to be formatted.

Product Availability

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

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

setAttributes

void setAttributes(INgAttributes pVal)
                   throws IOException,
                          AutomationException
List of the attributes to be formatted.

Product Availability

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

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