com.esri.arcgis.carto
Interface IScaleText2

All Superinterfaces:

IMapSurround, Serializable

All Known Implementing Classes:

ScaleText

public interface IScaleText2
extends IMapSurround, Serializable

Provides access to members that control the scale text.

Description

This interface is new at ArcGIS 9.3. It supersedes IScaleText.

Product Availability

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

Method Summary

String	getFormat() Format of the scale text.
String	getMapUnitLabel() Map unit label of the scale text.
int	getMapUnits() Map units of the scale text.
INumberFormat	getNumberFormat() Number formatting.
String	getPageUnitLabel() Page unit label of the scale text.
int	getPageUnits() Page units of the scale text.
String	getSeparator() Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
int	getStyle() Style of the scale text.
ITextSymbol	getSymbol() Symbol of the scale text.
String	getText() The scale text.
void	setFormat(String format) Format of the scale text.
void	setMapUnitLabel(String label) Map unit label of the scale text.
void	setMapUnits(int units) Map units of the scale text.
void	setNumberFormat(INumberFormat format) Number formatting.
void	setPageUnitLabel(String label) Page unit label of the scale text.
void	setPageUnits(int units) Page units of the scale text.
void	setSeparator(String separator) Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
void	setStyle(int style) Style of the scale text.
void	setSymbol(ITextSymbol symbol) Symbol of the scale text.

Methods inherited from interface com.esri.arcgis.carto.IMapSurround

delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName

Method Detail

getText

String getText()
               throws IOException,
                      AutomationException

The scale text.

Product Availability

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

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(ITextSymbol symbol)
               throws IOException,
                      AutomationException

Symbol of the scale text.

Product Availability

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

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException

Symbol of the scale text.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

void setStyle(int style)
              throws IOException,
                     AutomationException

Style of the scale text.

Product Availability

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

Parameters:

style - A com.esri.arcgis.carto.esriScaleTextStyleEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyle

int getStyle()
             throws IOException,
                    AutomationException

Style of the scale text.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriScaleTextStyleEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(String format)
               throws IOException,
                      AutomationException

Format of the scale text. Style must be set to custom.

Product Availability

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

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

String getFormat()
                 throws IOException,
                        AutomationException

Format of the scale text. Style must be set to custom.

Product Availability

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

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnits

void setPageUnits(int units)
                  throws IOException,
                         AutomationException

Page units of the scale text. Style must be set to custom.

Product Availability

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

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnits

int getPageUnits()
                 throws IOException,
                        AutomationException

Page units of the scale text. Style must be set to custom.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapUnits

void setMapUnits(int units)
                 throws IOException,
                        AutomationException

Map units of the scale text. Style must be set to custom.

Product Availability

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

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

int getMapUnits()
                throws IOException,
                       AutomationException

Map units of the scale text. Style must be set to custom.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnitLabel

void setPageUnitLabel(String label)
                      throws IOException,
                             AutomationException

Page unit label of the scale text. Style must be set to relative.

Product Availability

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

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnitLabel

String getPageUnitLabel()
                        throws IOException,
                               AutomationException

Page unit label of the scale text. Style must be set to relative.

Product Availability

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

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapUnitLabel

void setMapUnitLabel(String label)
                     throws IOException,
                            AutomationException

Map unit label of the scale text. Style must be set to relative.

Product Availability

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

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnitLabel

String getMapUnitLabel()
                       throws IOException,
                              AutomationException

Map unit label of the scale text. Style must be set to relative.

Product Availability

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

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

void setNumberFormat(INumberFormat format)
                     throws IOException,
                            AutomationException

Number formatting.

Product Availability

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

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.

getNumberFormat

INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

Number formatting.

Product Availability

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

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.

setSeparator

void setSeparator(String separator)
                  throws IOException,
                         AutomationException

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. Also used for 'equals' in relative scale texts.

Product Availability

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

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeparator

String getSeparator()
                    throws IOException,
                           AutomationException

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. Also used for 'equals' in relative scale texts.

Product Availability

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

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.