IScaleText Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IS > IScaleText Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Carto)  

IScaleText Interface

Provides access to members that control the scale text. Note: the IScaleText interface has been superseded byIScaleText2. Please consider using the more recent version.

Product Availability

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

Members

Name Description
Method DelayEvents Used to batch operations together to minimize notifications.
Method Draw Draws the map surround into the specified display bounds.
Method FitToBounds Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.
Read/write property Format Format of the scale text. Style must be set to custom.
Read-only property Icon Icon used to represent the map surround.
Read/write property Map The parent map.
Read/write property MapUnitLabel Map unit label of the scale text. Style must be set to relative.
Read/write property MapUnits Map units of the scale text. Style must be set to custom.
Read/write property Name Name of the map surround.
Read/write property NumberFormat Number formatting.
Read/write property PageUnitLabel Page unit label of the scale text. Style must be set to relative.
Read/write property PageUnits Page units of the scale text. Style must be set to custom.
Method QueryBounds Returns the bounds of the map surround.
Method Refresh Makes sure the latest updates are refected the next time the Map Surround is drawn.
Read/write property Style Style of the scale text.
Read/write property Symbol Symbol of the scale text.
Read-only property Text The scale text.

Inherited Interfaces

Interfaces Description
IMapSurround Provides access to members that control the map surround.

CoClasses that implement IScaleText

CoClasses and Classes Description
ScaleText A map surround for displaying a scale text.

Remarks

ScaleText is essentially a text element that describes the map�s scale. One example of scale text is �1 inch equals 2,400 miles�.
The interface IScaleText controls the format of the string that is added as a map surround element.

Text returns the text displayed e.g. �1 inch equals 2,400 miles�.

Symbol is a text symbol that you may access to modify its appearance.

NumberFormat is an INumberFormat that allows you for instance to modify the number of decimals used to display the map units.

The MapUnits and PageUnits are esriUnits and will initially reflect the current map units and page layout units. They can be set to any units to suit your needs.

The MapUnitLabel and PageUnitLabel are the labels describing the units used in the scale text. For instance, "kilometers" which you may change to "km" by setting the MapUnitLabel property.

The Style property is an esriScaleTextStyleEnum and can take two values defining if the scale text type is relative - �1 inch equals 2,400 miles� - or absolute - "1:200,000". Relative scale text is the default.

The Format property is not currently implemented.

There is no way to change the text in any other way than those listed here except by converting the Scale Text to graphics after it has been created or reading the text it returns and create your own text element to display it but the resulting scale will not be linked to the scale of the map frame anymore.