Skip to main content

BarCodeControl Class

Displays a bar code.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v22.1.dll

Declaration

public class BarCodeControl :
    BaseStyleControl

Remarks

The BarCodeControl supports multiple bar code types. The following images illustrate some of them.

QR Code EAN 8 PDF417
BarCode-QRCode-ex BarCode-EAN8-ex BarCode-PDF417-ex

The bar code type is specified by the BarCodeControl.Symbology property.

  • At design time within Visual Studio, you can set this property using the Properties window.

    BarCode-SymbologyProperty-DT

    After selecting a bar code type, you can expand the Symbology property to access additional customization options.

    BarCode-SymbologyProperty-DT-Expanded

  • To specify the symbology in code, create a specific BarCodeGeneratorBase descendant and assign it to the Symbology property of the BarCodeControl.

    A bar code generator object provides access to additional customization properties specific to the selected bar code type.

Some of the main bar code options are described below.

Tooltips

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers over the control.

Use the following properties to specify a regular tooltip’s content:

  • ToolTip — A regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
  • ToolTipTitle — A regular tooltip’s title. If the title is not specified, it is not displayed.
  • ToolTipIconType — A regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.

    image

    To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.

    To display a custom image in a specific regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.

Use the SuperTip property to assign a super tooltip to a control. Enable the AllowHtmlText property to use HTML tags in the super tooltip.

To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See the following topic for more information: Tooltips.

Example

This example illustrates how to use BarCodeControl to display a QR code.

BarCode-QRCode-ex2

using DevExpress.XtraPrinting.BarCode;
using DevExpress.XtraEditors;

BarCodeControl barCodeControl1 = new BarCodeControl();
barCodeControl1.Parent = this;
barCodeControl1.Size = new System.Drawing.Size(150, 150);
barCodeControl1.AutoModule = true;
barCodeControl1.Text = "1234567890";
QRCodeGenerator symb = new QRCodeGenerator();
barCodeControl1.Symbology = symb;

// Adjust the QR barcode's specific properties.
symb.CompactionMode = QRCodeCompactionMode.AlphaNumeric;
symb.ErrorCorrectionLevel = QRCodeErrorCorrectionLevel.H;
symb.Version = QRCodeVersion.AutoVersion;

Inheritance

See Also