Add Method
- Namespace
TXTextControl.DataVisualization
- Package
TXTextControl.asTextControl. WinForms. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Inserts a new barcode in a Text Control document.
Syntax
Add(BarcodeFrame, int)
Inserts a barcode inline, which means that it is treated in the text like a single character.
public bool Add(BarcodeFrame barcodeFrame, int textPosition);Public Function Add(barcodeFrame As BarcodeFrame, 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, int, 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.
public bool Add(BarcodeFrame barcodeFrame, HorizontalAlignment alignment, int textPosition, FrameInsertionMode insertionMode);Public Function Add(barcodeFrame As BarcodeFrame, alignment As HorizontalAlignment, textPosition As Integer, 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:
| ||||||||||||
| 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:
|
Add(BarcodeFrame, Point, int, 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.
public bool Add(BarcodeFrame barcodeFrame, Point location, int textPosition, FrameInsertionMode insertionMode);Public Function Add(barcodeFrame As BarcodeFrame, location As Point, textPosition As Integer, 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:
|
Add(BarcodeFrame, int, 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.
public bool Add(BarcodeFrame barcodeFrame, int pageNumber, Point location, FrameInsertionMode insertionMode);Public Function Add(barcodeFrame As BarcodeFrame, pageNumber As Integer, location As Point, insertionMode As FrameInsertionMode) As Boolean| Parameter | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| barcodeFrame | Specifies the barcode and its frame to add. | ||||||||||||
| pageNumber | 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:
|
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.
public bool Add(BarcodeFrame barcodeFrame, Point location, FrameInsertionMode insertionMode);Public Function Add(barcodeFrame As BarcodeFrame, location As Point, 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:
|
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.
public bool Add(BarcodeFrame barcodeFrame, FrameInsertionMode insertionMode);Public Function Add(barcodeFrame As BarcodeFrame, 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:
|
Return Value
The return value is true, if the barcode could be added. Otherwise, it is false.
Examples
The following example adds an item to the barcode collection.
if (!barcodeCollection.Add(new TXTextControl.DataVisualization.BarcodeFrame("Approved"), -1))
{
throw new InvalidOperationException("The item could not be inserted.");
}If Not barcodeCollection.Add(New TXTextControl.DataVisualization.BarcodeFrame("Approved"), -1) Then
Throw New InvalidOperationException("The item could not be inserted.")
End If