Method: CopyToClipboard - Syntax 1

Copies a barcode symbol to the system clipboard. The barcode symbol is specified in the properties of this barcode component.

Syntax:

function CopyToClipboard(Module: Integer = 0; Height: Integer = 0; Angle: Integer = -1): Integer; overload; virtual;

Description:

Copies current barcode symbol that is specified in the properties of this barcode component to the system clipboard.

Parameters:

• Module: Integer; Specifies the module width in logical dots or pixels in the horizontal direction, it is the width of the smallest bar (or space) in the barcode symbol. If the parameter isn't provided or it is set to zero, the value of "Module" property will be used.

  See also the "Module" property.

• Height: Integer; Specifies the distance between the top and bottom of a barcode symbol in modules. If the human readable text is displayed, the height of the human readable text and its vertical spacing (TextVSpacing) are included.

  If the parameter isn't provided or its value is set to zero, the value of Height property will be used.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the height of the top and bottom bearer bars (BearerWidth) are included too.

  If the human readable text is displayed, and it exceeds the barcode symbol in vertical direction, the excess isn't included.

  See also the "Height" property.

  Note: If the parameter is less than zero, its absolute value specifies the height in pixels in the vertical direction.

• Angle: Integer; Specifies an angle in degrees to rotate the barcode symbol. It defaults to -1 if the Angle is not provided, and the barcode symbol will be rotated base on the value of the Orientation property:

  • boLeftRight: 0 degrees
  • boRightLeft: 180 degrees
  • boTopBottom: 270 degrees
  • boBottomTop: 90 degrees

  If you want to use the -1 degrees, the 359 degrees can be used instead.

Return:

• If the method succeeds, the return value is zero.
• If the length of the barcode text that is specified by Barcode or Data (only for Delphi/C++ Builder 2009 or later) property is invalid, the return value is -1. Corresponding to the OnInvalidLength or OnInvalidDataLength (only for Delphi/C++ Builder 2009 or later) event will occur.
• If there is any invalid character in the the barcode text that is specified by Barcode or Data (only for Delphi/C++ Builder 2009 or later) property, the return value is the position index of first invalid character, the index 1 denotes that the first character is invalid character. Corresponding to the OnInvalidChar or OnInvalidDataChar (only for Delphi/C++ Builder 2009 or later) event will occur. For the TBarcode1D_OneCode component, if the invalid character in the Tracking property, the index is from 1 to 20 including 1 and 20; if it is in the Routing property, the value starts with 21 (First character of the Routing property).

See diagram:

Note:

For Delphi 3, the method overload and default value of parameter aren't supported, so the method name is changed to CopyToClipboard1, and the parameters Module, Height, Angle are required.

Contents