com.esri.arcgis.carto
Interface IInkGraphic

All Superinterfaces:
Serializable
All Known Implementing Classes:
InkGraphic

public interface IInkGraphic
extends Serializable

Provides access to the InkGraphic object.

Remarks

Provides access to the properties and method of InkGraphic. See InkGraphic for more information on this graphic type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void create(Object pDisplay, Object pInk)
          Creates a new element.
 int getColor()
          The current color of the element.
 Object getInk()
          The Ink used by the Graphic Element.
 Object getInkGeometry()
          A copy of the geometry described by the element.
 int getInkType()
          The Ink type of the graphic.
 Object getRenderer()
          The Render used by the Graphic Element.
 Object getTag()
          The user defined property associated with this element.
 int getTipType()
          The current tip type of the element.
 int getWidth()
          The current width of the element.
 String recognize()
          The text produced by the text recognizer for this element.
 void setColor(int pColor)
          The current color of the element.
 void setTag(Object pTag)
          The user defined property associated with this element.
 void setTipType(int pTipType)
          The current tip type of the element.
 void setWidth(int pWidth)
          The current width of the element.
 void updateRecognitionResult(String newResultText)
          Updates the recognition results previously obtained by Recognize.
 

Method Detail

create

void create(Object pDisplay,
            Object pInk)
            throws IOException,
                   AutomationException
Creates a new element.

Product Availability

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

Parameters:
pDisplay - A reference to another Object (IUnknown) (in)
pInk - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInk

Object getInk()
              throws IOException,
                     AutomationException
The Ink used by the Graphic Element.

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderer

Object getRenderer()
                   throws IOException,
                          AutomationException
The Render used by the Graphic Element.

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recognize

String recognize()
                 throws IOException,
                        AutomationException
The text produced by the text recognizer for this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setTag

void setTag(Object pTag)
            throws IOException,
                   AutomationException
The user defined property associated with this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTag

Object getTag()
              throws IOException,
                     AutomationException
The user defined property associated with this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getColor

int getColor()
             throws IOException,
                    AutomationException
The current color of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setColor

void setColor(int pColor)
              throws IOException,
                     AutomationException
The current color of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setWidth

void setWidth(int pWidth)
              throws IOException,
                     AutomationException
The current width of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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 current width of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getInkGeometry

Object getInkGeometry()
                      throws IOException,
                             AutomationException
A copy of the geometry described by the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInkType

int getInkType()
               throws IOException,
                      AutomationException
The Ink type of the graphic.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.ESRITPCPenType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipType

void setTipType(int pTipType)
                throws IOException,
                       AutomationException
The current tip type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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 current tip type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.ESRITPCStylusType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateRecognitionResult

void updateRecognitionResult(String newResultText)
                             throws IOException,
                                    AutomationException
Updates the recognition results previously obtained by Recognize.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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