com.esri.arcgis.arcmapui
Interface IClipboardFormat

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BmpClipboardFormat, EnhMetaFileClipboardFormat, IClipboardFormatProxy, LayersClipboardFormat, MetaFileClipboardFormat, TextClipboardFormat

public interface IClipboardFormat
extends java.io.Serializable

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

Description: 'Provides access to members that control the ClipBoard Format.' 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	IID52bb5361_947e_11d2_acff_0000f87808ee
static int	xxDummy Deprecated. Internal use only

Method Summary

void	copy(IMxDocument mxDocument) Copy selection to the Clipboard.
void	getDescription(java.lang.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.

Field Detail

IID52bb5361_947e_11d2_acff_0000f87808ee

static final int IID52bb5361_947e_11d2_acff_0000f87808ee

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

getFormat

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

The Clipboard Format.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

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

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

void getDescription(java.lang.String[] description)
                    throws java.io.IOException,
                           AutomationException

Description of the Clipboard format.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStorageMedium

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

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

void copy(IMxDocument mxDocument)
          throws java.io.IOException,
                 AutomationException

Copy selection to the Clipboard.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

paste

void paste(IMxDocument mxDocument)
           throws java.io.IOException,
                  AutomationException

Paste the Element in the GraphicsContainer to the Clipboard.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.