Method: Clear

Erases current barcode symbol in the TImage, TQRImage, or TQRGzImage control that's specified by the Image property.

Syntax:

function Clear(UseSpaceColor: Boolean = false): Boolean; virtual;

Description:

The method erases the barcode symbol without erasing the background around it from the TImage, TQRImage, or TQRGzImage control that's specified by the Image property.

If the quiet zones are displayed (the ShowQuietZone property is set to true), they are included in the barcode symbol and will be erased too. For the TBarcode2D_Code16K barcode components, the leading quiet zone and trailing quiet zone are included always, even if the ShowQuietZone property is set to false.

Parameters:

• UseSpaceColor: Boolean; Specifies whether the space color that's specified by SpaceColor property is used to erase the barcode symbol. If it's set to false, the current brush color of the TImage, TQRImage, or TQRGzImage control will be used. If the parameter isn't provided, it's default to false.

Return:

• If the method succeeds, the return value is true.

• For the Delphi/C++ Builder 2007 or early, if the length of Barcode property value is invalid, or there is any invalid character in the Barcode property value, the return value is false. Corresponding to the OnInvalidLength event or the OnInvalidChar event will occur.

  For Delphi/C++ Builder 2009 or later, if you use the Barcode property to specify the barcode text, when the length of Barcode property value is invalid, or there is any invalid character in the Barcode property value, the return value is false. Corresponding to the OnInvalidLength event or the OnInvalidChar event will occur. If you use the Data property to specify the barcode text, when the length of Data property value is invalid, or there is any invalid character in the Data property value, the return value is false. Corresponding to the OnInvalidDataLength event or the OnInvalidDataChar event will occur.

  For the TBarcode2D_CCA, TBarcode2D_CCB, and TBarcode2D_CCC components, if the Linear property is set, and the length of its Barcode or Data (only for Delphi/C++ Builder 2009 or later) property value is invalid, the return value is false too, 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 Barcode or Data (only for Delphi/C++ Builder 2009 or later) property value, the return value is false too, corresponding to the OnInvalidChar or OnInvalidDataChar (only for Delphi/C++ Builder 2009 or later) event will occur.

Contents