TXBarcodeCore Class — TX Text Control .NET for Windows Forms

Description

The TXBarcodeCore class provides properties and methods to specify type and format of barcodes provided as a Scalable Vector Graphics (SVG). The class implements the System.ComponentModel.INotifyPropertyChanged interface. Before an instance of the TXBarcodeCore class can be used, it must be initialized by calling the Create method. Changes to the barcode that require updating the view can be listend via the ViewChanged event. The following describes only the properties defined through the TXBarcodeCore class. For a list of properties, methods and events inherited from the System.ComponentModel.INotifyPropertyChanged interface see the .NET Framework reference.

Syntax

public class TXBarcodeCore : INotifyPropertyChanged

Public Class TXBarcodeCore
    Implements INotifyPropertyChanged

Examples

The following example creates a TXBarcode Core instance and configures its additional text setting for a document workflow.

TXTextControl.Barcode.TXBarcodeCore tXBarcodeCore = new();
tXBarcodeCore.AdditionalText = "Quarterly results";

Dim tXBarcodeCore As New TXTextControl.Barcode.TXBarcodeCore()
tXBarcodeCore.AdditionalText = "Quarterly results"

Members

Constructors

Constructor	Description
TXBarcodeCore	Initializes a new instance of the TXBarcodeCore class.

Properties

Property	Description
AdditionalText	Gets or sets an additional text that is displayed below or above the barcode image.
Alignment	Gets or sets the alignment of the barcode image inside the control. The default value is TXTextControl.Barcode.Alignment.MiddleCenter.
Angle	Gets or sets the angle of the barcode image inside the control. The default value is 0.
BackColor	Gets or sets the background color for the barcode control. The default color is System.Drawing.SystemColors.Window.
BarcodeType	Gets or sets the type of barcode that is rendered.
BarcodeTypeSettings	Gets an object of type BarcodeTypeSettings to determine type specific settings for the current used barcode.
ForeColor	Gets or sets the foreground color for the barcode. The default color is System.Drawing.SystemColors.WindowText.
ShowText	Gets or sets a value indicating whether the encrypted barcode text value is displayed below or above the barcode image or not. The default value is true.
Size	Gets or sets the size of the barcode.
Text	Gets or sets the text the barcode should encrypt.
TextAlignment	Gets or sets a value indicating whether the barcode text and additional text is displayed below or above the barcode image. The default value is Bottom.
UpperTextLength	Gets or sets the maximum number of characters the Text property can get.

Methods

Method	Description
Create	Initializes the resources of a newly instantiated TXBarcodeCore object. This method must be called before using the object.
GetDefaultText	Returns the default text for the specified barcode type.
GetMaximumTextLength	Returns the maximum text length of the specified barcode type.
GetMinimumTextLength	Returns the minimum text length of the specified barcode type.
GetSVG	Creates and returns a string representing a Scalable Vector Graphics (SVG) of the barcode.
IsTextValid	Returns a value indicating whether the specified text is valid for a specific barcode type. In case of an invalid text, an exception message is saved into the specified string.
Load	Loads barcode data into the control.
Save	Saves the barcode data.

Events

Event	Description
PropertyChanged	Not described in the reference. `public event PropertyChangedEventHandler PropertyChanged;`
ViewChanged	Occurs when changes to the barcode settings require updating the barcode view.