Class ScaleFormatClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[Guid("7B759B6D-DF88-4AED-ADD7-6F53105B47A4")]
[ClassInterface(ClassInterfaceType.None)]
public class ScaleFormatClass : ScaleFormat, IScaleFormat, IPersistStream, IPersist, IClone, IDocumentVersionSupportGEN
Inheritance
ScaleFormatClass
Implements
Inherited Members

Constructors

ScaleFormatClass()

public ScaleFormatClass()

Explicit Interface Implementations

AbbreviateUnits

Abbreviate the units in the scale string.

virtual bool AbbreviateUnits { get; set; }

Returns

bool

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

CalcMapUnitValue(double)

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

virtual double CalcMapUnitValue(double absoluteScale)

Parameters

absoluteScale double

Returns

double

CapitolizeUnits

Capitolize the units in the scale string.

virtual bool CapitolizeUnits { get; set; }

Returns

bool

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

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.

virtual string CustomFormat { get; set; }

Returns

string

Equals

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

virtual string Equals { get; set; }

Returns

string

Format

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

virtual esriScaleFormat Format { get; set; }

Returns

esriScaleFormat

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersist_GetClassID(out Guid)

virtual void IPersist_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream.  This result is based on the esriArcGISVersion enumeration.  In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

LoadFromRegistry()

Obtain the scale format to the system default.

virtual void LoadFromRegistry()

MapUnits

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

virtual esriUnits MapUnits { get; set; }

Returns

esriUnits

NumberFormat

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

virtual INumberFormat NumberFormat { get; set; }

Returns

INumberFormat

PageUnitValue

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

virtual double PageUnitValue { get; set; }

Returns

double

PageUnits

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

virtual esriUnits PageUnits { get; set; }

Returns

esriUnits

ReverseOrder

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

virtual bool ReverseOrder { get; set; }

Returns

bool

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

SaveToRegistry()

Store the scale format as the system default.

virtual void SaveToRegistry()

ScaleToString(double)

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

virtual string ScaleToString(double Scale)

Parameters

Scale double

Returns

string

Separator

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

virtual string Separator { get; set; }

Returns

string

StringToScale(string)

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

virtual double StringToScale(string scaleStr)

Parameters

scaleStr string

Returns

double