Foxit PDF SDK
foxit.common.Barcode Class Reference
Inheritance diagram for foxit.common.Barcode:
foxit.common.Base

Public Types

enum  Format {
  Format.e_FormatCode39 = 0, Format.e_FormatCode128 = 1, Format.e_FormatEAN8 = 2, Format.e_FormatUPCA = 3,
  Format.e_FormatEAN13 = 4, Format.e_FormatITF = 5, Format.e_FormatPDF417 = 6, Format.e_FormatQRCode = 7
}
 Enumeration for barcode format. More...
 
enum  QRErrorCorrectionLevel { QRErrorCorrectionLevel.e_QRCorrectionLevelLow = 0, QRErrorCorrectionLevel.e_QRCorrectionLevelMedium = 1, QRErrorCorrectionLevel.e_QRCorrectionLevelQuater = 2, QRErrorCorrectionLevel.e_QRCorrectionLevelHigh = 3 }
 Enumeration for format error correction level of QR Code. More...
 

Public Member Functions

 Barcode ()
 Constructor.
 
 Barcode (Barcode other)
 Constructor, with another barcode object. More...
 
Bitmap GenerateBitmap (string info, Barcode.Format format, int unit_width, int unit_height, Barcode.QRErrorCorrectionLevel level)
 Generate a barcode bitmap with a given information string and specified barcode format. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 

Detailed Description

This class can be used to generate barcode bitmap.

Member Enumeration Documentation

◆ Format

Enumeration for barcode format.

Values of this enumeration should be used alone.

Enumerator
e_FormatCode39 

Barcode format: standard 39 code.

e_FormatCode128 

Barcode format: Code128, including EAN128 code.

e_FormatEAN8 

Barcode format: EAN-8 code.

e_FormatUPCA 

Barcode format: UPC-A code.

e_FormatEAN13 

Barcode format: EAN-13 code.

e_FormatITF 

Barcode format: ITF code.

e_FormatPDF417 

Barcode format: PDF-417 code.

e_FormatQRCode 

Barcode format: Quick Response Code.

◆ QRErrorCorrectionLevel

Enumeration for format error correction level of QR Code.

Values of this enumeration should be used alone.

Enumerator
e_QRCorrectionLevelLow 

The capability of recovery from 7% amounts of damage.

e_QRCorrectionLevelMedium 

The capability of recovery from 15% amounts of damage.

e_QRCorrectionLevelQuater 

The capability of recovery from 25% amounts of damage.

e_QRCorrectionLevelHigh 

The capability of recovery from 30% amounts of damage.

Constructor & Destructor Documentation

◆ Barcode()

foxit.common.Barcode.Barcode ( Barcode  other)
inline

Constructor, with another barcode object.

Parameters
[in]otherAnother barcode object.

Member Function Documentation

◆ GenerateBitmap()

Bitmap foxit.common.Barcode.GenerateBitmap ( string  info,
Barcode.Format  format,
int  unit_width,
int  unit_height,
Barcode.QRErrorCorrectionLevel  level 
)
inline

Generate a barcode bitmap with a given information string and specified barcode format.

Parameters
[in]infoInformation string to be encoded to barcode bitmap. It should not be an empty string.
[in]formatBarcode format which is used to encode information string. Please refer to values starting from foxit.common.Barcode.Format.e_FormatCode39 and this should be one of these values.
[in]unit_widthUnit width for barcode, in pixels. Valid values: from 1 to 5. If input value is below 1, 1 will be used by default; if input value is above 5, 5 will be used by default.
Specially, for PDF-417 and QR Code, the minimum value of unit_width and unit_height will be used as unit width (compared with valid value range) and unit height will be ignored.
[in]unit_heightUnit height for barcode, in pixels. Valid values: equal to or above 20. If input value is below 20, 20 will be used by default.
Specially, for PDF-417 and QR Code, the minimum value of unit_width and unit_height will be used as unit width (compared with valid value range) and unit height will be ignored.
[in]level(Required only for QR Code) Error correction level. Please refer to values starting from foxit.common.Barcode.QRErrorCorrectionLevel.e_QRCorrectionLevelLow and this should be one of these values.
Returns
A barcode bitmap.

◆ IsEmpty()

bool foxit.common.Barcode.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.