com.esri.arcgis.arcmapui
Interface IReportUnitFormat2

All Superinterfaces:

Serializable

All Known Implementing Classes:

IReportUnitFormat2Proxy, MxDocument

public interface IReportUnitFormat2
extends Serializable

Provides access to report unit formatting.

Product Availability

Available with ArcGIS Desktop.

Method Summary

ILatLonFormat	getCoordinateReadoutLatLonFormat() The format used for the coordinate readout on the status bar.
int	getCoordinateReadoutUnits() The units used for the coordinate readout on the status bar.
ILatLonFormat	getLatLonFormat() When a map's display units are set to esriDecimalDegrees, tools use this format to report coordinates.
INumberFormat	getNumericFormat() The number format used to report coordinate values.
void	setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format) The format used for the coordinate readout on the status bar.
void	setCoordinateReadoutUnits(int units) The units used for the coordinate readout on the status bar.
void	setLatLonFormatByRef(ILatLonFormat format) When a map's display units are set to esriDecimalDegrees, tools use this format to report coordinates.
void	setNumericFormatByRef(INumberFormat format) The number format used to report coordinate values.

Method Detail

getLatLonFormat

ILatLonFormat getLatLonFormat()
                              throws IOException,
                                     AutomationException

When a map's display units are set to esriDecimalDegrees, tools use this format to report coordinates.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.ILatLonFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLatLonFormatByRef

void setLatLonFormatByRef(ILatLonFormat format)
                          throws IOException,
                                 AutomationException

When a map's display units are set to esriDecimalDegrees, tools use this format to report coordinates.

Product Availability

Available with ArcGIS Desktop.

Parameters:

format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumericFormat

INumberFormat getNumericFormat()
                               throws IOException,
                                      AutomationException

The number format used to report coordinate values.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumericFormatByRef

void setNumericFormatByRef(INumberFormat format)
                           throws IOException,
                                  AutomationException

The number format used to report coordinate values.

Product Availability

Available with ArcGIS Desktop.

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutLatLonFormat

ILatLonFormat getCoordinateReadoutLatLonFormat()
                                               throws IOException,
                                                      AutomationException

The format used for the coordinate readout on the status bar.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.ILatLonFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutLatLonFormatByRef

void setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)
                                           throws IOException,
                                                  AutomationException

The format used for the coordinate readout on the status bar.

Product Availability

Available with ArcGIS Desktop.

Parameters:

format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutUnits

int getCoordinateReadoutUnits()
                              throws IOException,
                                     AutomationException

The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Product Availability

Available with ArcGIS Desktop.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutUnits

void setCoordinateReadoutUnits(int units)
                               throws IOException,
                                      AutomationException

The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Product Availability

Available with ArcGIS Desktop.

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.