com.esri.arcgis.carto
Interface IMaplexDictionaries

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexDictionaries

public interface IMaplexDictionaries
extends Serializable

Provides access to members that control a collection of Maplex dictionaries.

Description

The Maplex dictionary objects store customized abbreviations and translations. The MaplexDictionaries object is a collection of MaplexDictionary objects, and a MaplexDictionary object is a collection of MaplexDictionaryEntry objects. The dictionaries are held as a property of a MaplexOverposterProperties object, and are referenced on a per-labeling class basis from the MaplexOverposterLayerProperties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addDictionary(IMaplexDictionary dictionary)
          Adds a dictionary to the collection.
 void clear()
          Removes all dictionaries from the collection.
 IMaplexDictionary getDictionary(int index)
          Queries a dictionary from the collection.
 int getDictionaryCount()
          The number of dictionaries in the collection.
 void removeDictionary(int index)
          Deletes the dictionary from the collection.
 

Method Detail

getDictionaryCount

int getDictionaryCount()
                       throws IOException,
                              AutomationException
The number of dictionaries in the collection.

Description

The

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.

addDictionary

void addDictionary(IMaplexDictionary dictionary)
                   throws IOException,
                          AutomationException
Adds a dictionary to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDictionary

IMaplexDictionary getDictionary(int index)
                                throws IOException,
                                       AutomationException
Queries a dictionary from the collection.

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.IMaplexDictionary
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeDictionary

void removeDictionary(int index)
                      throws IOException,
                             AutomationException
Deletes the dictionary from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clear

void clear()
           throws IOException,
                  AutomationException
Removes all dictionaries from the collection.

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.