com.esri.arcgis.display
Interface ILineFillSymbol

All Superinterfaces:
IFillSymbol, Serializable
All Known Implementing Classes:
LineFillSymbol

public interface ILineFillSymbol
extends IFillSymbol, Serializable

Provides access to members that control the line fill symbol.

Description

ILineFillSymbol is used to draw a fill comprised of line symbols. Any type of line symbol supported by the ILineSymbol interface can be used. Angle, Separation and Offset can be specified to further customize the look of the symbol. Use the IFillSymbol interface to set additional properties for ILineFillSymbols.

Remarks

The Angle property indicates the number of degrees between the LineSymbol and a horizontal line and defaults to 0.

The first line will always be drawn through the origin (0,0) of the container's coordinate system, unless the Offset property is set to a value other than zero. This means that line fill symbols can be aligned or offset as required between multiple shapes.

The Separation property, which is in points, determines the frequency of the line symbols within the areal feature. If the Spearation is less than the LineSymbol's Width, the lines will overlap, but a Separation greater than the Width will leave a transparent area between the LineSymbols, through which underlying symbols' elements can be seen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IFillProperties, IFillSymbol, IDotDensityFillSymbol, IMarkerFillSymbol, ILineFillSymbol, IMultiLayerFillSymbol, IGradientFillSymbol, IDotDensityFillSymbol2, IPictureFillSymbol

Method Summary
 double getAngle()
          Line symbol angle within fill.
 ILineSymbol getLineSymbol()
          Line symbol used for fill.
 double getOffset()
          Line fill offset.
 double getSeparation()
          Line symbol separation within fill.
 void setAngle(double angle)
          Line symbol angle within fill.
 void setLineSymbolByRef(ILineSymbol lineSym)
          Line symbol used for fill.
 void setOffset(double offset)
          Line fill offset.
 void setSeparation(double separation)
          Line symbol separation within fill.
 
Methods inherited from interface com.esri.arcgis.display.IFillSymbol
getColor, getOutline, setColor, setOutline
 

Method Detail

getLineSymbol

ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException
Line symbol used for fill.

Description

LineSymbol is the line symbol used to draw the lines within the fill. Any line symbol supported by the ILineSymbol interface can be specified.

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.

setLineSymbolByRef

void setLineSymbolByRef(ILineSymbol lineSym)
                        throws IOException,
                               AutomationException
Line symbol used for fill.

Description

LineSymbol is the line symbol used to draw the lines within the fill. Any line symbol supported by the ILineSymbol interface can be specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
lineSym - 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.

getAngle

double getAngle()
                throws IOException,
                       AutomationException
Line symbol angle within fill.

Description

Angle is the angle that the line within the fill is displayed. An Angle of 0 (zero) is horizontal, while an Angle of 90 is vertical.

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
Line symbol angle within fill.

Description

Angle is the angle that the line within the fill is displayed. An Angle of 0 (zero) is horizontal, while an Angle of 90 is vertical.

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.

getSeparation

double getSeparation()
                     throws IOException,
                            AutomationException
Line symbol separation within fill.

Description

Separation is the distance between each line within the fill. Separation is specified in points (approximately 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSeparation

void setSeparation(double separation)
                   throws IOException,
                          AutomationException
Line symbol separation within fill.

Description

Separation is the distance between each line within the fill. Separation is specified in points (approximately 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOffset

double getOffset()
                 throws IOException,
                        AutomationException
Line fill offset.

Description

Offset is the distance from the origin the first line will be displayed. Offset is specified in points (approximately 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOffset

void setOffset(double offset)
               throws IOException,
                      AutomationException
Line fill offset.

Description

Offset is the distance from the origin the first line will be displayed. Offset is specified in points (approximately 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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