com.esri.arcgis.schematic
Interface INgSymbol

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgSymbolProxy, NgSymbol

public interface INgSymbol
extends Serializable

Provides access to members that define a Computer Graphic Metafile (CGM) symbol.

Description

A symbol is either a simple or a complex graphic figure described in a CGM-compliant file or a character symbol available with certain fonts. It is used to represent the nodes, flags, patterns, drawings, and background images.

The file in which a symbol is described may contain basic geometric elements (line, rectangle, circle, circle arc, text, ...), a boundary, a bounding box, a reference point, link ports and label and pole ports.

A symbol may also refer to another symbol (sub-symbol) by means of its anchor point and of its XY scaling factor and rotation angle.

Product Availability

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

Method Summary

void	getBoundingBox(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the symbol bounding box.
String	getName() Name of the symbol.
INgSymbols	getSubSymbols() List of the sub-symbols that compose the symbol.

Method Detail

getBoundingBox

void getBoundingBox(INgPoint[] upperLeftCorner,
                    INgPoint[] lowerRightCorner)
                    throws IOException,
                           AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the symbol bounding box.

Product Availability

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

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getSymbol(String)

getSubSymbols

INgSymbols getSubSymbols()
                         throws IOException,
                                AutomationException

List of the sub-symbols that compose the symbol.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgSymbols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getSymbol(String)

getName

String getName()
               throws IOException,
                      AutomationException

Name of the symbol.

Description

It is the name of the associated CGM file.

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.

See Also:

INgProject.getSymbol(String)