com.esri.arcgis.display
Interface ICharacterMarkerSymbol

All Superinterfaces:
IMarkerSymbol, Serializable
All Known Implementing Classes:
CharacterMarkerSymbol

public interface ICharacterMarkerSymbol
extends IMarkerSymbol, Serializable

Provides access to members that control the character marker symbol.

Description

ICharacterMarkerSymbol can be used to create a marker symbol that uses a TrueType, OpenType or Postscript Type-1 font glyph. You can set the Font and CharacterIndex properties to control the font and glyph used. Use the IMarkerSymbol and ICartographicMarkerSymbol interfaces to set additional properties for ICharacterMarkerSymbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ICharacterMarkerSymbol, IPictureMarkerSymbol, IMarkerSymbol, IArrowMarkerSymbol, IMultiLayerMarkerSymbol, ICartographicMarkerSymbol

Method Summary
 int getCharacterIndex()
          Character index within font.
 Font getFont()
          Font used for character symbol.
 void setCharacterIndex(int charIndex)
          Character index within font.
 void setFont(Font fontDisp)
          Font used for character symbol.
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Method Detail

getFont

Font getFont()
             throws IOException,
                    AutomationException
Font used for character symbol.

Description

Font is the font object (IFontDisp with a StdFont coClass) used by an ICharacterMarkerSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

void setFont(Font fontDisp)
             throws IOException,
                    AutomationException
Font used for character symbol.

Description

Font is the font object (IFontDisp with a StdFont coClass) used by an ICharacterMarkerSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getCharacterIndex

int getCharacterIndex()
                      throws IOException,
                             AutomationException
Character index within font.

Description

CharacterIndex is the index of the character that an ICharacterMarkerSymbol uses in the Font that has been specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCharacterIndex

void setCharacterIndex(int charIndex)
                       throws IOException,
                              AutomationException
Character index within font.

Description

CharacterIndex is the index of the character that an ICharacterMarkerSymbol uses in the Font that has been specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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