com.esri.arcgis.carto
Interface IFormattedGridLabel

All Superinterfaces:
Serializable
All Known Implementing Classes:
FormattedGridLabel, MixedFontGridLabel

public interface IFormattedGridLabel
extends Serializable

Provides access to members controlling the number format of a grid label.

Description

IFormattedGridLabel is an interface for setting the number format for the labels of an IMapGrid . The format must be of INumberFormat.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 INumberFormat getFormat()
          The format used to display the numbers in the grid label.
 void setFormat(INumberFormat format)
          The format used to display the numbers in the grid label.
 

Method Detail

getFormat

INumberFormat getFormat()
                        throws IOException,
                               AutomationException
The format used to display the numbers in the grid label.

Description

Format is the format for the IFormattedGridLabel . You can use the format to convert the values of the grid labels to strings and vice versa.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFormat

void setFormat(INumberFormat format)
               throws IOException,
                      AutomationException
The format used to display the numbers in the grid label.

Description

Format is the format for the IFormattedGridLabel . You can use the format to convert the values of the grid labels to strings and vice versa.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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