com.esri.arcgis.display
Interface IHashLineSymbol

All Superinterfaces:
ILineSymbol, Serializable
All Known Implementing Classes:
HashLineSymbol

public interface IHashLineSymbol
extends ILineSymbol, Serializable

Provides access to members that control the hash line symbol.

Description

IHashLineSymbol draws equal length line segments in a repeated pattern at the specified angle. You can set the HashSymbol (the line symbol of the hash lines) and the Angle. Use the ILineSymbol, ILineProperties, and the ITemplate interfaces to set additional properties for IHashLineSymbols. See the example for how to do this.

Remarks

The HashSymbol property is used to return or set a LineSymbol that draws the hashes across the line path.

The Angle property sets or returns the angle at which the hashes are drawn, relative to the path of the line feature. An angle of 90 degrees will draw all the hashes perpendicular to the path, angles of 0 to 89 degrees will tilt the hash toward the end vertex of the path, and angles of 91 to 180 degrees will tilt the hash toward the start vertex of the path.

The Width property, inherited from ILineSymbol, refers to the length of each hash line, and therefore the actual width of the symbol will be a function of both the Width and Angle properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IHashLineSymbol, ILineProperties, ILineSymbol, ITemplate, ICartographicLineSymbol, IMultiLayerLineSymbol, IPictureLineSymbol

Method Summary
 double getAngle()
          Hash line angle.
 ILineSymbol getHashSymbol()
          Line symbol used for hash pattern.
 void setAngle(double angle)
          Hash line angle.
 void setHashSymbolByRef(ILineSymbol hashSymbol)
          Line symbol used for hash pattern.
 
Methods inherited from interface com.esri.arcgis.display.ILineSymbol
getColor, getWidth, setColor, setWidth
 

Method Detail

getHashSymbol

ILineSymbol getHashSymbol()
                          throws IOException,
                                 AutomationException
Line symbol used for hash pattern.

Description

HashSymbol is the line symbol that is used to draw the hashes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHashLineSymbol, ILineProperties, ILineSymbol, ITemplate, ICartographicLineSymbol, IMultiLayerLineSymbol, IPictureLineSymbol

setHashSymbolByRef

void setHashSymbolByRef(ILineSymbol hashSymbol)
                        throws IOException,
                               AutomationException
Line symbol used for hash pattern.

Description

putref_HashSymbol is the line symbol that is used to draw the hashes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hashSymbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHashLineSymbol, ILineProperties, ILineSymbol, ITemplate, ICartographicLineSymbol, IMultiLayerLineSymbol, IPictureLineSymbol

getAngle

double getAngle()
                throws IOException,
                       AutomationException
Hash line angle.

Description

Angle is the angle that the hash is displayed. An Angle of 0 (zero) is horizontal, while an Angle of 90 is perpendicular to the feature like the ties of a railroad symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAngle

void setAngle(double angle)
              throws IOException,
                     AutomationException
Hash line angle.

Description

Angle is the angle that the hash is displayed. An Angle of 0 (zero) is horizontal, while an Angle of 90 is perpendicular to the feature like the ties of a railroad symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
angle - The angle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.