Interface IScaleFormat
- Namespace
- ESRI.ArcGIS.esriSystem
- Assembly
- ESRI.Server.System.dll
Provides access to scale formatting options.
[Guid("AE9EDA31-A9F0-4687-B3A5-8C061C92D3EB")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IScaleFormat
Properties
AbbreviateUnits
Abbreviate the units in the scale string.
bool AbbreviateUnits { get; set; }
Property Value
CapitolizeUnits
Capitolize the units in the scale string.
bool CapitolizeUnits { get; set; }
Property Value
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.
string CustomFormat { get; set; }
Property Value
Equals
The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
string Equals { get; set; }
Property Value
Format
Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
esriScaleFormat Format { get; set; }
Property Value
MapUnits
The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
esriUnits MapUnits { get; set; }
Property Value
NumberFormat
Format used to display scale value, i.e., 20,000.
INumberFormat NumberFormat { get; set; }
Property Value
PageUnitValue
The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
double PageUnitValue { get; set; }
Property Value
PageUnits
The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
esriUnits PageUnits { get; set; }
Property Value
ReverseOrder
Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
bool ReverseOrder { get; set; }
Property Value
Separator
Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
string Separator { get; set; }
Property Value
Methods
CalcMapUnitValue(double)
Calculate the number of map units corresponding to the specified page units at the given absolute scale.
double CalcMapUnitValue(double absoluteScale)
Parameters
absoluteScaledouble
Returns
LoadFromRegistry()
Obtain the scale format to the system default.
void LoadFromRegistry()
SaveToRegistry()
Store the scale format as the system default.
void SaveToRegistry()
ScaleToString(double)
Convert the absolute scale to a string using the current IScaleFormat attributes.
string ScaleToString(double Scale)
Parameters
Scaledouble
Returns
StringToScale(string)
Convert the string to an absolute scale using the current IScaleFormat attributes.
double StringToScale(string scaleStr)
Parameters
scaleStrstring