com.esri.arcgis.carto
Interface IGraphicsLayerScale

All Superinterfaces:

Serializable

All Known Implementing Classes:

CompositeGraphicsLayer, GraphicsLayerScale, GraphicsSubLayer, IGraphicsLayerScaleProxy

public interface IGraphicsLayerScale
extends Serializable

Provides access to members that control the Graphics Layer Scale.

Remarks

Use this interface to access the reference scale of a graphics layer. The reference scale's value of the map's graphics layers and annotation layers is shown in the properties of the dataframe under the Annotation Groups tab.

Product Availability

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

Method Summary

double	getReferenceScale() Reference scale of the layer as a representative fraction.
int	getUnits() Units the reference scale is in.
void	setReferenceScale(double pScaleRF) Reference scale of the layer as a representative fraction.
void	setUnits(int units) Units the reference scale is in.

Method Detail

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException

Reference scale of the layer as a representative fraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pScaleRF

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

void setReferenceScale(double pScaleRF)
                       throws IOException,
                              AutomationException

Reference scale of the layer as a representative fraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pScaleRF - The pScaleRF (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException

Units the reference scale is in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int units)
              throws IOException,
                     AutomationException

Units the reference scale is in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.