TXBarcodeControl Class
- Namespace
TXTextControl.WPF. Barcode
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WPF. SDK
- Assembly
TXBarcode.WPF. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WPF. SDK TXBarcode.from the setup.WPF. dll
- Inherits
- Framework
Element - TXBarcode
Control
- Framework
Description
The TXBarcodeControl class provides properties to define type and format of the barcode it displays in WPF. It can be added to a document with the WPF.TextControl.Barcodes property. The WPF.TXBarcodeControl class is inherited from the System.Windows.FrameworkElement class. The following describes only the properties, methods and events defined through the WPF.TXBarcodeControl class. For a list of properties, methods and events inherited from the System.Windows.FrameworkElement class see the .NET Framework reference.
Syntax
public class TXBarcodeControl : FrameworkElementPublic Class TXBarcodeControl
Inherits FrameworkElementExamples
The following example creates a TXBarcode Control instance and configures its additional text setting for a document workflow.
TXTextControl.WPF.Barcode.TXBarcodeControl tXBarcodeControl = new();
tXBarcodeControl.AdditionalText = "Quarterly results";Dim tXBarcodeControl As New TXTextControl.WPF.Barcode.TXBarcodeControl()
tXBarcodeControl.AdditionalText = "Quarterly results"Members
Constructors
| Constructor | Description |
|---|---|
| TXBarcodeControl | Initializes a new instance of the TXBarcodeControl 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 value is null and represents the color SystemColors.WindowColor. |
| BarcodeType | Gets or sets the type of barcode that should be displayed. This is a dependency property. |
| 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 value is null and represents the color SystemColors.WindowTextColor. |
| ShowText | Gets or sets a value indicating whether the barcode text is displayed below or above the barcode image or not. The default value is true. |
| Text | Gets or sets the text the barcode should encrypt. This is a dependency property. |
| 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 have. This is a dependency property. |
Methods
| Method | Description |
|---|---|
| GetDefaultText | Returns the default text for the specified barcode type. |
| GetMaximumTextLength | Returns the maximum text length the specified barcode type can have. |
| GetMinimumTextLength | Returns the minimum text length the specified barcode type can have. |
| GetSVG | Not described in the reference. public string GetSVG(Size size); |
| IsTextValid | Returns a value whether the specified text is valid for a specific barcode type. In case of invalid text an appropriate exception message is saved into the specified string. |
| Load | Loads barcode data into the control. |
| PrintPaint | Draws the barcode on a specific object of type System.Drawing.Graphics or System.Windows.Media.DrawingContext with specified bounds or stretch factor. |
| Save | Saves the barcode data. |
| SaveImage | Saves the barcode image. |