com.esri.arcgis.output
Interface IFontMapEnvironment

All Superinterfaces:
Serializable
All Known Implementing Classes:
FontMapEnvironment, PDFDriver, PDFExporter, PsExporter, PsPrinter

public interface IFontMapEnvironment
extends Serializable

Provides access to members that control the Font Mapping Environment.

Remarks

The IFontMapEnvironment interface tracks the collection of FontMap objects that have been defined and allows for additional settings for the
default font mapping to use with the PostScript driver. Use this interface when you want to control the set of fonts used by the PostScript driver. The FontMapCollection property returns a collection object to allow the developer to add and remove FontMap objects. Since the
FontMapCollection property is read-only, you cannot create your own FontMapCollection object; you must instead manipulate the existing one.

The ArcMap application sets up a default list of font mappings whenever a PostScript Printer is selected. ArcObjects developers are responsible for setting this up themselves. See the example code for a demonstration of how to do this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getApplyDefaultMappingDesc()
          The Font Mapping checkbox description string.
 String getDefaultMapping()
          The Default Font Mapping string.
 Object getDefaultMappingsChoices()
          The Default Mapping Choices for Font Substitution.
 IFontMapCollection getFontMapCollection()
          The FontMap Collection.
 boolean isSaveMappings()
          Indicates whether to save font mappings.
 void setApplyDefaultMappingDesc(String applyDefaultMappingDesc)
          The Font Mapping checkbox description string.
 void setDefaultMapping(String defaultMapping)
          The Default Font Mapping string.
 void setDefaultMappingsChoices(Object defaultMappingChoices)
          The Default Mapping Choices for Font Substitution.
 void setSaveMappings(boolean saveMappings)
          Indicates whether to save font mappings.
 

Method Detail

setSaveMappings

void setSaveMappings(boolean saveMappings)
                     throws IOException,
                            AutomationException
Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSaveMappings

boolean isSaveMappings()
                       throws IOException,
                              AutomationException
Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontMapCollection

IFontMapCollection getFontMapCollection()
                                        throws IOException,
                                               AutomationException
The FontMap Collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.output.IFontMapCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultMappingsChoices

void setDefaultMappingsChoices(Object defaultMappingChoices)
                               throws IOException,
                                      AutomationException
The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultMappingsChoices

Object getDefaultMappingsChoices()
                                 throws IOException,
                                        AutomationException
The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultMapping

void setDefaultMapping(String defaultMapping)
                       throws IOException,
                              AutomationException
The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultMapping

String getDefaultMapping()
                         throws IOException,
                                AutomationException
The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setApplyDefaultMappingDesc

void setApplyDefaultMappingDesc(String applyDefaultMappingDesc)
                                throws IOException,
                                       AutomationException
The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getApplyDefaultMappingDesc

String getApplyDefaultMappingDesc()
                                  throws IOException,
                                         AutomationException
The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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