com.esri.arcgis.carto
Interface IText3DElement

All Superinterfaces:
Serializable
All Known Implementing Classes:
Text3DElement

public interface IText3DElement
extends Serializable

Provides access to members that control a Text3D graphic element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getAlignment()
          The text alignment.
 IPoint getAnchorPoint()
          The height of text in world units.
 int getAxisRotation()
          The rotation axis.
 double getDepth()
          The depth of text in world units.
 String getFontName()
          The TrueType font name.
 double getHeight()
          The height of text in world units.
 int getJustification()
          The justification of text.
 int getOrientationPlane()
          The plane of orientation.
 double getRotationAngle()
          The rotation angle about the rotation axis.
 String getText()
          The text string.
 double getZAxisScale()
          The adjustment factor for z axis.
 boolean isBoldFont()
          Indicates if font style is bold.
 boolean isItalicFont()
          Indicates if font style is italic.
 void setAlignment(int pAlignment)
          The text alignment.
 void setAnchorPoint(IPoint ppAnchorPt)
          The height of text in world units.
 void setAxisRotation(int pAxis)
          The rotation axis.
 void setBoldFont(boolean pBoldFont)
          Indicates if font style is bold.
 void setDepth(double pDepth)
          The depth of text in world units.
 void setFontName(String pFontName)
          The TrueType font name.
 void setHeight(double pHeight)
          The height of text in world units.
 void setItalicFont(boolean pItalicFont)
          Indicates if font style is italic.
 void setJustification(int pJustification)
          The justification of text.
 void setOrientationPlane(int pPlane)
          The plane of orientation.
 void setRotationAngle(double pAngle)
          The rotation angle about the rotation axis.
 void setSurface(IFunctionalSurface rhs1)
          The surface for draping.
 void setText(String pText)
          The text string.
 void setZAxisScale(double pZScale)
          The adjustment factor for z axis.
 boolean update()
          Update graphic geometry with current parameters.
 

Method Detail

getText

String getText()
               throws IOException,
                      AutomationException
The text string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setText

void setText(String pText)
             throws IOException,
                    AutomationException
The text string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontName

String getFontName()
                   throws IOException,
                          AutomationException
The TrueType font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFontName

void setFontName(String pFontName)
                 throws IOException,
                        AutomationException
The TrueType font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isBoldFont

boolean isBoldFont()
                   throws IOException,
                          AutomationException
Indicates if font style is bold.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBoldFont

void setBoldFont(boolean pBoldFont)
                 throws IOException,
                        AutomationException
Indicates if font style is bold.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isItalicFont

boolean isItalicFont()
                     throws IOException,
                            AutomationException
Indicates if font style is italic.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setItalicFont

void setItalicFont(boolean pItalicFont)
                   throws IOException,
                          AutomationException
Indicates if font style is italic.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAnchorPoint

IPoint getAnchorPoint()
                      throws IOException,
                             AutomationException
The height of text in world units.

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

setAnchorPoint

void setAnchorPoint(IPoint ppAnchorPt)
                    throws IOException,
                           AutomationException
The height of text in world units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHeight

double getHeight()
                 throws IOException,
                        AutomationException
The height of text in world units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHeight

void setHeight(double pHeight)
               throws IOException,
                      AutomationException
The height of text in world units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDepth

double getDepth()
                throws IOException,
                       AutomationException
The depth of text in world units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDepth

void setDepth(double pDepth)
              throws IOException,
                     AutomationException
The depth of text in world units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getJustification

int getJustification()
                     throws IOException,
                            AutomationException
The justification of text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriT3DJustification constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJustification

void setJustification(int pJustification)
                      throws IOException,
                             AutomationException
The justification of text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pJustification - A com.esri.arcgis.carto.esriT3DJustification constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrientationPlane

int getOrientationPlane()
                        throws IOException,
                               AutomationException
The plane of orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriT3DOrientationPlane constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrientationPlane

void setOrientationPlane(int pPlane)
                         throws IOException,
                                AutomationException
The plane of orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pPlane - A com.esri.arcgis.carto.esriT3DOrientationPlane constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlignment

int getAlignment()
                 throws IOException,
                        AutomationException
The text alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriT3DAlignment constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlignment

void setAlignment(int pAlignment)
                  throws IOException,
                         AutomationException
The text alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pAlignment - A com.esri.arcgis.carto.esriT3DAlignment constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAxisRotation

int getAxisRotation()
                    throws IOException,
                           AutomationException
The rotation axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriT3DRotationAxis constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAxisRotation

void setAxisRotation(int pAxis)
                     throws IOException,
                            AutomationException
The rotation axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pAxis - A com.esri.arcgis.carto.esriT3DRotationAxis constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotationAngle

double getRotationAngle()
                        throws IOException,
                               AutomationException
The rotation angle about the rotation axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRotationAngle

void setRotationAngle(double pAngle)
                      throws IOException,
                             AutomationException
The rotation angle about the rotation axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getZAxisScale

double getZAxisScale()
                     throws IOException,
                            AutomationException
The adjustment factor for z axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setZAxisScale

void setZAxisScale(double pZScale)
                   throws IOException,
                          AutomationException
The adjustment factor for z axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSurface

void setSurface(IFunctionalSurface rhs1)
                throws IOException,
                       AutomationException
The surface for draping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

update

boolean update()
               throws IOException,
                      AutomationException
Update graphic geometry with current parameters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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