com.esri.arcgis.controls
Interface IEngineInkGenericDrawTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

ControlsInkGenericDrawTool

public interface IEngineInkGenericDrawTool
extends Serializable

Provides access to the ink properties of the ControlsInkGenericDrawTool.

Description

The IEngineInkGenericDrawTool interface controls the properties of the ControlsInkGenericDrawTool.

Product Availability

Available with ArcGIS Engine.

Method Summary

int	getColor() The color used to render the element created by this tool.
int	getTipType() The pen tip type used to render the element created by this tool.
int	getTransparency() The transparency used to render the element created by this tool.
int	getWidth() The width (in mm) used to render the element created by this tool.
void	setColor(int pColor) The color used to render the element created by this tool.
void	setTipType(int pTipType) The pen tip type used to render the element created by this tool.
void	setTransparency(int pTrans) The transparency used to render the element created by this tool.
void	setWidth(int pWidth) The width (in mm) used to render the element created by this tool.

Method Detail

setColor

void setColor(int pColor)
              throws IOException,
                     AutomationException

The color used to render the element created by this tool.

Product Availability

Available with ArcGIS Engine.

Parameters:

pColor - The pColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

int getColor()
             throws IOException,
                    AutomationException

The color used to render the element created by this tool.

Description

The ink Color used by the ControlsInkGenericDrawTool. Internally the Color is stored as a long integer where the value may be calculated for any RGB combination as follows: RGB = (Red) + (Green * 256) + (Blue * 256 * 256). Where Red, Green and Blue are Long Integers within the range 0 - 255.

By default Color is black and corresponds to RGB (0, 0, 0).

Product Availability

Available with ArcGIS Engine.

Returns:

The pColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pWidth)
              throws IOException,
                     AutomationException

The width (in mm) used to render the element created by this tool.

Product Availability

Available with ArcGIS Engine.

Parameters:

pWidth - The pWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width (in mm) used to render the element created by this tool.

Description

The ink Width used by the ControlsInkGenericDrawTool, specified in HIMETRIC units (1 HIMETRIC = 0.01 mm). By default Width is 10.

Product Availability

Available with ArcGIS Engine.

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

void setTransparency(int pTrans)
                     throws IOException,
                            AutomationException

The transparency used to render the element created by this tool.

Product Availability

Available with ArcGIS Engine.

Parameters:

pTrans - The pTrans (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

int getTransparency()
                    throws IOException,
                           AutomationException

The transparency used to render the element created by this tool.

Description

The Transparency used by the ControlsInkGenericDrawTool. Transparency is the degree to which the Color is opaque. 0 for opaque and 255 for transparent. By default Transparency is 0.

Product Availability

Available with ArcGIS Engine.

Returns:

The pTrans

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipType

void setTipType(int pTipType)
                throws IOException,
                       AutomationException

The pen tip type used to render the element created by this tool.

Product Availability

Available with ArcGIS Engine.

Parameters:

pTipType - A com.esri.arcgis.carto.ESRITPCStylusType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipType

int getTipType()
               throws IOException,
                      AutomationException

The pen tip type used to render the element created by this tool.

Description

The ink TipType used by the ControlsInkGenericDrawTool. By default TipType is ETPC_Ball.

Product Availability

Available with ArcGIS Engine.

Returns:

A com.esri.arcgis.carto.ESRITPCStylusType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.