com.esri.arcgis.carto
Interface IGridLadderLabels

All Superinterfaces:

Serializable

All Known Implementing Classes:

MgrsGrid

public interface IGridLadderLabels
extends Serializable

Provides access to members that control the ladder label properties of a grid.

Product Availability

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

Method Summary

IColor	getLadderLabelColor() The color of the ladder labels.
int	getLadderLabelColumnCount() The number of ladder label columns.
Font	getLadderLabelFont() The fonst used to display ladder labels.
int	getLadderLabelRowCount() The number of ladder label rows.
double	getLadderLabelSize() The font size used to display ladder labels.
boolean	isShowLadderLabels() Indicates if ladder labels should be displayed.
boolean	isShowOuterLabelsOnly() Indicates if only the outer ladder labels should be shown.
void	setLadderLabelColor(IColor color) The color of the ladder labels.
void	setLadderLabelColumnCount(int columnCount) The number of ladder label columns.
void	setLadderLabelFont(Font font) The fonst used to display ladder labels.
void	setLadderLabelRowCount(int rowCount) The number of ladder label rows.
void	setLadderLabelSize(double size) The font size used to display ladder labels.
void	setShowLadderLabels(boolean show) Indicates if ladder labels should be displayed.
void	setShowOuterLabelsOnly(boolean show) Indicates if only the outer ladder labels should be shown.

Method Detail

isShowLadderLabels

boolean isShowLadderLabels()
                           throws IOException,
                                  AutomationException

Indicates if ladder labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLadderLabels

void setShowLadderLabels(boolean show)
                         throws IOException,
                                AutomationException

Indicates if ladder labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLadderLabelFont

Font getLadderLabelFont()
                        throws IOException,
                               AutomationException

The fonst used to display ladder labels.

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.

setLadderLabelFont

void setLadderLabelFont(Font font)
                        throws IOException,
                               AutomationException

The fonst used to display ladder labels.

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.

getLadderLabelSize

double getLadderLabelSize()
                          throws IOException,
                                 AutomationException

The font size used to display ladder labels.

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.

setLadderLabelSize

void setLadderLabelSize(double size)
                        throws IOException,
                               AutomationException

The font size used to display ladder labels.

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.

getLadderLabelColor

IColor getLadderLabelColor()
                           throws IOException,
                                  AutomationException

The color of the ladder labels.

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.

setLadderLabelColor

void setLadderLabelColor(IColor color)
                         throws IOException,
                                AutomationException

The color of the ladder labels.

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.

getLadderLabelRowCount

int getLadderLabelRowCount()
                           throws IOException,
                                  AutomationException

The number of ladder label rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rowCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLadderLabelRowCount

void setLadderLabelRowCount(int rowCount)
                            throws IOException,
                                   AutomationException

The number of ladder label rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rowCount - The rowCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLadderLabelColumnCount

int getLadderLabelColumnCount()
                              throws IOException,
                                     AutomationException

The number of ladder label columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The columnCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLadderLabelColumnCount

void setLadderLabelColumnCount(int columnCount)
                               throws IOException,
                                      AutomationException

The number of ladder label columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

columnCount - The columnCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowOuterLabelsOnly

boolean isShowOuterLabelsOnly()
                              throws IOException,
                                     AutomationException

Indicates if only the outer ladder labels should be shown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowOuterLabelsOnly

void setShowOuterLabelsOnly(boolean show)
                            throws IOException,
                                   AutomationException

Indicates if only the outer ladder labels should be shown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.