com.esri.arcgis.carto
Interface IAnnotateLayerTransformationProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface IAnnotateLayerTransformationProperties
extends Serializable

Provides access to members that control transformation properties for the display of dynamic labels (text) for a feature layer..

Remarks

This interface provides access to the properties that describe the display used to generate annotation. For feature-linked annotation, these properties reflect the Display that was used to generate the annotation. These properties are not used for dynamic labeling or standard annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IEnvelope getBounds()
          The full extent in world coordinates.
 double getReferenceScale()
          Reference scale for computing scaled symbol sizes.
 double getScaleRatio()
          Scale ratio of the transformation.
 int getUnits()
          The units of the world coordinates.
 void setBounds(IEnvelope bounds)
          The full extent in world coordinates.
 void setReferenceScale(double scale)
          Reference scale for computing scaled symbol sizes.
 void setScaleRatio(double scale)
          Scale ratio of the transformation.
 void setUnits(int unitsCode)
          The units of the world coordinates.
 

Method Detail

setBounds

void setBounds(IEnvelope bounds)
               throws IOException,
                      AutomationException
The full extent in world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBounds

IEnvelope getBounds()
                    throws IOException,
                           AutomationException
The full extent in world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException
The units of the world coordinates.

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 unitsCode)
              throws IOException,
                     AutomationException
The units of the world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
unitsCode - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScaleRatio

double getScaleRatio()
                     throws IOException,
                            AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Remarks

The ScaleRatio represents the ratio between graphics displayed in the map versus the objects in the real world. In this usage, it is the same as IAnnotateLayerTransformationProperties::ReferenceScale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleRatio

void setScaleRatio(double scale)
                   throws IOException,
                          AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Remarks

The ScaleRatio represents the ratio between graphics displayed in the map versus the objects in the real world. In this usage, it is the same as IAnnotateLayerTransformationProperties::ReferenceScale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException
Reference scale for computing scaled symbol sizes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScale

void setReferenceScale(double scale)
                       throws IOException,
                              AutomationException
Reference scale for computing scaled symbol sizes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.