TXTextControl.DataVisualization.BarcodeCollection.Add Method

Inserts a new barcode in a Text Control document.

Add(BarcodeFrame, Int32)

Inserts a barcode inline, which means that it is treated in the text like a single character.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, int textPosition);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal textPosition As Integer) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

textPosition

Specifies the text position at which the barcode is to be inserted. If -1 is specified, the barcode is inserted at the current input position.

Add(BarcodeFrame, HorizontalAlignment, Int32, FrameInsertionMode)

Inserts a barcode, which is anchored to the specified text position. It has the specified horizontal alignment relative to the paragraph into which it is inserted and the textflow is given through the insertionMode parameter. An anchored barcode is moved with the text.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, HorizontalAlignment alignment, int textPosition, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal alignment As HorizontalAlignment, ByVal textPosition As Integer, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

alignment

Specifies the barcode's horizontal alignment. It can be one of the HorizontalAlignment values:


Value Meaning
Left The barcode is left aligned, relative to the paragraph to which it is anchored.
Right The barcode is right aligned, relative to the paragraph to which it is anchored.
Centered The barcode is centered, relative to the paragraph to which it is anchored.
Justify This value is not supported for barcodes.
textPosition

Specifies the text position at which the barcode is to be inserted. If -1 is specified, the barcode is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the FrameInsertionMode enumeration:


Value Meaning
AboveTheText The barcode is inserted at a certain geometrical location above the text. This means that the barcode overwrites the text.
BelowTheText The barcode is inserted at a certain geometrical location below the text. This means that the text overwrites the barcode.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the barcode.
DisplaceText The text flows around the barcode and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the BarcodeCollection.Add method.

Add(BarcodeFrame, Point, Int32, FrameInsertionMode)

Inserts a barcode, which is anchored to the specified text position. The specified location is relative to the paragraph into which it is inserted and the textflow is given through the insertionMode parameter. An anchored barcode is moved with the text.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, System.Drawing.Point location, int textPosition, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal location As System.Drawing.Point, ByVal textPosition As Integer, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

location

Specifies the location, in twips, at which the barcode is to be inserted.

textPosition

Specifies the text position at which the barcode is to be inserted. If -1 is specified, the barcode is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the FrameInsertionMode enumeration:


Value Meaning
AboveTheText The barcode is inserted at a certain geometrical location above the text. This means that the barcode overwrites the text.
BelowTheText The barcode is inserted at a certain geometrical location below the text. This means that the text overwrites the barcode.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the barcode.
DisplaceText The text flows around the barcode and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the BarcodeCollection.Add method.

Add(BarcodeFrame, Int32, Point, FrameInsertionMode)

Inserts a barcode, which has a fixed geometrical position in the document. This position is specified through a page number and a location on this page and the textflow is given through the insertionMode parameter.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, int page, System.Drawing.Point location, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal page As Integer, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

page

Specifies the number of a page beginning with 1 where the barcode is located.

location

Specifies the location, in twips, at which the barcode is to be inserted.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the FrameInsertionMode enumeration:


Value Meaning
AboveTheText The barcode is inserted at a certain geometrical location above the text. This means that the barcode overwrites the text.
BelowTheText The barcode is inserted at a certain geometrical location below the text. This means that the text overwrites the barcode.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the barcode.
DisplaceText The text flows around the barcode and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the BarcodeCollection.Add method.

Add(BarcodeFrame, Point, FrameInsertionMode)

Inserts a barcode, which has a fixed geometrical position in the document. This position is specified relative to the complete document and the textflow is given through the insertionMode parameter.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, System.Drawing.Point location, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

location

Specifies the location, in twips, at which the barcode is to be inserted.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the FrameInsertionMode enumeration:


Value Meaning
AboveTheText The barcode is inserted at a certain geometrical location above the text. This means that the barcode overwrites the text.
BelowTheText The barcode is inserted at a certain geometrical location below the text. This means that the text overwrites the barcode.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the barcode.
DisplaceText The text flows around the barcode and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the BarcodeCollection.Add method.

Add(BarcodeFrame, FrameInsertionMode)

Inserts a barcode with the built-in mouse interface. The barcode's size is determined through the end-user. A cross cursor indicates where the barcode can be inserted. Changing the document or pressing the ESC key aborts the insertion process.

[C#]
public bool Add(DataVisualization.BarcodeFrame barcodeFrame, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal barcodeFrame As DataVisualization.BarcodeFrame, ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
barcodeFrame

Specifies the barcode and its frame to add.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the FrameInsertionMode enumeration:


Value Meaning
AboveTheText The barcode is inserted at a certain geometrical location above the text. This means that the barcode overwrites the text.
BelowTheText The barcode is inserted at a certain geometrical location below the text. This means that the text overwrites the barcode.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the barcode.
DisplaceText The text flows around the barcode and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the BarcodeCollection.Add method.

Return Value

The return value is true, if the barcode could be added. Otherwise, it is false.

See Also