com.esri.arcgis.carto
Interface IMaplexDictionary

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexDictionary

public interface IMaplexDictionary
extends Serializable

Provides access to members that control a Maplex dictionary.

Description

A MaplexDictionary object is a collection of MaplexDictionaryEntry objects. Each labeling class can reference one dictionary in its MaplexOverposterLayerProperties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addEntry(IMaplexDictionaryEntry dicEntry)
          Adds an entry to the dictionary.
 void clear()
          Removes all entries from the dictionary.
 IMaplexDictionaryEntry getEntry(int index)
          Gets an entry from the dictionary.
 int getEntryCount()
          The number of entries in the dictionary.
 String getName()
          The name of the dictionary.
 void setName(String name)
          The name of the dictionary.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

void setName(String name)
             throws IOException,
                    AutomationException
The name of the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEntryCount

int getEntryCount()
                  throws IOException,
                         AutomationException
The number of entries in the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addEntry

void addEntry(IMaplexDictionaryEntry dicEntry)
              throws IOException,
                     AutomationException
Adds an entry to the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEntry

IMaplexDictionaryEntry getEntry(int index)
                                throws IOException,
                                       AutomationException
Gets an entry from the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.IMaplexDictionaryEntry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException
Removes all entries from the dictionary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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