com.esri.arcgis.arcmapui
Interface IMxApplication

All Superinterfaces:

Serializable

All Known Implementing Classes:

Application, IMxApplicationProxy

public interface IMxApplication
extends Serializable

Provides access to members that control the Mx Application.

Superseded By

IMxApplication2

Remarks

Obtain a reference to IMxApplication through any object that supports IApplication. In ArcMap, IMxApplication is implemented by the Application CoClass.

When To Use

Use this interface to access the AppDisplay object, the selection environment, and the default printer page settings. In addition, methods on this interface allow you to export the current document and copy the current view to the clipboard.

Product Availability

Available with ArcGIS Desktop.

See Also:

IPaper, IApplication, com.esri.arcgis.mx.Application, com.esri.arcgis.arcmapUI.IAppDisplay

Method Summary

void	copyToClipboard() Copies the current view to the clipboard.
void	export() Exports the current document.
IAppDisplay	getDisplay() The application display.
IPaper	getPaper() The current paper settings.
IPrinter	getPrinter() The current printer settings.
ISelectionEnvironment	getSelectionEnvironment() The selection environment.
void	setPrinterByRef(IPrinter printer) The current printer settings.

Method Detail

setPrinterByRef

void setPrinterByRef(IPrinter printer)
                     throws IOException,
                            AutomationException

The current printer settings.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinter

IPrinter getPrinter()
                    throws IOException,
                           AutomationException

The current printer settings.

Remarks

This property returns an IPrinter interface. The IPrinter interface is the core component for printing a document, its members control the current printer settings and create printing jobs.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.output.IPrinter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IPrinter

getPaper

IPaper getPaper()
                throws IOException,
                       AutomationException

The current paper settings.

Remarks

The IPaper interface and the IPrint interface are the main components for printing. The IPaper interface controls the current paper settings. The IPrint interface has a Paper member which must be set for the print output to be correct.

The IPaper interface is persisted in the document when 'Same As Printer' is checked on in the Page Setup dialog.

In Microsoft Windows terms, the IPaper interface is a wrapper around the GDI DEVMODE and DEVNAME structures.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.output.IPaper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IPaper

getDisplay

IAppDisplay getDisplay()
                       throws IOException,
                              AutomationException

The application display.

Remarks

This method returns a reference to the IAppDisplay interface. The AppDisplay CoClass implements IAppDisplay and it is the main display object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.IAppDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.arcmapUI.IAppDisplay

getSelectionEnvironment

ISelectionEnvironment getSelectionEnvironment()
                                              throws IOException,
                                                     AutomationException

The selection environment.

Remarks

This property returns a reference to the ISelectionEnvironment interface. The selection environment is made up of a number of properties including area search distance, selection method, combination method, and the color in which to draw the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.carto.ISelectionEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISelectionEnvironment

export

void export()
            throws IOException,
                   AutomationException

Exports the current document.

Remarks

Calling this method launches the Export dialog. Supported export formats for the document are: EMF, EPS, PDF, AI, SVG, BMP, JPEG, PNG, GIF, and TIFF.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyToClipboard

void copyToClipboard()
                     throws IOException,
                            AutomationException

Copies the current view to the clipboard.

Remarks

This method copies the ArcMap document to the system clipboard so that it can be copied into other applications. For example, after copying a document to the clipboard, you can paste it into a Word document. The type of object pasted is ESRI ArcMap Document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.