com.esri.arcgis.display
Interface ILineDecorationElement

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISimpleLineDecorationElement

All Known Implementing Classes:

SimpleLineDecorationElement

public interface ILineDecorationElement
extends Serializable

Provides access to members that control the line decoration element.

Description

ILineDecorationElement implements methods for other interfaces of line decoration elements, like ISimpleLineDecorationElement . You define a marker symbol, how many times it appears, and locations for a line decoration. In order to have line decoration elements that are different on the same line, you will create multiple ISimpleLineDecorationElements .

Product Availability

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

See Also:

ILineDecorationElement, ILineDecoration

Method Summary

void	addPosition(double elementPosition) Adds a position.
void	clearPositions() Clears all positions.
void	deletePosition(int index) Deletes a position.
void	draw(int hDC, ITransformation transform, IGeometry lineGeometry) Draws the given line geometry.
double	getPosition(int index) The element position at the given index.
int	getPositionCount() The number of positions.
boolean	isPositionAsRatio() Indicates if positions represent percentage or absolute distance along the line.
void	queryBoundary(int hDC, ITransformation transform, IGeometry lineGeometry, IPolygon boundary) Queries for the boundary of a given line geometry.
void	setPositionAsRatio(boolean asRatio) Indicates if positions represent percentage or absolute distance along the line.

Method Detail

addPosition

void addPosition(double elementPosition)
                 throws IOException,
                        AutomationException

Adds a position.

Description

AddPosition adds a position where the line decoration element will be drawn. Values between 0 and 1 are valid. 0 indicates the beginning of the line and 1 indicates the end. Intervening values, like 0.25 indicate the percentage along the line that the decoration element will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elementPosition - The elementPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deletePosition

void deletePosition(int index)
                    throws IOException,
                           AutomationException

Deletes a position.

Description

DeletePosition removes the decoration at the given index from the list of positions the decoration element will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearPositions

void clearPositions()
                    throws IOException,
                           AutomationException

Clears all positions.

Description

ClearPositions removes any positions that have been added to the ILineDecorationElement object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPositionAsRatio

boolean isPositionAsRatio()
                          throws IOException,
                                 AutomationException

Indicates if positions represent percentage or absolute distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The asRatio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPositionAsRatio

void setPositionAsRatio(boolean asRatio)
                        throws IOException,
                               AutomationException

Indicates if positions represent percentage or absolute distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

asRatio - The asRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

double getPosition(int index)
                   throws IOException,
                          AutomationException

The element position at the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The elementPos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPositionCount

int getPositionCount()
                     throws IOException,
                            AutomationException

The number of positions.

Description

PositionCount returns the number of positions that have been set for the ILineDecorationElement object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The positionCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBoundary

void queryBoundary(int hDC,
                   ITransformation transform,
                   IGeometry lineGeometry,
                   IPolygon boundary)
                   throws IOException,
                          AutomationException

Queries for the boundary of a given line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hDC - The hDC (A COM typedef) (in)

transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)

lineGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(int hDC,
          ITransformation transform,
          IGeometry lineGeometry)
          throws IOException,
                 AutomationException

Draws the given line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hDC - The hDC (A COM typedef) (in)

transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)

lineGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.