com.esri.arcgis.arcmapui
Interface IClipboardFormat

All Superinterfaces:

Serializable

All Known Implementing Classes:

BmpClipboardFormat, EnhMetaFileClipboardFormat, IClipboardFormatProxy, LayersClipboardFormat, MetaFileClipboardFormat, TextClipboardFormat

public interface IClipboardFormat
extends Serializable

Provides access to members that control the ClipBoard Format.

Superseded By

IClipboardFormat2

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	copy(IMxDocument mxDocument) Copy selection to the Clipboard.
void	getDescription(String[] description) Description of the Clipboard format.
void	getFormat(int[] format) The Clipboard Format.
void	getPriority(short[] priority) Priority of the Clipboard format for Paste (1 to 100, 100 highest priority).
void	getStorageMedium(int[] tymed) StorageMedium for Paste.
void	paste(IMxDocument mxDocument) Paste the Element in the GraphicsContainer to the Clipboard.

Method Detail

getFormat

void getFormat(int[] format)
               throws IOException,
                      AutomationException

The Clipboard Format.

Product Availability

Available with ArcGIS Desktop.

Parameters:

format - The format (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

void getPriority(short[] priority)
                 throws IOException,
                        AutomationException

Priority of the Clipboard format for Paste (1 to 100, 100 highest priority).

Product Availability

Available with ArcGIS Desktop.

Parameters:

priority - The priority (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

void getDescription(String[] description)
                    throws IOException,
                           AutomationException

Description of the Clipboard format.

Product Availability

Available with ArcGIS Desktop.

Parameters:

description - The description (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageMedium

void getStorageMedium(int[] tymed)
                      throws IOException,
                             AutomationException

StorageMedium for Paste. (Look up the C++ TYMED enumeration on MSDN for details).

Product Availability

Available with ArcGIS Desktop.

Parameters:

tymed - The tymed (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

void copy(IMxDocument mxDocument)
          throws IOException,
                 AutomationException

Copy selection to the Clipboard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

void paste(IMxDocument mxDocument)
           throws IOException,
                  AutomationException

Paste the Element in the GraphicsContainer to the Clipboard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.