com.esri.arcgis.arcmapui
Interface IReportUnitFormat2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IReportUnitFormat2Proxy, MxDocument

public interface IReportUnitFormat2
extends java.io.Serializable

COM Interface 'IReportUnitFormat2'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides access to report unit formatting.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID5fc55a42_b276_4e9c_9dce_c54f61419dfe
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID5fc55a42_b276_4e9c_9dce_c54f61419dfe

static final int IID5fc55a42_b276_4e9c_9dce_c54f61419dfe

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getLatLonFormat

ILatLonFormat getLatLonFormat()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLatLonFormatByRef

void setLatLonFormatByRef(ILatLonFormat format)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumericFormat

INumberFormat getNumericFormat()
                               throws java.io.IOException,
                                      AutomationException

The number format used to report coordinate values.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumericFormatByRef

void setNumericFormatByRef(INumberFormat format)
                           throws java.io.IOException,
                                  AutomationException

The number format used to report coordinate values.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutLatLonFormat

ILatLonFormat getCoordinateReadoutLatLonFormat()
                                               throws java.io.IOException,
                                                      AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutLatLonFormatByRef

void setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)
                                           throws java.io.IOException,
                                                  AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutUnits

int getCoordinateReadoutUnits()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutUnits

void setCoordinateReadoutUnits(int units)
                               throws java.io.IOException,
                                      AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.