com.esri.arcgis.carto
Interface IMixedFontGridLabel

All Superinterfaces:

Serializable

All Known Implementing Classes:

MixedFontGridLabel

public interface IMixedFontGridLabel
extends Serializable

Provides access to members that define the appearance of the secondary group of digits in the grid label.

Superseded By

IMixedFontGridLabel2

Description

IMixedFontGridLabel is an interface for creating a grid label where a range of the characters uses a different font. This is typically done when the scale of a map is such that some of the digits in the coordinate system are superfluous and are ideally minimized in the display by using a smaller font. If the map is to be a large scale, the secondary font will be larger, otherwise it would be set to be smaller.

Product Availability

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

Method Summary

short	getNumGroupedDigits() The number of digits that are displayed in the secondary font and color.
IColor	getSecondaryColor() The color of the second group of digits.
Font	getSecondaryFont() The font used for the second group of digits.
void	setNumGroupedDigits(short numGrouped) The number of digits that are displayed in the secondary font and color.
void	setSecondaryColor(IColor color) The color of the second group of digits.
void	setSecondaryFont(Font font) The font used for the second group of digits.

Method Detail

getNumGroupedDigits

short getNumGroupedDigits()
                          throws IOException,
                                 AutomationException

The number of digits that are displayed in the secondary font and color.

Description

NumGroupedDigits number of digits in the second group of numbers. Essentially start counting from the right and this is these are the digits in the second group.

Remarks

Use -1 to switch fonts after the decimal point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The numGrouped

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumGroupedDigits

void setNumGroupedDigits(short numGrouped)
                         throws IOException,
                                AutomationException

The number of digits that are displayed in the secondary font and color.

Description

NumGroupedDigits number of digits in the second group of numbers. Essentially start counting from the right and this is these are the digits in the second group.

Remarks

Use -1 to switch fonts after the decimal point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

numGrouped - The numGrouped (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondaryFont

Font getSecondaryFont()
                      throws IOException,
                             AutomationException

The font used for the second group of digits.

Description

SecondaryFont is the font of the digits that are not in the first group.

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.

setSecondaryFont

void setSecondaryFont(Font font)
                      throws IOException,
                             AutomationException

The font used for the second group of digits.

Description

SecondaryFont is the font of the digits that are not in the first group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

font - 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.

getSecondaryColor

IColor getSecondaryColor()
                         throws IOException,
                                AutomationException

The color of the second group of digits.

Description

SecondaryColor is the color of the digits that are not in the first group.

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.

setSecondaryColor

void setSecondaryColor(IColor color)
                       throws IOException,
                              AutomationException

The color of the second group of digits.

Description

SecondaryColor is the color of the digits that are not in the first group.

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.