com.esri.arcgis.carto
Interface IGroupSymbolElement

All Superinterfaces:

Serializable

All Known Implementing Classes:

ParagraphTextElement, PMFTitleTextElement, TextElement

public interface IGroupSymbolElement
extends Serializable

Provides access to members that control Group Symbol Elements.

Superseded By

ISymbolCollectionElement

Remarks

IGroupSymbolElement provides access to properties of TextElements which reference TextSymbols stored in a SymbolCollection as part of Geodatabase Annotation Feature Classes. This interface has been superseded by ISymbolCollectionElement which provides access to more properties.

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.
IColor	getColor() Font color.
double	getFlipAngle() Flip angle.
int	getHorizontalAlignment() Horizontal alignment style.
double	getSize() Font size.
int	getSymbolID() Symbol ID associated with this element.
ITextPath	getTextPath() Text path.
int	getVerticalAlignment() Vertical alignment style.
double	getXOffset() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
IPoint	IGroupSymbolElement_getAnchorPoint() Callout anchor point.
void	importFromESRIAnno(IStream stream, ISpatialReference spatialReference) Loads the anno in a compressed format.
void	setAnchorPoint(IPoint anchorPoint) Callout anchor point.
void	setColor(IColor color) Font color.
void	setFlipAngle(double flipAngle) Flip angle.
void	setGroupSymbol(int symbolID, ISymbol rhs2) The symbol ID associated with this element.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment style.
void	setSize(double pointSize) Font size.
void	setSymbolID(int symbolID) Symbol ID associated with this element.
void	setTextPathByRef(ITextPath textPath) Text path.
void	setVerticalAlignment(int vertAlignment) Vertical alignment style.
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.

setSymbolID

void setSymbolID(int symbolID)
                 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

Parameters:

symbolID - The symbolID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupSymbol

void setGroupSymbol(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.

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)
                        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)

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.

IGroupSymbolElement_getAnchorPoint

IPoint IGroupSymbolElement_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.