com.esri.arcgis.carto
Interface ICalibratedMapGridBorder

All Superinterfaces:
Serializable
All Known Implementing Classes:
CalibratedMapGridBorder

public interface ICalibratedMapGridBorder
extends Serializable

Provides access to members that control the calibrated map grid border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IColor getBackgroundColor()
          The background color of the border pattern.
 double getBorderWidth()
          The width of the border in points.
 IColor getForegroundColor()
          The foreground color of the border pattern.
 double getInterval()
          The interval between border patterns in points.
 boolean isAlternating()
          Indicates if the border pattern alternates across the width of the border.
 void setAlternating(boolean alternating)
          Indicates if the border pattern alternates across the width of the border.
 void setBackgroundColor(IColor color)
          The background color of the border pattern.
 void setBorderWidth(double widthPts)
          The width of the border in points.
 void setForegroundColor(IColor color)
          The foreground color of the border pattern.
 void setInterval(double intervalPts)
          The interval between border patterns in points.
 

Method Detail

getForegroundColor

IColor getForegroundColor()
                          throws IOException,
                                 AutomationException
The foreground color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setForegroundColor

void setForegroundColor(IColor color)
                        throws IOException,
                               AutomationException
The foreground color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The background color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException
The background color of the border pattern.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBorderWidth

double getBorderWidth()
                      throws IOException,
                             AutomationException
The width of the border in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBorderWidth

void setBorderWidth(double widthPts)
                    throws IOException,
                           AutomationException
The width of the border in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getInterval

double getInterval()
                   throws IOException,
                          AutomationException
The interval between border patterns in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setInterval

void setInterval(double intervalPts)
                 throws IOException,
                        AutomationException
The interval between border patterns in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAlternating

boolean isAlternating()
                      throws IOException,
                             AutomationException
Indicates if the border pattern alternates across the width of the border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAlternating

void setAlternating(boolean alternating)
                    throws IOException,
                           AutomationException
Indicates if the border pattern alternates across the width of the border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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