CutToClipboard Method

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Sub CutToClipboard( _
   ByVal fillColor As IImGearRGBQuad _
)

'Usage
 
Dim instance As ImGearRasterPage
Dim fillColor As IImGearRGBQuad
 
instance.CutToClipboard(fillColor)

public void CutToClipboard( 
   IImGearRGBQuad fillColor
)

public: void CutToClipboard( 
   IImGearRGBQuad* fillColor
)

public:
void CutToClipboard( 
   IImGearRGBQuad^ fillColor
)

Parameters

fillColor: The solid fill color, specified in RGB format, used to fill the cut region. If the actual color space of the image is not RGB, the provided color will be automatically converted to corresponding closest pixel value of that color space.

Prior to processing the image, the method checks whether the page has the ROI initialized (rectangular or non-rectangular), and if it exists, cuts the portion of the image, specified by bounding rectangle of the ROI. If the ROI is non-rectangular (ImGearROIMask), will be filled that non-rectangular region only. The non-rectangular ROI image also will be placed into the clipboard using ImageGear's proprietary format, then automatically will be retrieved and attached to the main image upon call of the GetFromClipboard.

Any third party application that supports pasting from the clipboard, will be able to retrieve the copied image. However, if it has the ROI, the mask will not be honored. Instead, the entire rectangular region beneath the bounding box, defined by the mask, will be pasted.

The fillColor cannot be null. If fill color is not necessary, please use CopyToClipboard instead.

Note: The copied pixels will be converted to 1-, 4-, 8-bit Indexed or 24-bit RGB format for copying to the clipboard.

Note: The clipboard API can only be used in threads set to single thread apartment (STA) mode.

Note: The Windows clipboard does not support multiple access at the same time. It means, that attempt to use CutToClipboard or GetFromClipboard simultaneously from multiple threads will lead to impossibility to copy/paste the image to/from the clipboard - the ImGearException will be thrown.

Reference

ImGearRasterPage Class
ImGearRasterPage Members
CopyToClipboard Method
ImGearColorSpace Structure