com.esri.arcgis.system
Interface IScaleFormat

All Superinterfaces:

Serializable

All Known Implementing Classes:

ScaleFormat

public interface IScaleFormat
extends Serializable

Provides access to scale formatting options.

Product Availability

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

Method Summary

double	calcMapUnitValue(double absoluteScale) Calculate the number of map units corresponding to the specified page units at the given absolute scale.
String	getCustomFormat() A string defining the scale format.
String	getEquals() The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
int	getFormat() Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
int	getMapUnits() The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
INumberFormat	getNumberFormat() Format used to display scale value, i.e., 20,000.
int	getPageUnits() The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
double	getPageUnitValue() The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
String	getSeparator() Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
boolean	isAbbreviateUnits() Abbreviate the units in the scale string.
boolean	isCapitolizeUnits() Capitolize the units in the scale string.
boolean	isReverseOrder() Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
void	loadFromRegistry() Obtain the scale format to the system default.
void	saveToRegistry() Store the scale format as the system default.
String	scaleToString(double scale) Convert the absolute scale to a string using the current IScaleFormat attributes.
void	setAbbreviateUnits(boolean flag) Abbreviate the units in the scale string.
void	setCapitolizeUnits(boolean flag) Capitolize the units in the scale string.
void	setCustomFormat(String format) A string defining the scale format.
void	setEquals(String text) The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
void	setFormat(int format) Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
void	setMapUnits(int units) The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
void	setNumberFormat(INumberFormat format) Format used to display scale value, i.e., 20,000.
void	setPageUnits(int units) The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
void	setPageUnitValue(double value) The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
void	setReverseOrder(boolean flag) Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
void	setSeparator(String separator) Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
double	stringToScale(String scaleStr) Convert the string to an absolute scale using the current IScaleFormat attributes.

Method Detail

setFormat

void setFormat(int format)
               throws IOException,
                      AutomationException

Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Product Availability

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

Parameters:

format - A com.esri.arcgis.system.esriScaleFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

int getFormat()
              throws IOException,
                     AutomationException

Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriScaleFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

void setNumberFormat(INumberFormat format)
                     throws IOException,
                            AutomationException

Format used to display scale value, i.e., 20,000.

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

Format used to display scale value, i.e., 20,000.

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.

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.

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.

setPageUnitValue

void setPageUnitValue(double value)
                      throws IOException,
                             AutomationException

The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnitValue

double getPageUnitValue()
                        throws IOException,
                               AutomationException

The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnits

void setPageUnits(int units)
                  throws IOException,
                         AutomationException

The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

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

The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

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.

setEquals

void setEquals(String text)
               throws IOException,
                      AutomationException

The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

Product Availability

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

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEquals

String getEquals()
                 throws IOException,
                        AutomationException

The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

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.

setMapUnits

void setMapUnits(int units)
                 throws IOException,
                        AutomationException

The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

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

The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

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.

setCapitolizeUnits

void setCapitolizeUnits(boolean flag)
                        throws IOException,
                               AutomationException

Capitolize the units in the scale string.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCapitolizeUnits

boolean isCapitolizeUnits()
                          throws IOException,
                                 AutomationException

Capitolize the units in the scale string.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbbreviateUnits

void setAbbreviateUnits(boolean flag)
                        throws IOException,
                               AutomationException

Abbreviate the units in the scale string.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbbreviateUnits

boolean isAbbreviateUnits()
                          throws IOException,
                                 AutomationException

Abbreviate the units in the scale string.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseOrder

void setReverseOrder(boolean flag)
                     throws IOException,
                            AutomationException

Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseOrder

boolean isReverseOrder()
                       throws IOException,
                              AutomationException

Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomFormat

void setCustomFormat(String format)
                     throws IOException,
                            AutomationException

A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

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.

getCustomFormat

String getCustomFormat()
                       throws IOException,
                              AutomationException

A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

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.

calcMapUnitValue

double calcMapUnitValue(double absoluteScale)
                        throws IOException,
                               AutomationException

Calculate the number of map units corresponding to the specified page units at the given absolute scale.

Product Availability

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

Parameters:

absoluteScale - The absoluteScale (in)

Returns:

The mapUnitValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scaleToString

String scaleToString(double scale)
                     throws IOException,
                            AutomationException

Convert the absolute scale to a string using the current IScaleFormat attributes.

Product Availability

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

Parameters:

scale - The scale (in)

Returns:

The scaleStr

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stringToScale

double stringToScale(String scaleStr)
                     throws IOException,
                            AutomationException

Convert the string to an absolute scale using the current IScaleFormat attributes.

Product Availability

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

Parameters:

scaleStr - The scaleStr (in)

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToRegistry

void saveToRegistry()
                    throws IOException,
                           AutomationException

Store the scale format as the system default.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromRegistry

void loadFromRegistry()
                      throws IOException,
                             AutomationException

Obtain the scale format to the system default.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.