Provides access to scale formatting options.
Product Availability
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
Members
Description | ||
---|---|---|
AbbreviateUnits | Abbreviate the units in the scale string. | |
CalcMapUnitValue | Calculate the number of map units corresponding to the specified page units at the given absolute scale. | |
CapitolizeUnits | Capitolize the units in the scale string. | |
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. | |
Equals | The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles. | |
Format | Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles. | |
LoadFromRegistry | Obtain the scale format to the system default. | |
MapUnits | The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles. | |
NumberFormat | Format used to display scale value, i.e., 20,000. | |
PageUnits | The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles. | |
PageUnitValue | The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles. | |
ReverseOrder | Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in]. | |
SaveToRegistry | Store the scale format as the system default. | |
ScaleToString | Convert the absolute scale to a string using the current IScaleFormat attributes. | |
Separator | Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. | |
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. |