com.esri.arcgis.location
Interface IHatchClass

All Superinterfaces:

Serializable

All Known Implementing Classes:

HatchClass

public interface IHatchClass
extends Serializable

Provides access to hatch class properties.

Remarks

The IHatchClass interface provides access to hatch class properties. Each hatch class has a hatch template. In order to create a HatchClass, you will need to assign a template to it.

Product Availability

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

Method Summary

void	convertToGraphics(IFeatureLayer pFLayer, IGraphicsLayer pGraphicsLayer, IDisplay pDisplay, int convertType) Convert to graphics.
void	draw(IFeatureLayer pFLayer, IDisplay pDisplay, ITrackCancel pTrackCancel) Draw.
IHatchInputValue	getEndRange() The EndRange.
IQueryFilter	getFilter() Query definition hatch class is defined by.
IHatchInputValue	getHatchInterval() Hatch Interval for the class.
IHatchTemplate	getHatchTemplate() HatchTemplate for hatch class.
IHatchInputValue	getLateralOffset() The LateralOffset.
double	getMaximumScale() Maximum scale at which the hatch class will display.
double	getMinimumScale() Minimum scale at which the hatch class will display.
IHatchInputValue	getStartRange() The StartRange.
boolean	isShowHatches() Indicates whether to show hatches.
void	setEndRangeByRef(IHatchInputValue ppEndRange) The EndRange.
void	setFilterByRef(IQueryFilter ppQF) Query definition hatch class is defined by.
void	setHatchIntervalByRef(IHatchInputValue ppHatchInterval) Hatch Interval for the class.
void	setHatchTemplateByRef(IHatchTemplate ppHatchTemplate) HatchTemplate for hatch class.
void	setLateralOffsetByRef(IHatchInputValue ppLateralOffset) The LateralOffset.
void	setMaximumScale(double maxScale) Maximum scale at which the hatch class will display.
void	setMinimumScale(double minScale) Minimum scale at which the hatch class will display.
void	setShowHatches(boolean pshowHatches) Indicates whether to show hatches.
void	setStartRangeByRef(IHatchInputValue ppStartRange) The StartRange.

Method Detail

setShowHatches

void setShowHatches(boolean pshowHatches)
                    throws IOException,
                           AutomationException

Indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pshowHatches - The pshowHatches (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowHatches

boolean isShowHatches()
                      throws IOException,
                             AutomationException

Indicates whether to show hatches.

Remarks

The ShowHatches property (type as boolean) indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pshowHatches

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchTemplate

IHatchTemplate getHatchTemplate()
                                throws IOException,
                                       AutomationException

HatchTemplate for hatch class.

Remarks

The HatchTemplate property will need to be associated to a HatchClass.

Example:

IHatchClass pHatchClass1 = new HatchClass();

pHatchClass1.setHatchTemplateByRef(pHatchTemplate);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IHatchTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchTemplateByRef

void setHatchTemplateByRef(IHatchTemplate ppHatchTemplate)
                           throws IOException,
                                  AutomationException

HatchTemplate for hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppHatchTemplate - A reference to a com.esri.arcgis.location.IHatchTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchInterval

IHatchInputValue getHatchInterval()
                                  throws IOException,
                                         AutomationException

Hatch Interval for the class.

Remarks

The HatchInterval property controls interval between successive hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IHatchInputValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchIntervalByRef

void setHatchIntervalByRef(IHatchInputValue ppHatchInterval)
                           throws IOException,
                                  AutomationException

Hatch Interval for the class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppHatchInterval - A reference to a com.esri.arcgis.location.IHatchInputValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

IQueryFilter getFilter()
                       throws IOException,
                              AutomationException

Query definition hatch class is defined by.

Remarks

The Filter property defines the query definition for a hatch class.

Example:

IQueryFilter pQFilt = new QueryFilter();

pQFilt.setWhereClause( "[OBJECTID] = 4 OR [OBJECTID] = 6");

pHatchClass1.setFilterByRef(pQFilt);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterByRef

void setFilterByRef(IQueryFilter ppQF)
                    throws IOException,
                           AutomationException

Query definition hatch class is defined by.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The minScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

Minimum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

minScale - The minScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale at which the hatch class will display.

Remarks

The MaximumScale property defines the maximum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The maxScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

Maximum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

maxScale - The maxScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartRange

IHatchInputValue getStartRange()
                               throws IOException,
                                      AutomationException

The StartRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IHatchInputValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartRangeByRef

void setStartRangeByRef(IHatchInputValue ppStartRange)
                        throws IOException,
                               AutomationException

The StartRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppStartRange - A reference to a com.esri.arcgis.location.IHatchInputValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndRange

IHatchInputValue getEndRange()
                             throws IOException,
                                    AutomationException

The EndRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IHatchInputValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndRangeByRef

void setEndRangeByRef(IHatchInputValue ppEndRange)
                      throws IOException,
                             AutomationException

The EndRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppEndRange - A reference to a com.esri.arcgis.location.IHatchInputValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLateralOffset

IHatchInputValue getLateralOffset()
                                  throws IOException,
                                         AutomationException

The LateralOffset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IHatchInputValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLateralOffsetByRef

void setLateralOffsetByRef(IHatchInputValue ppLateralOffset)
                           throws IOException,
                                  AutomationException

The LateralOffset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppLateralOffset - A reference to a com.esri.arcgis.location.IHatchInputValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IFeatureLayer pFLayer,
          IDisplay pDisplay,
          ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException

Draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToGraphics

void convertToGraphics(IFeatureLayer pFLayer,
                       IGraphicsLayer pGraphicsLayer,
                       IDisplay pDisplay,
                       int convertType)
                       throws IOException,
                              AutomationException

Convert to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

convertType - A com.esri.arcgis.location.esriConvertHatchesToGraphicsType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.