com.esri.arcgis.schematic
Interface INgAttribute

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgAttributeProxy, NgAttribute, NgAttributeConstant, NgAttributeField, NgAttributeFormatted, NgAttributeFunction, NgAttributeGeometry, NgAttributePropertySet, NgAttributeQuery, NgAttributeScript

public interface INgAttribute
extends Serializable

Provides access to members that control the attribute.

Description

The attributes allow manipulating the data related to an element type or related to a diagram type.

They can be used to specify some characteristics for the diagram types or the element types. For example, they can be created to specify coordinates for nodes implemented by a node element type or to specify origin and extremity node identifiers for links implemented by a link element type. They are also used to highlight some database information by associating them with graphic properties. For a diagram type, attributes can be used to set the display scale factor for the diagram symbols or to specify the view window title or the view background color.

Remarks

When you want to create an attribute, you need to specify three mandatory parameters: its name, its type, and the object type (diagram or element type) the attribute is related to.

You can create a new attribute and define these three mandatory parameters through the ArcGIS Schematics Designer or by calling the CreateAttribute method available from the desired INgObjectType interface; that is through the object type related to the element type or the diagram type you want.

Product Availability

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


Method Summary
 void delete()
          Deletes the attribute.
 String getName()
          Name of the attribute.
 INgObjectType getObjectType()
          Object type the attribute is related to.
 int getType()
          Type of the attribute.
 void setName(String pVal)
          Name of the attribute.
 

Method Detail

getName

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

Description

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

A number of predefined attribute names are available. They are very specific for each type of schematic object; that is you have specific predefined names for diagram type, others for node types... When an attibute is created with a predefined name, this attribute impacts directly your diagrams or your elements display.

Here under are the predefined names list for each type of schematic object:


Predefined names for attributes related to a diagram type:

Predefined names for attributes related to a node or drawing element type:

Predefined names for attributes related to a link element type:

Predefined names for attributes related to a node-on-link element type:

Predefined names for attributes related to a sub-link element type:

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.

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.

getType

int getType()
            throws IOException,
                   AutomationException
Type of the attribute.

Description

The attribute type is defined when the 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.

Seven types of attributes are available:

Remarks

Attributes of a given type have their own characteristics. You can specify these characteristics through their specific interface INgAttributeConstant, INgAttributeField, INgAttributeFormatted, INgAttributeFunction, INgAttributeGeometry, or INgAttributeQuery.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriNgAttributeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectType

INgObjectType getObjectType()
                            throws IOException,
                                   AutomationException
Object type the attribute is related to.

Product Availability

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

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

delete

void delete()
            throws IOException,
                   AutomationException
Deletes the attribute.

Product Availability

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

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