com.esri.arcgis.location
Interface IHatchDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

HatchLineDefinition, HatchMarkerDefinition

public interface IHatchDefinition
extends Serializable

Provides access to hatch definition properties.

Remarks

The IHatchDefinition interface provides access to hatch definition properties. Each hatch definition's name includes the multiple of the hatch interval. No two definitions within the same class can have the same multiple of the hatch interval.

Product Availability

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

Method Summary

int	getAlignment() The hatch alignment.
int	getDisplayPrecision() The display precision.
String	getExpression() The Expression.
int	getExpressionParserEngine() The Expression Parser Engine.
ISymbol	getHatchSymbol() The hatch symbol.
double	getOffset() The offset.
String	getPrefix() The prefix.
String	getSuffix() The suffix.
int	getTextDisplay() Text display setting for the style.
ITextSymbol	getTextSymbol() The text symbol.
boolean	isAdjustTextOrientation() Indicates whether to adjust text orientation.
boolean	isExpressionSimple() Indicates whether the expression is simple.
boolean	isShowSign() Indicates whether to show negative sign in hatch text for negative M values.
void	setAdjustTextOrientation(boolean pAdjustTextOrientation) Indicates whether to adjust text orientation.
void	setAlignment(int pAlignment) The hatch alignment.
void	setDisplayPrecision(int pDisplayPrecision) The display precision.
void	setExpression(String expression) The Expression.
void	setExpressionParserEngine(int parserEngine) The Expression Parser Engine.
void	setExpressionSimple(boolean expressionSimple) Indicates whether the expression is simple.
void	setHatchSymbolByRef(ISymbol ppSymbol) The hatch symbol.
void	setOffset(double pAngle) The offset.
void	setPrefix(String pPrefix) The prefix.
void	setShowSign(boolean pShowSign) Indicates whether to show negative sign in hatch text for negative M values.
void	setSuffix(String pSuffix) The suffix.
void	setTextDisplay(int display) Text display setting for the style.
void	setTextSymbolByRef(ITextSymbol ppSymbol) The text symbol.

Method Detail

getHatchSymbol

ISymbol getHatchSymbol()
                       throws IOException,
                              AutomationException

The hatch symbol.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchSymbolByRef

void setHatchSymbolByRef(ISymbol ppSymbol)
                         throws IOException,
                                AutomationException

The hatch symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

The offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double pAngle)
               throws IOException,
                      AutomationException

The offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAngle - The pAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextDisplay

void setTextDisplay(int display)
                    throws IOException,
                           AutomationException

Text display setting for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

display - A com.esri.arcgis.location.esriHatchTextDisplay constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextDisplay

int getTextDisplay()
                   throws IOException,
                          AutomationException

Text display setting for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.location.esriHatchTextDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol ppSymbol)
                        throws IOException,
                               AutomationException

The text symbol.

Product Availability

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

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayPrecision

int getDisplayPrecision()
                        throws IOException,
                               AutomationException

The display precision.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pDisplayPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayPrecision

void setDisplayPrecision(int pDisplayPrecision)
                         throws IOException,
                                AutomationException

The display precision.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDisplayPrecision - The pDisplayPrecision (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSign

void setShowSign(boolean pShowSign)
                 throws IOException,
                        AutomationException

Indicates whether to show negative sign in hatch text for negative M values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pShowSign - The pShowSign (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSign

boolean isShowSign()
                   throws IOException,
                          AutomationException

Indicates whether to show negative sign in hatch text for negative M values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pShowSign

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrefix

String getPrefix()
                 throws IOException,
                        AutomationException

The prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrefix

void setPrefix(String pPrefix)
               throws IOException,
                      AutomationException

The prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pPrefix - The pPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuffix

String getSuffix()
                 throws IOException,
                        AutomationException

The suffix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pSuffix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuffix

void setSuffix(String pSuffix)
               throws IOException,
                      AutomationException

The suffix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pSuffix - The pSuffix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

String getExpression()
                     throws IOException,
                            AutomationException

The Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

void setExpression(String expression)
                   throws IOException,
                          AutomationException

The Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionSimple

void setExpressionSimple(boolean expressionSimple)
                         throws IOException,
                                AutomationException

Indicates whether the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

expressionSimple - The expressionSimple (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException

Indicates whether the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The expressionSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionParserEngine

int getExpressionParserEngine()
                              throws IOException,
                                     AutomationException

The Expression Parser Engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.location.esriHatchExpressionEngine constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserEngine

void setExpressionParserEngine(int parserEngine)
                               throws IOException,
                                      AutomationException

The Expression Parser Engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

parserEngine - A com.esri.arcgis.location.esriHatchExpressionEngine constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdjustTextOrientation

void setAdjustTextOrientation(boolean pAdjustTextOrientation)
                              throws IOException,
                                     AutomationException

Indicates whether to adjust text orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAdjustTextOrientation - The pAdjustTextOrientation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAdjustTextOrientation

boolean isAdjustTextOrientation()
                                throws IOException,
                                       AutomationException

Indicates whether to adjust text orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pAdjustTextOrientation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignment

int getAlignment()
                 throws IOException,
                        AutomationException

The hatch alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.location.esriHatchAlignmentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignment

void setAlignment(int pAlignment)
                  throws IOException,
                         AutomationException

The hatch alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAlignment - A com.esri.arcgis.location.esriHatchAlignmentType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.