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.

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 be false.

Return:

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

• If the Image property is not set, the return value is false.

  If the length of Barcode or Data (only for Delphi/C++ Builder 2009 or later) property value is invalid, the return value is false, 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, corresponding to the OnInvalidChar or OnInvalidDataChar (only for Delphi/C++ Builder 2009 or later) event will occur.

Note:

For Delphi 3, the default value of parameters isn't supported, so the UseSpaceColor parameter is required.

Contents