TXTextControl.DataVisualization.BarcodeFrame Class

An instance of the BarcodeFrame class represents a barcode and its layout in a Text Control document. A barcode can be positioned in the document like an image or a textframe, either geometrically or as a single character. Geometrically its position can either be relative to a paragraph to which it is anchored or relative to the complete document. The BarcodeFrame class handles the positioning of the barcode in the document. A barcode frame is always associated with a barcode control of the type TXTextControl.Barcode.TXBarcodeControl or TXTextControl.WPF.Barcode.TXBarcodeControl. This barcode control handles the appearance and the data of the barcode. All barcodes in a document are contained in a BarcodeCollection. The collection can also be used to add barcodes to or to remove barcodes from the document. The barcode collection can be obtained through the TextControl.Barcodes, WPF.TextControl.Barcodes or ServerTextControl.Barcodes property.

public class BarcodeFrame : FrameBase

Public Class BarcodeFrame
  Inherits FrameBase

Introduced: X9.

Constructors

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

Methods

Method	Description
AddUndoUnit	Adds the current state of the barcode which is connected with this BarcodeFrame to the undo stack.
ChangeZOrder	Changes the frame's z-order. (Inherited from FrameBase)
Refresh	Refreshes the barcode.

Properties

Property	Description
Alignment	Gets or sets the frame's horizontal alignment when it is anchored to a paragraph. (Inherited from FrameBase)
Barcode	Gets the barcode control associated with the barcode frame.
Bounds	Gets the frame's bounding rectangle relative to the upper left corner of the document. (Inherited from FrameBase)
ExportCompressionQuality	Sets a value between 1 and 100, which is the quality of a lossy data compression used, if the barcode's image is exported.
ExportFileName	Gets or sets the file name, when the barcode's image is exported.
ExportFilterIndex	Gets or sets the format used, if a barcode's image is exported.
ExportResolution	Gets or sets the maximum resolution in dots per inch in which the barcode's image is saved.
ID	Gets or sets an identifier for the frame. (Inherited from FrameBase)
InsertionMode	Gets or sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. (Inherited from FrameBase)
Location	Gets or sets, in twips, the frame's current location. (Inherited from FrameBase)
Moveable	Determines whether a frame can be moved in the document at run time with the built-in mouse interface. (Inherited from FrameBase)
Name	Gets or sets a name for the frame. (Inherited from FrameBase)
SaveMode	Determines whether the barcode's image is stored through its binary data or through a file reference.
Size	Gets or sets the frame's size in twips. (Inherited from FrameBase)
Sizeable	Determines whether the frame can be resized at run time with the built-in mouse interface. (Inherited from FrameBase)
TextDistances	Gets or sets the distances, in twips, between the frame and the document's text. (Inherited from FrameBase)
TextPosition	Read only. (Inherited from FrameBase)

BarcodeFrame Class

TXTextControl.DataVisualization Namespace​

Syntax

Constructors

Methods

Properties

TXTextControl.DataVisualization Namespace