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:

• ViewColor: for an attribute that will be used to define the diagram background color.
• ViewTitle: to define an attribute that will define the view window title.
• SpaceSymbolScaling: for an attribute that will set the display scale factor for the diagram symbols.
• SpaceLabelScaling: for an attribute that will set the display scale factor for the diagram labels.
• SpacePaperScale: to define an attribute print scale factor for the diagram.
• SymbolPaperScale: to declare an attribute that will set the print scale factor for the diagram symbols.
• LabelPaperScale: to declare an attribute that will set the print scale factor for the diagram labels.
• VectorImages: to define an attribute that will contain the list of .dxf vector image files.
• RasterImages: to define an attribute that will contain the list of .bmp raster image files.

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

• InitialXPosition: to declare an attribute that will set the initial X coordinate of a node, or of a drawing in user coordinates.
• InitialYPosition: to declare an attribute that will set the initial Y coordinate of a node, or of a drawing in user coordinates.
• InitialRotation: to declare an attribute that will set the initial rotation angle of a node, or of a drawing in degrees.

Predefined names for attributes related to a link element type:

• OriginNode: to define an attribute that will specify the link origin node identifier.
• ExtremityNode: to define an attribute that will specify the link extremity node identifier.
• OriginPortNumber: to declare an attribute that will set the link origin port number on the CGM symbol associated with the origin node.
• ExtremityPortNumber: to declare an attribute that will set the link end port number on the CGM symbol associated with the extremity node.
• InitialListPoints: to declare an attribute that will set the initial link intermediate points list.

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

• InitialXPosition: to declare an attribute that will set the initial X coordinate of a node-on-link in user coordinates.
• InitialYPosition: to declare an attribute that will set the initial Y coordinate of a node-on-link in user coordinates.
• InitialRotation: to declare an attribute that will set the initial rotation angle of a node-on-link in degrees.
• ReferenceLink: to define the link identifier the node-on-link is related to
• AbsolutePosition: to define the absolute position of the node-on-link on its related link. Position passed as a parameter value is an absolute distance computed relative to the origin node (value > 0) or to the endpoint node (value < 0).
• RelativePosition: to define the relative position of the node-on-link on its related link. Position passed as a parameter value (between 0. and 1.) is expressed as a percentage of the link length the node-on-link is related to.

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

• OriginNode: to define an attribute that will specify the sub-link origin node identifier. This origin node is either a node or a node-on-link.
• ExtremityNode: to define an attribute that will specify the sub-link extremity node identifier. This extremity node is either a node or a node-on-link.
• OriginPortNumber: to declare an attribute that will set the sub-link origin port number on the CGM symbol associated with the origin node.
• ExtremityPortNumber: to declare an attribute that will set the sub-link end port number on the CGM symbol associated with the extremity node.
• InitialListPoints: to declare an attribute that will set the list of initially defined sub-link points.
• ReferenceLink: to define the link identifier the sub-link is related to.

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:

• esriNgConstantAttribute, for an attribute whose value is a constant
• esriNgFieldAttribute, for an attribute whose values become from a field or a set of fields returned by the query set for its related object type
• esriNgFormattedAttribute, for an attribute whose values are built by formatting other attributes values and/or string,
• esriNgFunctionAttribute, for an attribute whose values are computed by a function
• esriNgGeometryAttribute, for an attribute whose value is a geometric information decoded from an ESRI BLOB
• esriNgQueryAttribute, for an attribute whose value is returned by a query other than the query set for its related object type
• esriNgByFunctionsAttribute,
• esriNgListPointsAttribute,
• esriNgPropertySetAttribute, for an attribute whose values is stored in a PropertySet

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.