com.esri.arcgis.carto
Interface IPrincipalDigitsGridLabel

All Superinterfaces:
Serializable
All Known Implementing Classes:
CornerGridLabel

public interface IPrincipalDigitsGridLabel
extends Serializable

Provides access to members that control the properties of grid labels that display numbers with principal digits.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getBaseDigitCount()
          The number of base digits for the label.
 String getEastingSuffix()
          The string used to indicate the Easting.
 String getNorthingSuffix()
          The string used to indicate the Northing.
 int getPrincipalDigitCount()
          The number of principal digits for the label.
 IColor getSmallLabelColor()
          The color of the small label.
 Font getSmallLabelFont()
          The font for the small label.
 double getSmallLabelSize()
          The font size for the small label.
 String getUnitSuffix()
          The string used to indicate the units.
 void setBaseDigitCount(int count)
          The number of base digits for the label.
 void setEastingSuffix(String str)
          The string used to indicate the Easting.
 void setNorthingSuffix(String str)
          The string used to indicate the Northing.
 void setPrincipalDigitCount(int count)
          The number of principal digits for the label.
 void setSmallLabelColor(IColor color)
          The color of the small label.
 void setSmallLabelFont(Font font)
          The font for the small label.
 void setSmallLabelSize(double size)
          The font size for the small label.
 void setUnitSuffix(String str)
          The string used to indicate the units.
 

Method Detail

getSmallLabelFont

Font getSmallLabelFont()
                       throws IOException,
                              AutomationException
The font for the small label.

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.

setSmallLabelFont

void setSmallLabelFont(Font font)
                       throws IOException,
                              AutomationException
The font for the small label.

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.

getSmallLabelSize

double getSmallLabelSize()
                         throws IOException,
                                AutomationException
The font size for the small label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSmallLabelSize

void setSmallLabelSize(double size)
                       throws IOException,
                              AutomationException
The font size for the small label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSmallLabelColor

IColor getSmallLabelColor()
                          throws IOException,
                                 AutomationException
The color of the small label.

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.

setSmallLabelColor

void setSmallLabelColor(IColor color)
                        throws IOException,
                               AutomationException
The color of the small label.

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.

getPrincipalDigitCount

int getPrincipalDigitCount()
                           throws IOException,
                                  AutomationException
The number of principal digits for the label.

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.

setPrincipalDigitCount

void setPrincipalDigitCount(int count)
                            throws IOException,
                                   AutomationException
The number of principal digits for the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBaseDigitCount

int getBaseDigitCount()
                      throws IOException,
                             AutomationException
The number of base digits for the label.

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.

setBaseDigitCount

void setBaseDigitCount(int count)
                       throws IOException,
                              AutomationException
The number of base digits for the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getUnitSuffix

String getUnitSuffix()
                     throws IOException,
                            AutomationException
The string used to indicate the units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUnitSuffix

void setUnitSuffix(String str)
                   throws IOException,
                          AutomationException
The string used to indicate the units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEastingSuffix

String getEastingSuffix()
                        throws IOException,
                               AutomationException
The string used to indicate the Easting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEastingSuffix

void setEastingSuffix(String str)
                      throws IOException,
                             AutomationException
The string used to indicate the Easting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getNorthingSuffix

String getNorthingSuffix()
                         throws IOException,
                                AutomationException
The string used to indicate the Northing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setNorthingSuffix

void setNorthingSuffix(String str)
                       throws IOException,
                              AutomationException
The string used to indicate the Northing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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