com.esri.arcgis.display
Interface ILineDecoration

All Superinterfaces:
Serializable
All Known Implementing Classes:
LineDecoration

public interface ILineDecoration
extends Serializable

Provides access to members that control the line decoration.

Description

ILineDecoration maintains the list of line decoration elements that will be displayed on a line symbol via the ILineProperties interface. Line decorations are elements that are displayed at a particular location a line. You indicate the location you want the element to appear based on the percentage along the line. Thus, a position of 0 would be at the beginning, 1 would be at the end, and 0.5 would be half way.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILineDecorationElement, ILineDecoration

Method Summary
 void addElement(ILineDecorationElement lineDecorationElement)
          Adds an element.
 void clearElements()
          Clears all line decoration elements.
 void deleteElement(int index)
          Deletes the element at the given index.
 void draw(int hDC, ITransformation transform, IGeometry lineGeometry)
          Draws the given line geometry.
 ILineDecorationElement getElement(int index)
          The element at the given position.
 int getElementCount()
          The number of line decoration elements.
 void moveElement(ILineDecorationElement element, int toIndex)
          Moves a line decoration element to the given index.
 void queryBoundary(int hDC, ITransformation transform, IGeometry lineGeometry, IPolygon boundary)
          Queries for the boundary of the given line geometry.
 

Method Detail

addElement

void addElement(ILineDecorationElement lineDecorationElement)
                throws IOException,
                       AutomationException
Adds an element.

Description

AddElement adds a line decoration element to the list of decorations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deleteElement

void deleteElement(int index)
                   throws IOException,
                          AutomationException
Deletes the element at the given index.

Description

DeleteElement removes the specified decoration element from the list of decoration elements. Use the ElementCount to ensure you specify an element in range.

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.

moveElement

void moveElement(ILineDecorationElement element,
                 int toIndex)
                 throws IOException,
                        AutomationException
Moves a line decoration element to the given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
element - A reference to a com.esri.arcgis.display.ILineDecorationElement (in)
toIndex - The toIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearElements

void clearElements()
                   throws IOException,
                          AutomationException
Clears all line decoration elements.

Description

ClearElements removes all the decoration elements.

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.

getElement

ILineDecorationElement getElement(int index)
                                  throws IOException,
                                         AutomationException
The element at the given position.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.ILineDecorationElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementCount

int getElementCount()
                    throws IOException,
                           AutomationException
The number of line decoration elements.

Description

ElementCount returns the number line decoration elements that have been added to the ILineDecoration .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The lineDecorationElementCount
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 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)
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.