FieldMergeBarcode Class
Implements the MERGEBARCODE field.
Inheritance Hierarchy
SystemObject
  Aspose.Words.FieldsField
    Aspose.Words.FieldsFieldMergeBarcode

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 19.11
Syntax
public class FieldMergeBarcode : Field

The FieldMergeBarcode type exposes the following members.

Constructors
  NameDescription
Public methodFieldMergeBarcode
Initializes a new instance of the FieldMergeBarcode class
Properties
  NameDescription
Public propertyCode exampleAddStartStopChar
Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
Public propertyCode exampleBackgroundColor
Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
Public propertyCode exampleBarcodeType
Gets or sets the barcode type (QR, etc.)
Public propertyCode exampleBarcodeValue
Gets or sets the barcode value.
Public propertyCode exampleCaseCodeStyle
Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
Public propertyCode exampleDisplayResult
Gets the text that represents the displayed field result.
(Inherited from Field.)
Public propertyCode exampleDisplayText
Gets or sets whether to display barcode data (text) along with image.
Public propertyCode exampleEnd
Gets the node that represents the field end.
(Inherited from Field.)
Public propertyCode exampleErrorCorrectionLevel
Gets or sets an error correction level of QR Code. Valid values are [0, 3].
Public propertyCode exampleFixCheckDigit
Gets or sets whether to fix the check digit if it’s invalid.
Public propertyCode exampleForegroundColor
Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
Public propertyCode exampleFormat
Gets a FieldFormat object that provides typed access to field's formatting.
(Inherited from Field.)
Public propertyCode exampleIsDirty
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field.)
Public propertyCode exampleIsLocked
Gets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field.)
Public propertyCode exampleLocaleId
Gets or sets the LCID of the field.
(Inherited from Field.)
Public propertyCode examplePosCodeStyle
Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
Public propertyCode exampleResult
Gets or sets text that is between the field separator and field end.
(Inherited from Field.)
Public propertyCode exampleScalingFactor
Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]
Public propertyCode exampleSeparator
Gets the node that represents the field separator. Can be null.
(Inherited from Field.)
Public propertyCode exampleStart
Gets the node that represents the start of the field.
(Inherited from Field.)
Public propertyCode exampleSymbolHeight
Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch).
Public propertyCode exampleSymbolRotation
Gets or sets the rotation of the barcode symbol. Valid values are [0, 3]
Public propertyCode exampleType
Gets the Microsoft Word field type.
(Inherited from Field.)
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodCode exampleGetFieldCode
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
(Inherited from Field.)
Public methodCode exampleGetFieldCode(Boolean)
Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNeedStoreOldResultNodes (Inherited from Field.)
Public methodCode exampleRemove
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
(Inherited from Field.)
Public methodToString (Inherited from Object.)
Public methodCode exampleUnlink
Performs the field unlink.
(Inherited from Field.)
Public methodCode exampleUpdate
Performs the field update. Throws if the field is being updated already.
(Inherited from Field.)
Public methodCode exampleUpdate(Boolean)
Performs a field update. Throws if the field is being updated already.
(Inherited from Field.)
Remarks
Mail merge a barcode.
Examples
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void FieldMergeBarcode_QR()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Insert a QR code
    FieldMergeBarcode field = (FieldMergeBarcode) builder.InsertField(FieldType.FieldMergeBarcode, true);
    field.BarcodeType = "QR";

    // In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
    // However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
    field.BarcodeValue = "MyQRCode";
    field.BackgroundColor = "0xF8BD69";
    field.ForegroundColor = "0xB5413B";
    field.ErrorCorrectionLevel = "3";
    field.ScalingFactor = "250";
    field.SymbolHeight = "1000";
    field.SymbolRotation = "0";

    Assert.AreEqual(" MERGEBARCODE  MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0",
        field.GetFieldCode());
    builder.Writeln();

    // Create a data source for our mail merge
    // This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
    // as well as BarcodeValue attributes of DISPLAYBARCODE fields
    DataTable table = CreateTable("Barcodes", new[] { "MyQRCode" },
        new[,] { { "ABC123" }, { "DEF456" } });

    // During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
    // with values from the data table rows deposited into corresponding BarcodeValue attributes
    doc.MailMerge.Execute(table);

    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[0].Type);
    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[1].Type);

    Assert.AreEqual("DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B",
        doc.Range.Fields[0].GetFieldCode());
    Assert.AreEqual("DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B",
        doc.Range.Fields[1].GetFieldCode());

    doc.Save(ArtifactsDir + "Field.MergeBarcode_QR.docx");
}

public void FieldMergeBarcode_EAN13()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Insert a EAN13 barcode
    FieldMergeBarcode field = (FieldMergeBarcode) builder.InsertField(FieldType.FieldMergeBarcode, true);
    field.BarcodeType = "EAN13";
    field.BarcodeValue = "MyEAN13Barcode";
    field.DisplayText = true;
    field.PosCodeStyle = "CASE";
    field.FixCheckDigit = true;

    Assert.AreEqual(" MERGEBARCODE  MyEAN13Barcode EAN13 \\t \\p CASE \\x", field.GetFieldCode());
    builder.Writeln();

    DataTable table = CreateTable("Barcodes", new[] { "MyEAN13Barcode" },
        new[,] { { "501234567890" }, { "123456789012" } });

    doc.MailMerge.Execute(table);

    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[0].Type);
    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[1].Type);

    Assert.AreEqual("DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x",
        doc.Range.Fields[0].GetFieldCode());
    Assert.AreEqual("DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x",
        doc.Range.Fields[1].GetFieldCode());

    doc.Save(ArtifactsDir + "Field.MergeBarcode_EAN13.docx");
}

public void FieldMergeBarcode_CODE39()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Insert a CODE39 barcode
    FieldMergeBarcode field = (FieldMergeBarcode) builder.InsertField(FieldType.FieldMergeBarcode, true);
    field.BarcodeType = "CODE39";
    field.BarcodeValue = "MyCODE39Barcode";
    field.AddStartStopChar = true;

    Assert.AreEqual(" MERGEBARCODE  MyCODE39Barcode CODE39 \\d", field.GetFieldCode());
    builder.Writeln();

    DataTable table = CreateTable("Barcodes", new[] { "MyCODE39Barcode" },
        new[,] { { "12345ABCDE" }, { "67890FGHIJ" } });

    doc.MailMerge.Execute(table);

    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[0].Type);
    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[1].Type);

    Assert.AreEqual("DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d",
        doc.Range.Fields[0].GetFieldCode());
    Assert.AreEqual("DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d",
        doc.Range.Fields[1].GetFieldCode());

    doc.Save(ArtifactsDir + "Field.MergeBarcode_CODE39.docx");
}

public void FieldMergeBarcode_ITF14()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Insert a ITF14 barcode
    FieldMergeBarcode field = (FieldMergeBarcode) builder.InsertField(FieldType.FieldMergeBarcode, true);
    field.BarcodeType = "ITF14";
    field.BarcodeValue = "MyITF14Barcode";
    field.CaseCodeStyle = "STD";

    Assert.AreEqual(" MERGEBARCODE  MyITF14Barcode ITF14 \\c STD", field.GetFieldCode());

    DataTable table = CreateTable("Barcodes", new[] { "MyITF14Barcode" },
        new[,] { { "09312345678907" }, { "1234567891234" } });

    doc.MailMerge.Execute(table);

    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[0].Type);
    Assert.AreEqual(FieldType.FieldDisplayBarcode, doc.Range.Fields[1].Type);

    Assert.AreEqual("DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD",
        doc.Range.Fields[0].GetFieldCode());
    Assert.AreEqual("DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD",
        doc.Range.Fields[1].GetFieldCode());

    doc.Save(ArtifactsDir + "Field.MergeBarcode_ITF14.docx");
}

/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
public DataTable CreateTable(string dataTableName, string[] columnNames, object[,] dataSet)
{
    if (dataTableName != string.Empty || columnNames.Length != 0)
    {
        DataTable table = new DataTable(dataTableName);

        foreach (string columnName in columnNames)
        {
            table.Columns.Add(columnName);
        }

        foreach (object data in dataSet)
        {
            table.Rows.Add(data);
        }

        return table;
    }

    throw new ArgumentException("DataTable name and Column name must be declared.");
}
See Also