com.esri.arcgis.carto
Interface ISymbolCollectionElement

All Superinterfaces:

Serializable

All Known Implementing Classes:

ParagraphTextElement, PMFTitleTextElement, TextElement

public interface ISymbolCollectionElement
extends Serializable

Provides further access to members that control Collection Symbol Elements.

Remarks

Annotation feature classes often contain many text elements referencing text symbols with the same properties. Rather than redundantly storing the same symbol with each feature in the feature class, annotation feature classes are created with a symbol collection and the TextElements of annotation features can reference symbols in this collection.

ISymbolCollectionElement provides access to properties of TextElements which reference TextSymbols stored in a SymbolCollection as part of Geodatabase Annotation Feature Classes. When editing the TextElements of annotation features, it is critical that this interface is used in order to maintain the linkage to the SymbolCollection symbol. Accessing and updating symbol properties through ITextElement::Symbol will cause the TextElement to become disconnected from the SymbolCollection symbol and the symbol will be stored inline with the feature in the feature class. This is undesirable since TextSymbols can be large in size.

When referencing a symbol in the collection, it is possible to override some of the TextSymbol properties without disconnecting it from the symbol collection symbol. The following properties are overridable: XOffset, YOffset, Horizontal Alignment, Vertical Alignment, Flip Angle, Size, Color, Character Spacing, Character Width, Word Spacing, Leading, Bold, Italic, Underline, Background, and Font Name. Setting any of these properties via ISymbolCollectionElement will properly apply the override to the element. Utilizing overrides instead of disconnecting the element from the SymbolCollection will help minimize the amount of storage required. If you find yourself needing to override many properties to reach the desired appearance for a lot of features, it is recommended that you add another symbol to the symbol collection rather than storing many overrides.

If a element is not referencing a symbol in the SymbolCollection, ISymbolCollectionElement::SymbolID will report a value of -1. Otherwise, it will report the ID of the referenced text symbol.

The property ISymbolCollectionElement::OverriddenProperties reports the value of combined overrides applied to the current element. See the help for this property for an example of how to evaluate this property. If the SymbolID of the element is -1, this property will always report 0.

Product Availability

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

Method Summary

void	drawESRIAnno(IStream stream, ISymbolCollection symbolCollection, ISpatialReference spatialRef, IDisplay display) Draws the anno in a compressed format.
void	exportToESRIAnno(IStream stream) Saves the anno in a compressed format.
ITextBackground	getBackground() Background symbol.
double	getCharacterSpacing() The character spacing.
double	getCharacterWidth() The character width.
IColor	getColor() Font color.
double	getFlipAngle() Flip angle.
String	getFontName() Font name.
IGeometry	getGeometry() Shape of the element as a geometry.
int	getHorizontalAlignment() Horizontal alignment style.
double	getLeading() The character leading.
int	getOverriddenProperties() Overridden properties.
int	getOverriddenPropertiesExclusionMask() Mask used to exclude overrides when drawing.
ISymbol	getSharedSymbol() Collection symbol.
double	getSize() Font size.
int	getSymbolID() Symbol ID associated with this element.
String	getText() Text being displayed by this element.
ITextPath	getTextPath() Text path.
int	getVerticalAlignment() Vertical alignment style.
double	getWordSpacing() The word spacing.
double	getXOffset() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
void	importFromESRIAnno(IStream stream, ISpatialReference spatialReference, ISymbolCollection symbolCollection) Loads the anno in a compressed format.
boolean	isBold() Indicates whether bold fonts style.
boolean	isItalic() Indicates whether italic font style.
boolean	isUnderline() Indicates whether underline font style.
IPoint	ISymbolCollectionElement_getAnchorPoint() Callout anchor point.
void	setAnchorPoint(IPoint anchorPoint) Callout anchor point.
void	setBackgroundByRef(ITextBackground symbol) Background symbol.
void	setBold(boolean bold) Indicates whether bold fonts style.
void	setCharacterSpacing(double characterSpacing) The character spacing.
void	setCharacterWidth(double characterWidth) The character width.
void	setColor(IColor color) Font color.
void	setFlipAngle(double flipAngle) Flip angle.
void	setFontName(String fontName) Font name.
void	setGeometry(IGeometry pGeometry) Shape of the element as a geometry.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment style.
void	setItalic(boolean italic) Indicates whether italic font style.
void	setLeading(double leading) The character leading.
void	setOverriddenProperties(int props) Overridden properties.
void	setOverriddenPropertiesExclusionMask(int mask) Mask used to exclude overrides when drawing.
void	setSharedSymbol(int symbolID, ISymbol rhs2) The symbol ID associated with this element.
void	setSize(double pointSize) Font size.
void	setText(String text) Text being displayed by this element.
void	setTextPathByRef(ITextPath textPath) Text path.
void	setUnderline(boolean underline) Indicates whether underline font style.
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.

Method Detail

getSymbolID

int getSymbolID()
                throws IOException,
                       AutomationException

Symbol ID associated with this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The symbolID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSharedSymbol

void setSharedSymbol(int symbolID,
                     ISymbol rhs2)
                     throws IOException,
                            AutomationException

The symbol ID associated with this element.

Product Availability

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

Parameters:

symbolID - The symbolID (in)

rhs2 - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSharedSymbol

ISymbol getSharedSymbol()
                        throws IOException,
                               AutomationException

Collection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToESRIAnno

void exportToESRIAnno(IStream stream)
                      throws IOException,
                             AutomationException

Saves the anno in a compressed format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

stream - 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.

importFromESRIAnno

void importFromESRIAnno(IStream stream,
                        ISpatialReference spatialReference,
                        ISymbolCollection symbolCollection)
                        throws IOException,
                               AutomationException

Loads the anno in a compressed format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

stream - A reference to a com.esri.arcgis.system.IStream (in)

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawESRIAnno

void drawESRIAnno(IStream stream,
                  ISymbolCollection symbolCollection,
                  ISpatialReference spatialRef,
                  IDisplay display)
                  throws IOException,
                         AutomationException

Draws the anno in a compressed format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

stream - A reference to a com.esri.arcgis.system.IStream (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

double getXOffset()
                  throws IOException,
                         AutomationException

Text offset along X-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The xOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOffset

void setXOffset(double xOffset)
                throws IOException,
                       AutomationException

Text offset along X-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xOffset - The xOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOffset

double getYOffset()
                  throws IOException,
                         AutomationException

Text offset along Y-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The yOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOffset

void setYOffset(double yOffset)
                throws IOException,
                       AutomationException

Text offset along Y-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalAlignment

int getVerticalAlignment()
                         throws IOException,
                                AutomationException

Vertical alignment style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextVerticalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalAlignment

void setVerticalAlignment(int vertAlignment)
                          throws IOException,
                                 AutomationException

Vertical alignment style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException

Horizontal alignment style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

void setHorizontalAlignment(int horizAlignment)
                            throws IOException,
                                   AutomationException

Horizontal alignment style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getFlipAngle

double getFlipAngle()
                    throws IOException,
                           AutomationException

Flip angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flipAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

void setFlipAngle(double flipAngle)
                  throws IOException,
                         AutomationException

Flip angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flipAngle - The flipAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

ISymbolCollectionElement_getAnchorPoint

IPoint ISymbolCollectionElement_getAnchorPoint()
                                               throws IOException,
                                                      AutomationException

Callout anchor point.

Product Availability

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

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 anchorPoint)
                    throws IOException,
                           AutomationException

Callout anchor point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

anchorPoint - 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.

getSize

double getSize()
               throws IOException,
                      AutomationException

Font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pointSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

void setSize(double pointSize)
             throws IOException,
                    AutomationException

Font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pointSize - The pointSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

IColor getColor()
                throws IOException,
                       AutomationException

Font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setColor

void setColor(IColor color)
              throws IOException,
                     AutomationException

Font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getTextPath

ITextPath getTextPath()
                      throws IOException,
                             AutomationException

Text path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ITextPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

void setTextPathByRef(ITextPath textPath)
                      throws IOException,
                             AutomationException

Text path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getCharacterSpacing

double getCharacterSpacing()
                           throws IOException,
                                  AutomationException

The character spacing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characterSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

void setCharacterSpacing(double characterSpacing)
                         throws IOException,
                                AutomationException

The character spacing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

characterSpacing - The characterSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

double getCharacterWidth()
                         throws IOException,
                                AutomationException

The character width.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characterWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

void setCharacterWidth(double characterWidth)
                       throws IOException,
                              AutomationException

The character width.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

characterWidth - The characterWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

double getWordSpacing()
                      throws IOException,
                             AutomationException

The word spacing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The wordSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

void setWordSpacing(double wordSpacing)
                    throws IOException,
                           AutomationException

The word spacing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

double getLeading()
                  throws IOException,
                         AutomationException

The character leading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The leading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

void setLeading(double leading)
                throws IOException,
                       AutomationException

The character leading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

leading - The leading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBold

boolean isBold()
               throws IOException,
                      AutomationException

Indicates whether bold fonts style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bold

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBold

void setBold(boolean bold)
             throws IOException,
                    AutomationException

Indicates whether bold fonts style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bold - The bold (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontName

String getFontName()
                   throws IOException,
                          AutomationException

Font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fontName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontName

void setFontName(String fontName)
                 throws IOException,
                        AutomationException

Font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fontName - The fontName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isItalic

boolean isItalic()
                 throws IOException,
                        AutomationException

Indicates whether italic font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The italic

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItalic

void setItalic(boolean italic)
               throws IOException,
                      AutomationException

Indicates whether italic font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

italic - The italic (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUnderline

boolean isUnderline()
                    throws IOException,
                           AutomationException

Indicates whether underline font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The underline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnderline

void setUnderline(boolean underline)
                  throws IOException,
                         AutomationException

Indicates whether underline font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

underline - The underline (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

ITextBackground getBackground()
                              throws IOException,
                                     AutomationException

Background symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

void setBackgroundByRef(ITextBackground symbol)
                        throws IOException,
                               AutomationException

Background symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - 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.

setOverriddenProperties

void setOverriddenProperties(int props)
                             throws IOException,
                                    AutomationException

Overridden properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

props - The props (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverriddenProperties

int getOverriddenProperties()
                            throws IOException,
                                   AutomationException

Overridden properties.

Remarks

This property returns the sum of values which represent the overriden properties of this element. This property can be evaluated by performing an Xor comparison of the value and the individual override values availible from esriSymbolOverrideEnum. If the element is not referencing a symbol in the symbol collection, this value will be 0.

To reset the element to have no overrides, set the value of the property to 0. Putting values into this property can be used to clear overrides. For instance, if the overrride value is 3 meaning that both X and Y Offset are overriden, you can set the override value to 1 and remove the Y Offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The props

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverriddenPropertiesExclusionMask

void setOverriddenPropertiesExclusionMask(int mask)
                                          throws IOException,
                                                 AutomationException

Mask used to exclude overrides when drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mask - The mask (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverriddenPropertiesExclusionMask

int getOverriddenPropertiesExclusionMask()
                                         throws IOException,
                                                AutomationException

Mask used to exclude overrides when drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The mask

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getText

String getText()
               throws IOException,
                      AutomationException

Text being displayed by this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setText

void setText(String text)
             throws IOException,
                    AutomationException

Text being displayed by this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Shape of the element as a geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometry

void setGeometry(IGeometry pGeometry)
                 throws IOException,
                        AutomationException

Shape of the element as a geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pGeometry - 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.