com.esri.arcgis.display
Interface ITextPath

All Superinterfaces:
Serializable
All Known Implementing Classes:
BezierTextPath, OverposterTextPath, SimpleTextPath, WordTextPath

public interface ITextPath
extends Serializable

Provides access to members that control the text path.

Description

This interface provides access to the properties and methods of the various text path types used for drawing a TextElement with a TextSymbol.

Remarks

Commonly accessed properties include the XOffset and YOffset as well as the Geometry. While IElement.Geometry may provide a shortcut to the geometry of a TextElement, it is recommended that you determine the type of text path you have prior to changing the Geometry. For instance, the raw geometry of an OverposterTextPath should never be edited. The Geometry of this path type should be obtained, smoothed, and then included in a new SimpleTextPath for that TextSymbol/TextElement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IGeometry getGeometry()
          The geometry used for the path.
 double getXOffset()
          The X offset value.
 double getYOffset()
          The Y offset value.
 void next(double[] x, double[] y, double[] angle)
          Returns the next coordinate.
 void reset()
          Resets the coordinate enumerator.
 void setGeometryByRef(IGeometry geometry)
          The geometry used for the path.
 void setup(int hDC, ITransformation transformation, ITextSymbol textSym)
          Set up items needed by text path.
 void setXOffset(double xOffset)
          The X offset value.
 void setYOffset(double yOffset)
          The Y offset value.
 

Method Detail

setup

void setup(int hDC,
           ITransformation transformation,
           ITextSymbol textSym)
           throws IOException,
                  AutomationException
Set up items needed by text path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
textSym - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException
The geometry used for the path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry geometry)
                      throws IOException,
                             AutomationException
The geometry used for the path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getXOffset

double getXOffset()
                  throws IOException,
                         AutomationException
The X offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setXOffset

void setXOffset(double xOffset)
                throws IOException,
                       AutomationException
The X offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getYOffset

double getYOffset()
                  throws IOException,
                         AutomationException
The Y offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setYOffset

void setYOffset(double yOffset)
                throws IOException,
                       AutomationException
The Y offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

next

void next(double[] x,
          double[] y,
          double[] angle)
          throws IOException,
                 AutomationException
Returns the next coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
x - The x (out: use single element array)
y - The y (out: use single element array)
angle - The angle (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the coordinate enumerator.

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.