This document is archived and information here might be outdated.  Recommended version.


IScaleFormat Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > System > ESRI.ArcGIS.esriSystem > Interfaces > IS > IScaleFormat Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (System)  

IScaleFormat Interface

Provides access to scale formatting options.

Product Availability

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

Members

Name Description
Read/write property AbbreviateUnits Abbreviate the units in the scale string.
Method CalcMapUnitValue Calculate the number of map units corresponding to the specified page units at the given absolute scale.
Read/write property CapitolizeUnits Capitolize the units in the scale string.
Read/write property CustomFormat A string defining the scale format. Embed XML tokens where scale values should go, i.e., <SCA a=''Attribute''>. Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.
Read/write property Equals The text used for 'equals', i.e., '=' in 1 inch=5 miles.
Read/write property Format Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
Method LoadFromRegistry Obtain the scale format to the system default.
Read/write property MapUnits The map units used to display a scale, i.e., the 'miles' in 1 inch=5 miles.
Read/write property NumberFormat Format used to display scale value, i.e., 20,000.
Read/write property PageUnits The page units used to display a scale, i.e., the 'inch' in 1 inch=5 miles.
Read/write property PageUnitValue The number preceding the page units in a scale, i.e., the '1' in 1 inch=5 miles.
Read/write property ReverseOrder Reverse the standard order [1:1000] becomes [1000:1] and [1 in=10 mi] becomes [10 mi=1 in].
Method SaveToRegistry Store the scale format as the system default.
Method ScaleToString Convert the absolute scale to a string using the current IScaleFormat attributes.
Read/write property Separator Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
Method StringToScale Convert the string to an absolute scale using the current IScaleFormat attributes.

CoClasses that implement IScaleFormat

CoClasses and Classes Description
ScaleFormat A utility object for formatting scale.