com.esri.arcgis.carto
Interface IIndexGridTabStyle

All Superinterfaces:
Serializable
All Known Implementing Classes:
BackgroundTabStyle, ButtonTabStyle, ContinuousTabStyle, RoundedTabStyle

public interface IIndexGridTabStyle
extends Serializable

Provides access to members that control the way an index grid's labels are drawn.

Remarks

The IIndexGridTabStyle interface provides access to the color and thickness of the index gridís labels. The PrepareDraw method should be called before IGridLabel::Draw is called on index grid tab style labels. A description and examples are provided in the Carto Library Overview.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IColor getForegroundColor()
          The foreground color of the tab.
 IColor getOutlineColor()
          The outline color of the tab.
 double getThickness()
          The thickness of the tab in points.
 void prepareDraw(String labelValue, double tabWidthPage, int axis)
          Sets up the tab for drawing.
 void setForegroundColor(IColor color)
          The foreground color of the tab.
 void setOutlineColor(IColor color)
          The outline color of the tab.
 void setThickness(double thicknessPts)
          The thickness of the tab in points.
 

Method Detail

getForegroundColor

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

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 tab.

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.

getOutlineColor

IColor getOutlineColor()
                       throws IOException,
                              AutomationException
The outline color of the tab.

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.

setOutlineColor

void setOutlineColor(IColor color)
                     throws IOException,
                            AutomationException
The outline color of the tab.

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.

getThickness

double getThickness()
                    throws IOException,
                           AutomationException
The thickness of the tab in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setThickness

void setThickness(double thicknessPts)
                  throws IOException,
                         AutomationException
The thickness of the tab in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

prepareDraw

void prepareDraw(String labelValue,
                 double tabWidthPage,
                 int axis)
                 throws IOException,
                        AutomationException
Sets up the tab for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
labelValue - The labelValue (in)
tabWidthPage - The tabWidthPage (in)
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.