com.esri.arcgis.system
Interface IDirectionFormat

All Superinterfaces:

Serializable

All Known Implementing Classes:

DirectionFormat

public interface IDirectionFormat
extends Serializable

Provides access to members that format directions.

Product Availability

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

Method Summary

int	getDecimalPlaces() The number of decimal digits in a seconds part of the formatted number.
int	getDirectionType() Indicates the direction of the argument in ValueToString.
int	getDirectionUnits() Indicates Direction Unit for the ValueToString argument.
int	getDisplayFormat() Indicates how to display the direction value.
void	setDecimalPlaces(int num) The number of decimal digits in a seconds part of the formatted number.
void	setDirectionType(int direction) Indicates the direction of the argument in ValueToString.
void	setDirectionUnits(int unit) Indicates Direction Unit for the ValueToString argument.
void	setDisplayFormat(int directionFormat) Indicates how to display the direction value.

Method Detail

setDirectionUnits

void setDirectionUnits(int unit)
                       throws IOException,
                              AutomationException

Indicates Direction Unit for the ValueToString argument.

Product Availability

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

Parameters:

unit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionUnits

int getDirectionUnits()
                      throws IOException,
                             AutomationException

Indicates Direction Unit for the ValueToString argument.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriDirectionUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionType

void setDirectionType(int direction)
                      throws IOException,
                             AutomationException

Indicates the direction of the argument in ValueToString.

Product Availability

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

Parameters:

direction - A com.esri.arcgis.system.esriDirectionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionType

int getDirectionType()
                     throws IOException,
                            AutomationException

Indicates the direction of the argument in ValueToString.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriDirectionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayFormat

void setDisplayFormat(int directionFormat)
                      throws IOException,
                             AutomationException

Indicates how to display the direction value.

Product Availability

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

Parameters:

directionFormat - A com.esri.arcgis.system.esriDirectionFormatEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayFormat

int getDisplayFormat()
                     throws IOException,
                            AutomationException

Indicates how to display the direction value.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriDirectionFormatEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDecimalPlaces

void setDecimalPlaces(int num)
                      throws IOException,
                             AutomationException

The number of decimal digits in a seconds part of the formatted number.

Product Availability

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

Parameters:

num - The num (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDecimalPlaces

int getDecimalPlaces()
                     throws IOException,
                            AutomationException

The number of decimal digits in a seconds part of the formatted number.

Product Availability

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

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.