com.esri.arcgis.display
Class TextSymbol

java.lang.Object
  extended by com.esri.arcgis.display.TextSymbol
All Implemented Interfaces:
ICharacterOrientation, IDisplayName, IFormattedTextSymbol, IMapLevel, IMarginProperties, IMask, IQueryGeometry, ISimpleTextSymbol, ISymbol, ISymbolRotation, ITextDrawSupport, ITextParserSupport, ITextSymbol, IWordBoundaries, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, Externalizable, Serializable

public class TextSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFormattedTextSymbol, ISimpleTextSymbol, IMapLevel, ISymbol, ISymbolRotation, IMask, IPersistStream, IPersist, IClone, IDisplayName, IPropertySupport, ITextParserSupport, IQueryGeometry, IMarginProperties, ITextDrawSupport, IWordBoundaries, IXMLSerialize, ICharacterOrientation, Externalizable

A symbol that controls how text is displayed.

Description

Use TextSymbol to create text of either IFormattedTextSymbol or ISimpleTextSymbol.

Remarks

TextSymbol is the primary object for defining the display properties of a TextElement. Commonly edited properties can be set using ITextSymbol while additional interfaces such as ISimpleTextSymbol and IFormattedTextSymbol provide access to other display properties. Text properties such as highway shields and callouts are implemented as Text Backgrounds and can controlled using IFormattedTextSymbol:Background. The Text property of TextSymbol is only used for low level drawing of text. The text string should be set on the TextElement.


If you are editing Geodatabase Annotation, DO NOT control the display of annotation features by obtaining a reference to the TextSymbol through ITextElement::Symbol and change the properties. This will undermine the storage mechanism that Geodatabase Annotation utilizes for efficient storage. For more information on TextSymbols and Geodatabase Annotation, see the interface ISymbolCollectionElement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IFormattedTextSymbol, ITextSymbol, ISimpleTextSymbol, Serialized Form

Constructor Summary
TextSymbol()
          Constructs a TextSymbol using ArcGIS Engine.
TextSymbol(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TextSymbol theTextSymbol = (TextSymbol) obj;
 
Method Summary
 boolean applies(Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 Object apply(Object newObject)
          Applies the given property to the receiver and returns the old object.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean canApply(Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(IGeometry geometry)
          Draws the specified shape.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getAngle()
          Text baseline angle.
 ITextBackground getBackground()
          The text background object.
 int getBreakCharacter()
          Character to be interpreted as text line end.
 int getCase()
          The text case.
 double getCharacterSpacing()
          The character spacing.
 double getCharacterWidth()
          The character width.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IColor getColor()
          Text color.
 Object getCurrent(Object pUnk)
          The object currently being used.
 int getDirection()
          The text direction.
 Object getDrawPoints(int hDC, ITransformation pTransform, IGeometry pGeometry)
          Gets an array of WKSPoints which represent the position at which each line of text is drawn; pGeometry must be a point.
 void getDrawText(String origText, String[] pParsedText, Object[] pPositions)
          Get text the way it will be drawn.
 IFillSymbol getFillSymbol()
          The fill symbol.
 double getFlipAngle()
          The flip angle.
 Font getFont()
          Text font.
 IGeometry getGeometry(int hDC, ITransformation displayTransform, IGeometry drawGeometry)
          Gets the actual geometry of the boundary of the object (which may or may not be a polygon).
 int getHorizontalAlignment()
          Horizontal alignment style.
 double getLeading()
          The character leading.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 double getMargin()
          Value for the margin.
 double getMaskSize()
          The mask size.
 int getMaskStyle()
          The mask style.
 IFillSymbol getMaskSymbol()
          The mask symbol.
 String getNameString()
          The display name of an object.
 int getPosition()
          The text position.
 int getROP2()
          Raster operation code for pixel drawing.
 IColor getShadowColor()
          The shadow color.
 double getShadowXOffset()
          The shadow X offset.
 double getShadowYOffset()
          The shadow Y offset.
 double getSize()
          Text size.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getText()
          Text to draw.
 ITextParser getTextParser()
          The text parser.
 ITextPath getTextPath()
          Path of text baseline.
 void getTextSize(int hDC, ITransformation transformation, String text, double[] xSize, double[] ySize)
          Gets the x and y dimensions of 'text' in points (1/72 inch).
 int getVerticalAlignment()
          Vertical alignment style.
 double getWordSpacing()
          The word spacing.
 double getXOffset()
          Text offset along X-axis.
 double getYOffset()
          Text offset along Y-axis.
 int hashCode()
          the hashcode for this object
 boolean isCJKCharactersRotation()
          Indicates if CJK charcters are rotated.
 boolean isClip()
          Indicates if the text will be clipped per geometry.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isKerning()
          Indicates if kerning is on.
 boolean isRightToLeft()
          Indicates if the text is drawn from right to left.
 boolean isRotateWithTransform()
          Indicates if the symbol rotates with the display.
 boolean isTypeSetting()
          Indicates if typesetting is used.
 void load(IStream pstm)
          load
 void queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary)
          Fills an existing polygon with the boundary of the specified symbol.
 void queryEnvelope(int hDC, ITransformation displayTransform, IGeometry drawGeometry, IEnvelope envelope)
          Queries the envelope of the boundary of the object.
 void queryWordBoundaries(int hDC, ITransformation displayTransform, IGeometry geometry, IGeometryBag boundaries)
          Fills an existing geometry bag with the boundaries of the words in the text symbol.
 void readExternal(ObjectInput in)
           
 void resetDC()
          Restores DC to original state.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAngle(double angle)
          Text baseline angle.
 void setBackgroundByRef(ITextBackground background)
          The text background object.
 void setBreakCharacter(int charIndex)
          Character to be interpreted as text line end.
 void setCase(int textCase)
          The text case.
 void setCharacterSpacing(double characterSpacing)
          The character spacing.
 void setCharacterWidth(double characterWidth)
          The character width.
 void setCJKCharactersRotation(boolean rotation)
          Indicates if CJK charcters are rotated.
 void setClip(boolean clip)
          Indicates if the text will be clipped per geometry.
 void setColor(IColor color)
          Text color.
 void setDirection(int textDirection)
          The text direction.
 void setFillSymbolByRef(IFillSymbol fillSymbol)
          The fill symbol.
 void setFlipAngle(double flipAngle)
          The flip angle.
 void setFont(Font fontDisp)
          Text font.
 void setHorizontalAlignment(int horizAlignment)
          Horizontal alignment style.
 void setKerning(boolean kerning)
          Indicates if kerning is on.
 void setLeading(double leading)
          The character leading.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setMargin(double margin)
          Value for the margin.
 void setMaskSize(double size)
          The mask size.
 void setMaskStyle(int style)
          The mask style.
 void setMaskSymbolByRef(IFillSymbol fillSym)
          The mask symbol.
 void setPosition(int textPosition)
          The text position.
 void setRightToLeft(boolean rightToLeft)
          Indicates if the text is drawn from right to left.
 void setROP2(int drawMode)
          Raster operation code for pixel drawing.
 void setRotateWithTransform(boolean flag)
          Indicates if the symbol rotates with the display.
 void setShadowColor(IColor shadowColor)
          The shadow color.
 void setShadowXOffset(double xOffset)
          The shadow X offset.
 void setShadowYOffset(double yOffset)
          The shadow Y offset.
 void setSize(double size)
          Text size.
 void setText(String text)
          Text to draw.
 void setTextParserByRef(ITextParser parser)
          The text parser.
 void setTextPathByRef(ITextPath textPath)
          Path of text baseline.
 void setTypeSetting(boolean typeSetting)
          Indicates if typesetting is used.
 void setupDC(int hDC, ITransformation transformation)
          Prepares the DC for drawing the symbol.
 void setVerticalAlignment(int vertAlignment)
          Vertical alignment style.
 void setWordSpacing(double wordSpacing)
          The word spacing.
 void setXOffset(double xOffset)
          Text offset along X-axis.
 void setYOffset(double yOffset)
          Text offset along Y-axis.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TextSymbol

public TextSymbol()
           throws IOException,
                  UnknownHostException
Constructs a TextSymbol using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TextSymbol

public TextSymbol(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TextSymbol theTextSymbol = (TextSymbol) obj;

Construct a TextSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TextSymbol.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getShadowColor

public IColor getShadowColor()
                      throws IOException,
                             AutomationException
The shadow color.

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getShadowColor in interface IFormattedTextSymbol
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setShadowColor

public void setShadowColor(IColor shadowColor)
                    throws IOException,
                           AutomationException
The shadow color.

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShadowColor in interface IFormattedTextSymbol
Parameters:
shadowColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

getShadowXOffset

public double getShadowXOffset()
                        throws IOException,
                               AutomationException
The shadow X offset.

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getShadowXOffset in interface IFormattedTextSymbol
Returns:
The xOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadowXOffset

public void setShadowXOffset(double xOffset)
                      throws IOException,
                             AutomationException
The shadow X offset.

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getShadowYOffset

public double getShadowYOffset()
                        throws IOException,
                               AutomationException
The shadow Y offset.

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getShadowYOffset in interface IFormattedTextSymbol
Returns:
The yOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadowYOffset

public void setShadowYOffset(double yOffset)
                      throws IOException,
                             AutomationException
The shadow Y offset.

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPosition

public int getPosition()
                throws IOException,
                       AutomationException
The text position.

Description

Position is whether the ITextSymbol will be normal, subscript, or superscript. Use enumerations: esriTPNormal, esriTPSubscript or esriTPSuperscript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPosition in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextPosition constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
esriTextPosition

setPosition

public void setPosition(int textPosition)
                 throws IOException,
                        AutomationException
The text position.

Description

Position is whether the IFormattedTextSymbol will be normal, subscript, or superscript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPosition in interface IFormattedTextSymbol
Parameters:
textPosition - A com.esri.arcgis.display.esriTextPosition constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
esriTextPosition

getCase

public int getCase()
            throws IOException,
                   AutomationException
The text case.

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCase in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextCase constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
esriTextCase

setCase

public void setCase(int textCase)
             throws IOException,
                    AutomationException
The text case.

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCase in interface IFormattedTextSymbol
Parameters:
textCase - A com.esri.arcgis.display.esriTextCase constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
esriTextCase

getCharacterSpacing

public double getCharacterSpacing()
                           throws IOException,
                                  AutomationException
The character spacing.

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCharacterSpacing in interface IFormattedTextSymbol
Returns:
The characterSpacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

public void setCharacterSpacing(double characterSpacing)
                         throws IOException,
                                AutomationException
The character spacing.

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCharacterSpacing in interface IFormattedTextSymbol
Parameters:
characterSpacing - The characterSpacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

public double getCharacterWidth()
                         throws IOException,
                                AutomationException
The character width.

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCharacterWidth in interface IFormattedTextSymbol
Returns:
The characterWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

public void setCharacterWidth(double characterWidth)
                       throws IOException,
                              AutomationException
The character width.

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCharacterWidth in interface IFormattedTextSymbol
Parameters:
characterWidth - The characterWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWordSpacing

public double getWordSpacing()
                      throws IOException,
                             AutomationException
The word spacing.

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWordSpacing in interface IFormattedTextSymbol
Returns:
The wordSpacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWordSpacing

public void setWordSpacing(double wordSpacing)
                    throws IOException,
                           AutomationException
The word spacing.

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWordSpacing in interface IFormattedTextSymbol
Parameters:
wordSpacing - The wordSpacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKerning

public boolean isKerning()
                  throws IOException,
                         AutomationException
Indicates if kerning is on.

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isKerning in interface IFormattedTextSymbol
Returns:
The kerning
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKerning

public void setKerning(boolean kerning)
                throws IOException,
                       AutomationException
Indicates if kerning is on.

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setKerning in interface IFormattedTextSymbol
Parameters:
kerning - The kerning (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeading

public double getLeading()
                  throws IOException,
                         AutomationException
The character leading.

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLeading in interface IFormattedTextSymbol
Returns:
The leading
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeading

public void setLeading(double leading)
                throws IOException,
                       AutomationException
The character leading.

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLeading in interface IFormattedTextSymbol
Parameters:
leading - The leading (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException
The text direction.

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDirection in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int textDirection)
                  throws IOException,
                         AutomationException
The text direction.

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDirection in interface IFormattedTextSymbol
Parameters:
textDirection - A com.esri.arcgis.display.esriTextDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlipAngle

public double getFlipAngle()
                    throws IOException,
                           AutomationException
The flip angle.

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFlipAngle in interface IFormattedTextSymbol
Returns:
The flipAngle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlipAngle

public void setFlipAngle(double flipAngle)
                  throws IOException,
                         AutomationException
The flip angle.

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFlipAngle in interface IFormattedTextSymbol
Parameters:
flipAngle - The flipAngle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

public ITextBackground getBackground()
                              throws IOException,
                                     AutomationException
The text background object.

Description

Background is the object displayed behind the text. IBalloonCallout, ILineCallout, ISimpleLineCallout or IMarkerTextBackground can be used as backgrounds for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackground in interface IFormattedTextSymbol
Returns:
A reference to a com.esri.arcgis.display.ITextBackground
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

public void setBackgroundByRef(ITextBackground background)
                        throws IOException,
                               AutomationException
The text background object.

Description

Background is the object displayed behind the text. IBalloonCallout, ILineCallout, ISimpleLineCallout or IMarkerTextBackground can be used as backgrounds for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBackgroundByRef in interface IFormattedTextSymbol
Parameters:
background - A reference to a com.esri.arcgis.display.ITextBackground (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTypeSetting

public boolean isTypeSetting()
                      throws IOException,
                             AutomationException
Indicates if typesetting is used.

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isTypeSetting in interface IFormattedTextSymbol
Returns:
The typeSetting
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTypeSetting

public void setTypeSetting(boolean typeSetting)
                    throws IOException,
                           AutomationException
Indicates if typesetting is used.

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTypeSetting in interface IFormattedTextSymbol
Parameters:
typeSetting - The typeSetting (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException
The fill symbol.

Description

FillSymbol is the fill symbol used to render the text. This can be any of the IFillSymbol interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFillSymbol in interface IFormattedTextSymbol
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

public void setFillSymbolByRef(IFillSymbol fillSymbol)
                        throws IOException,
                               AutomationException
The fill symbol.

Description

FillSymbol is the fill symbol used to render the text. This can be any of the IFillSymbol interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFillSymbolByRef in interface IFormattedTextSymbol
Parameters:
fillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFont

public Font getFont()
             throws IOException,
                    AutomationException
Text font.

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the font.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFont in interface ITextSymbol
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(Font fontDisp)
             throws IOException,
                    AutomationException
Text font.

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the font.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFont in interface ITextSymbol
Parameters:
fontDisp - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws IOException,
                      AutomationException
Text size.

Description

Size is the size in points (approx. 1/72 inch) for an ITextSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSize in interface ITextSymbol
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws IOException,
                    AutomationException
Text size.

Description

Size is the size in points (approx. 1/72 inch) for an ITextSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSize in interface ITextSymbol
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws IOException,
                       AutomationException
Text color.

Description

Color is the color for a TextSymbol object. Any IColor object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColor in interface ITextSymbol
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException
Text color.

Description

Color is the color for a TextSymbol object. Any IColor object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColor in interface ITextSymbol
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

getVerticalAlignment

public int getVerticalAlignment()
                         throws IOException,
                                AutomationException
Vertical alignment style.

Description

VerticalAlignment is the enumeration that defines how text is vertically aligned. There are four options: esriTVABaseline, esriTVABottom, esriTVACenter, and esriTVATop. esriTVABaseline is the default VerticalAlignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerticalAlignment in interface ITextSymbol
Returns:
A com.esri.arcgis.display.esriTextVerticalAlignment constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalAlignment

public void setVerticalAlignment(int vertAlignment)
                          throws IOException,
                                 AutomationException
Vertical alignment style.

Description

VerticalAlignment is the enumeration that defines how text is vertically aligned. There are four options: esriTVABaseline , esriTVABottom , esriTVACenter , and esriTVATop . esriTVABaseline is the default VerticalAlignment .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerticalAlignment in interface ITextSymbol
Parameters:
vertAlignment - A com.esri.arcgis.display.esriTextVerticalAlignment constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException
Horizontal alignment style.

Description

HorizontalAlignment is the horizontal alignment that will be applied to text that contains multiple lines. There are four options: esriTHACenter , esriTHAFull , esriTHALeft , and esriTHARight . The default option is esriTHALeft .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHorizontalAlignment in interface ITextSymbol
Returns:
A com.esri.arcgis.display.esriTextHorizontalAlignment constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int horizAlignment)
                            throws IOException,
                                   AutomationException
Horizontal alignment style.

Description

HorizontalAlignment is the horizontal alignment that will be applied to text that contains multiple lines. There are four options: esriTHACenter , esriTHAFull , esriTHALeft , and esriTHARight . The default option is esriTHALeft .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHorizontalAlignment in interface ITextSymbol
Parameters:
horizAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws IOException,
                       AutomationException
Text baseline angle.

Description

Angle is the Angle in degrees that the entire line of text is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAngle in interface ITextSymbol
Returns:
The angle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws IOException,
                     AutomationException
Text baseline angle.

Description

Angle is the Angle in degrees that the entire line of text is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAngle in interface ITextSymbol
Parameters:
angle - The angle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRightToLeft

public boolean isRightToLeft()
                      throws IOException,
                             AutomationException
Indicates if the text is drawn from right to left.

Description

RightToLeft is whether the text is to be displayed in a right to left manner. The default value is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRightToLeft in interface ITextSymbol
Returns:
The rightToLeft
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRightToLeft

public void setRightToLeft(boolean rightToLeft)
                    throws IOException,
                           AutomationException
Indicates if the text is drawn from right to left.

Description

RightToLeft is whether the text is to be displayed in a right to left manner. The default value is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRightToLeft in interface ITextSymbol
Parameters:
rightToLeft - The rightToLeft (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getText

public String getText()
               throws IOException,
                      AutomationException
Text to draw.

Description

Text is the text string that will be drawn using the other properties of the ITextSymbol. This property is only used for low level drawing of a TextSymbol on a display and is not typically used when TextSymbols are used for TextElements. In the case of TextElements, the element stores the text that is used during drawtime.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getText in interface ITextSymbol
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setText

public void setText(String text)
             throws IOException,
                    AutomationException
Text to draw.

Description

Text is the text string that will be drawn using the other properties of the ITextSymbol. This property is only used for low level drawing of a TextSymbol on a display and is not typically used when TextSymbols are used for TextElements. In the case of TextElements, the element stores the text that is used during drawtime.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setText in interface ITextSymbol
Parameters:
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSize

public void getTextSize(int hDC,
                        ITransformation transformation,
                        String text,
                        double[] xSize,
                        double[] ySize)
                 throws IOException,
                        AutomationException
Gets the x and y dimensions of 'text' in points (1/72 inch).

Description

GetTextSize assigns by reference the x and y dimensions of a ITextSymbol given the device context, Transformation, and Text that will be used. This is helpful in planning where to place graphic elements on the map sheet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextSize in interface ITextSymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
text - The text (in)
xSize - The xSize (out: use single element array)
ySize - The ySize (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakCharacter

public int getBreakCharacter()
                      throws IOException,
                             AutomationException
Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBreakCharacter in interface ISimpleTextSymbol
Returns:
The charIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBreakCharacter

public void setBreakCharacter(int charIndex)
                       throws IOException,
                              AutomationException
Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBreakCharacter in interface ISimpleTextSymbol
Parameters:
charIndex - The charIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClip

public boolean isClip()
               throws IOException,
                      AutomationException
Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isClip in interface ISimpleTextSymbol
Returns:
The clip
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClip

public void setClip(boolean clip)
             throws IOException,
                    AutomationException
Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setClip in interface ISimpleTextSymbol
Parameters:
clip - The clip (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextPath

public ITextPath getTextPath()
                      throws IOException,
                             AutomationException
Path of text baseline.

Description

TextPath sets or returns a TextPath object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextPath in interface ISimpleTextSymbol
Returns:
A reference to a com.esri.arcgis.display.ITextPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

public void setTextPathByRef(ITextPath textPath)
                      throws IOException,
                             AutomationException
Path of text baseline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextPathByRef in interface ISimpleTextSymbol
Parameters:
textPath - A reference to a com.esri.arcgis.display.ITextPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXOffset

public double getXOffset()
                  throws IOException,
                         AutomationException
Text offset along X-axis.

Description

XOffset sets or returns the horizontal offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getXOffset in interface ISimpleTextSymbol
Returns:
The xOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws IOException,
                       AutomationException
Text offset along X-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getYOffset

public double getYOffset()
                  throws IOException,
                         AutomationException
Text offset along Y-axis.

Description

YOffset sets or returns the vertical offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getYOffset in interface ISimpleTextSymbol
Returns:
The yOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setYOffset

public void setYOffset(double yOffset)
                throws IOException,
                       AutomationException
Text offset along Y-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws IOException,
                    AutomationException
Prepares the DC for drawing the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

resetDC

public void resetDC()
             throws IOException,
                    AutomationException
Restores DC to original state.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetDC in interface ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws IOException,
                 AutomationException
Draws the specified shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ISymbol
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.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws IOException,
                          AutomationException
Fills an existing polygon with the boundary of the specified symbol.

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryBoundary in interface ISymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - 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.

getROP2

public int getROP2()
            throws IOException,
                   AutomationException
Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getROP2 in interface ISymbol
Returns:
A com.esri.arcgis.display.esriRasterOpCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setROP2

public void setROP2(int drawMode)
             throws IOException,
                    AutomationException
Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setROP2 in interface ISymbol
Parameters:
drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRotateWithTransform

public boolean isRotateWithTransform()
                              throws IOException,
                                     AutomationException
Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRotateWithTransform in interface ISymbolRotation
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws IOException,
                                   AutomationException
Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRotateWithTransform in interface ISymbolRotation
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskStyle

public int getMaskStyle()
                 throws IOException,
                        AutomationException
The mask style.

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaskStyle in interface IMask
Returns:
A com.esri.arcgis.display.esriMaskStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskStyle

public void setMaskStyle(int style)
                  throws IOException,
                         AutomationException
The mask style.

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskStyle in interface IMask
Parameters:
style - A com.esri.arcgis.display.esriMaskStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskSize

public double getMaskSize()
                   throws IOException,
                          AutomationException
The mask size.

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaskSize in interface IMask
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskSize

public void setMaskSize(double size)
                 throws IOException,
                        AutomationException
The mask size.

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskSize in interface IMask
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskSymbol

public IFillSymbol getMaskSymbol()
                          throws IOException,
                                 AutomationException
The mask symbol.

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol interface can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaskSymbol in interface IMask
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskSymbolByRef

public void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws IOException,
                               AutomationException
The mask symbol.

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol interface can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskSymbolByRef in interface IMask
Parameters:
fillSym - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException
The display name of an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNameString in interface IDisplayName
Returns:
The displayName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException
Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
applies in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The applies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException
Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canApply in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The canApply
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException
The object currently being used.

Product Availability

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

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException
Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextParser

public ITextParser getTextParser()
                          throws IOException,
                                 AutomationException
The text parser.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextParser in interface ITextParserSupport
Returns:
A reference to a com.esri.arcgis.display.ITextParser
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextParserByRef

public void setTextParserByRef(ITextParser parser)
                        throws IOException,
                               AutomationException
The text parser.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextParserByRef in interface ITextParserSupport
Parameters:
parser - A reference to a com.esri.arcgis.display.ITextParser (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry(int hDC,
                             ITransformation displayTransform,
                             IGeometry drawGeometry)
                      throws IOException,
                             AutomationException
Gets the actual geometry of the boundary of the object (which may or may not be a polygon).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGeometry in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
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.

queryEnvelope

public void queryEnvelope(int hDC,
                          ITransformation displayTransform,
                          IGeometry drawGeometry,
                          IEnvelope envelope)
                   throws IOException,
                          AutomationException
Queries the envelope of the boundary of the object.

Description

You must instantiate the Envelope before calling QueryEnvelope. For example,

Dim pEnv as IEnvelope

Set pEnv = New Envelope

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryEnvelope in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMargin

public double getMargin()
                 throws IOException,
                        AutomationException
Value for the margin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMargin in interface IMarginProperties
Returns:
The margin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMargin

public void setMargin(double margin)
               throws IOException,
                      AutomationException
Value for the margin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMargin in interface IMarginProperties
Parameters:
margin - The margin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDrawText

public void getDrawText(String origText,
                        String[] pParsedText,
                        Object[] pPositions)
                 throws IOException,
                        AutomationException
Get text the way it will be drawn. Optionally gives the positions of drawn characters in the original string of characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDrawText in interface ITextDrawSupport
Parameters:
origText - The origText (in)
pParsedText - The pParsedText (out: use single element array)
pPositions - A Variant (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDrawPoints

public Object getDrawPoints(int hDC,
                            ITransformation pTransform,
                            IGeometry pGeometry)
                     throws IOException,
                            AutomationException
Gets an array of WKSPoints which represent the position at which each line of text is drawn; pGeometry must be a point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDrawPoints in interface ITextDrawSupport
Parameters:
hDC - The hDC (A COM typedef) (in)
pTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryWordBoundaries

public void queryWordBoundaries(int hDC,
                                ITransformation displayTransform,
                                IGeometry geometry,
                                IGeometryBag boundaries)
                         throws IOException,
                                AutomationException
Fills an existing geometry bag with the boundaries of the words in the text symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryWordBoundaries in interface IWordBoundaries
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundaries - A reference to a com.esri.arcgis.geometry.IGeometryBag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCJKCharactersRotation

public void setCJKCharactersRotation(boolean rotation)
                              throws IOException,
                                     AutomationException
Indicates if CJK charcters are rotated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCJKCharactersRotation in interface ICharacterOrientation
Parameters:
rotation - The rotation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCJKCharactersRotation

public boolean isCJKCharactersRotation()
                                throws IOException,
                                       AutomationException
Indicates if CJK charcters are rotated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCJKCharactersRotation in interface ICharacterOrientation
Returns:
The rotation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException