com.esri.arcgis.carto
Interface IRulerSettings

All Superinterfaces:
Serializable
All Known Implementing Classes:
RulerSettings

public interface IRulerSettings
extends Serializable

Provides access to members that control Ruler setup.

Remarks

The IRulerSettings interface only has one property, SmallestDivision. This property controls the size of the smallest ruler division in page units of the rulers of the page layout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getSmallestDivision()
          The size of the smallest ruler division.
 void setSmallestDivision(double rulerDivision)
          The size of the smallest ruler division.
 

Method Detail

getSmallestDivision

double getSmallestDivision()
                           throws IOException,
                                  AutomationException
The size of the smallest ruler division. The size is in page units.

Remarks

The PageLayout object has a RulerSettings object which manages ruler settings. IRulerSettings only has one property, SmallestDivision. This property controls the size of the smallest ruler division in page units. For example, if the page size is 8.5 by 11 inches, and the SmallestDivision is set to 2, the rulers, seen in layout view, will read off every 2 inches; if the property is set to .1, the rulers will read of every 1/10 of an inch.

Example:

MapControl pMapControl = new MapControl();    
IRulerSettings pRulerSettings;    
pRulerSettings = pMapControl.getPageLayout().getRulerSettings();    
pRulerSettings.setSmallestDivision(2);    
pMapControl.getActiveView().refresh();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSmallestDivision

void setSmallestDivision(double rulerDivision)
                         throws IOException,
                                AutomationException
The size of the smallest ruler division. The size is in page units.

Example:

MapControl pMapControl = new MapControl();    
IRulerSettings pRulerSettings;    
pRulerSettings = pMapControl.getPageLayout().getRulerSettings();    
pRulerSettings.setSmallestDivision(2);    
pMapControl.getActiveView().refresh();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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