Barcodes

TX Text Control supports the insertion of barcode controls of the type TXTextControl.Barcode.TXBarcodeControl. A barcode can be positioned like an image or 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 which 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 from a TextControl or ServerTextControl through the Barcodes property. The TextControl.BarcodeLayoutDialog method opens a dialog box which offers layout settings like positioning, size and text distances. A barcode can be saved with the TX Text Control and the RTF format and is reconstructed during a loading process. With other formats the barcode image is saved. If a document with barcodes is loaded on a system where no barcode controls are installed, the barcode's image is inserted.

Classes

Class Description
TXTextControl.DataVisualization.BarcodeCollection An instance of the BarcodeCollection class contains all barcodes in a document represented through objects of the type DataVisualization.BarcodeFrame.
TXTextControl.DataVisualization.BarcodeEventArgs The BarcodeEventArgs class provides data for all events that occur with barcodes.
TXTextControl.DataVisualization.BarcodeFrame An instance of the BarcodeFrame class represents a barcode and its layout in a Text Control document.

Constructors

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

Events

Event Description
TXTextControl.ServerTextControl.BarcodeCreated Occurs when a new barcode has been created.
TXTextControl.ServerTextControl.BarcodeDeleted Occurs when a barcode has been deleted.

Methods

Method Description
TXTextControl.ServerTextControl.OnBarcodeCreated Raises the BarcodeCreated event.
TXTextControl.ServerTextControl.OnBarcodeDeleted Raises the BarcodeDeleted event.
TXTextControl.DataVisualization.BarcodeCollection.Add Inserts a new barcode in a Text Control document.
TXTextControl.DataVisualization.BarcodeCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.DataVisualization.BarcodeCollection.GetItem Gets a particular barcode from the collection.
TXTextControl.DataVisualization.BarcodeCollection.Remove Removes a barcode from a Text Control document.
TXTextControl.DataVisualization.BarcodeFrame.AddUndoUnit Adds the current state of the barcode which is connected with this BarcodeFrame to the undo stack.
TXTextControl.DataVisualization.BarcodeFrame.Refresh Refreshes the barcode.

Properties

Property Description
TXTextControl.ServerTextControl.Barcodes Gets a collection of all barcodes in a document.
TXTextControl.DataVisualization.BarcodeEventArgs.BarcodeFrame Gets an object that represents the barcode which causes the event.
TXTextControl.DataVisualization.BarcodeFrame.Barcode Gets the barcode control associated with the barcode frame.
TXTextControl.DataVisualization.BarcodeFrame.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.
TXTextControl.DataVisualization.BarcodeFrame.ExportFileName Gets or sets the file name, when the barcode's image is exported.
TXTextControl.DataVisualization.BarcodeFrame.ExportFilterIndex Gets or sets the format used, if a barcode's image is exported.
TXTextControl.DataVisualization.BarcodeFrame.ExportResolution Gets or sets the maximum resolution in dots per inch in which the barcode's image is saved.
TXTextControl.DataVisualization.BarcodeFrame.SaveMode Determines whether the barcode's image is stored through its binary data or through a file reference.