com.esri.arcgis.display
Interface ILineProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
CartographicLineSymbol, HashLineSymbol, MarkerLineSymbol

public interface ILineProperties
extends Serializable

Provides access to members that control the properties common to several line types.

Description

ILineProperties is a set of high order properties for some specialized line symbol interfaces, like IHashLineSymbol . These properties aren't implemented for all line symbols because they don't always apply. But for the sake of convenience they are placed in this interface so they can be accessed in a consistent manner, e.g., making a function that sets line properties for any given line symbol interface that supports ILineProperties .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

Method Summary
 ILineDecoration getLineDecoration()
          Line decoration element collection.
 double getLineStartOffset()
          The line start offset.
 double getOffset()
          The line offset value.
 ITemplate getTemplate()
          The line template.
 boolean isDecorationOnTop()
          Indicates if the decoration is drawn on top.
 boolean isFlip()
          Indicates if the line symbol is flipped.
 void setDecorationOnTop(boolean onTop)
          Indicates if the decoration is drawn on top.
 void setFlip(boolean flip)
          Indicates if the line symbol is flipped.
 void setLineDecorationByRef(ILineDecoration lineDecoration)
          Line decoration element collection.
 void setLineStartOffset(double offset)
          The line start offset.
 void setOffset(double offset)
          The line offset value.
 void setTemplateByRef(ITemplate theTemplate)
          The line template.
 

Method Detail

getLineDecoration

ILineDecoration getLineDecoration()
                                  throws IOException,
                                         AutomationException
Line decoration element collection.

Description

LineDecoration is the line decoration for the current ILineProperties .

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.ILineDecoration
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILineDecorationElement, ILineDecoration

setLineDecorationByRef

void setLineDecorationByRef(ILineDecoration lineDecoration)
                            throws IOException,
                                   AutomationException
Line decoration element collection.

Description

putref_LineDecoration is the line decoration for the current ILineProperties .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
lineDecoration - A reference to a com.esri.arcgis.display.ILineDecoration (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILineDecorationElement, ILineDecoration

isDecorationOnTop

boolean isDecorationOnTop()
                          throws IOException,
                                 AutomationException
Indicates if the decoration is drawn on top.

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDecorationOnTop

void setDecorationOnTop(boolean onTop)
                        throws IOException,
                               AutomationException
Indicates if the decoration is drawn on top.

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFlip

boolean isFlip()
               throws IOException,
                      AutomationException
Indicates if the line symbol is flipped.

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFlip

void setFlip(boolean flip)
             throws IOException,
                    AutomationException
Indicates if the line symbol is flipped.

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOffset

double getOffset()
                 throws IOException,
                        AutomationException
The line offset value.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. the Offset can be a positive (above/left) or negative (below/right) number.

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
The line offset value.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. the Offset can be a positive (above/left) or negative (below/right) number.

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.

getLineStartOffset

double getLineStartOffset()
                          throws IOException,
                                 AutomationException
The line start offset.

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

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.

setLineStartOffset

void setLineStartOffset(double offset)
                        throws IOException,
                               AutomationException
The line start offset.

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

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.

getTemplate

ITemplate getTemplate()
                      throws IOException,
                             AutomationException
The line template.

Description

Template is the template of marks and gaps.

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.ITemplate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemplate, ILineProperties.getTemplate(), ILineProperties.setTemplateByRef(com.esri.arcgis.display.ITemplate)

setTemplateByRef

void setTemplateByRef(ITemplate theTemplate)
                      throws IOException,
                             AutomationException
The line template.

Description

putref_Template is the template of marks and gaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theTemplate - A reference to a com.esri.arcgis.display.ITemplate (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemplate, ILineProperties.getTemplate(), ILineProperties.setTemplateByRef(com.esri.arcgis.display.ITemplate)