com.esri.arcgis.display
Interface ICartographicLineSymbol

All Superinterfaces:

ILineSymbol, Serializable

All Known Implementing Classes:

CartographicLineSymbol, HashLineSymbol, MarkerLineSymbol

public interface ICartographicLineSymbol
extends ILineSymbol, Serializable

Provides access to members that control the cartographic line symbol.

Description

ICartographicLineSymbol can be used to draw solid lines as well as repeating dash patterns. You can set the Cap to control the appearance of the start and end nodes. The Join property can be used to control how line vertices will be displayed. Use the ILineSymbol, ILineProperties and the ITemplate interfaces to set additional properties for ICartographicLineSymbols.

Remarks

MiterLimit is not yet implemented.

Product Availability

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

See Also:

IHashLineSymbol, ILineProperties, ILineSymbol, ITemplate, ICartographicLineSymbol, IMultiLayerLineSymbol, IPictureLineSymbol

Method Summary

int	getCap() Line end cap style.
int	getJoin() Line join style.
double	getMiterLimit() Size threshold for showing mitered line joins.
void	setCap(int capStyle) Line end cap style.
void	setJoin(int joinStyle) Line join style.
void	setMiterLimit(double miterLimit) Size threshold for showing mitered line joins.

Methods inherited from interface com.esri.arcgis.display.ILineSymbol

getColor, getWidth, setColor, setWidth

Method Detail

getCap

int getCap()
           throws IOException,
                  AutomationException

Line end cap style.

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriLineCapStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCap

void setCap(int capStyle)
            throws IOException,
                   AutomationException

Line end cap style.

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

capStyle - A com.esri.arcgis.display.esriLineCapStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoin

int getJoin()
            throws IOException,
                   AutomationException

Line join style.

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriLineJoinStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoin

void setJoin(int joinStyle)
             throws IOException,
                    AutomationException

Line join style.

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

joinStyle - A com.esri.arcgis.display.esriLineJoinStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMiterLimit

double getMiterLimit()
                     throws IOException,
                            AutomationException

Size threshold for showing mitered line joins.

Remarks

Not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The miterLimit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMiterLimit

void setMiterLimit(double miterLimit)
                   throws IOException,
                          AutomationException

Size threshold for showing mitered line joins.

Remarks

Not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

miterLimit - The miterLimit (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.