Label Definition Builder

Defined in namespace Scandit.DataCapture.Label.Capture

LabelDefinitionBuilder
class LabelDefinitionBuilder

Added in version 7.5.0

A fluent builder class for creating LabelDefinition objects with a convenient, chainable interface. This builder provides methods to add various field types (barcodes, text fields, dates) and configure their properties in a structured manner.

The LabelDefinitionBuilder enables you to construct complex label definitions by adding multiple field types:

  • Barcode Fields - Serial numbers, part numbers, IMEI codes, custom barcodes

  • Text Fields - Unit prices, total prices, weight information, custom text, date fields (for example, packing dates, expiry dates with configurable formats)

Each field can be configured with validation patterns, optional status, and symbology settings where applicable. The builder pattern ensures type safety and provides a clear, readable way to define label structures.

Note

This builder is the recommended approach for creating label definitions as it provides better type safety and readability compared to manual construction.

AddSerialNumberBarcode()
SerialNumberBarcodeBuilder AddSerialNumberBarcode()

Added in version 7.5.0

Adds a serial number barcode field to the label definition. Returns a builder for configuring the serial number field properties.

AddSerialNumberBarcode()
LabelDefinitionBuilder AddSerialNumberBarcode(SerialNumberBarcode barcode)

Added in version 7.5.0

Adds a pre-configured serial number barcode field to the label definition.

AddPartNumberBarcode()
PartNumberBarcodeBuilder AddPartNumberBarcode()

Added in version 7.5.0

Adds a part number barcode field to the label definition. Returns a builder for configuring the part number field properties.

AddPartNumberBarcode()
LabelDefinitionBuilder AddPartNumberBarcode(PartNumberBarcode barcode)

Added in version 7.5.0

Adds a pre-configured part number barcode field to the label definition.

AddImeiOneBarcode()
ImeiOneBarcodeBuilder AddImeiOneBarcode()

Added in version 7.5.0

Adds an IMEI-1 barcode field to the label definition. Returns a builder for configuring the IMEI-1 field properties.

IMEI-1 barcodes are used for mobile device identification. This field type is specifically optimized for recognizing the first IMEI code format commonly found on device labels.

AddImeiOneBarcode()
LabelDefinitionBuilder AddImeiOneBarcode(ImeiOneBarcode barcode)

Added in version 7.5.0

Adds a pre-configured IMEI-1 barcode field to the label definition.

AddImeiTwoBarcode()
ImeiTwoBarcodeBuilder AddImeiTwoBarcode()

Added in version 7.5.0

Adds an IMEI-2 barcode field to the label definition. Returns a builder for configuring the IMEI-2 field properties.

IMEI-2 barcodes are used for mobile device identification, specifically for the second IMEI code format. This field type is optimized for recognizing the alternative IMEI code format.

AddImeiTwoBarcode()
LabelDefinitionBuilder AddImeiTwoBarcode(ImeiTwoBarcode barcode)

Added in version 7.5.0

Adds a pre-configured IMEI-2 barcode field to the label definition.

AddCustomBarcode()
CustomBarcodeBuilder AddCustomBarcode()

Added in version 7.5.0

Adds a custom barcode field to the label definition. Returns a builder for configuring the custom barcode field properties.

AddCustomBarcode()
LabelDefinitionBuilder AddCustomBarcode(CustomBarcode barcode)

Added in version 7.5.0

Adds a pre-configured custom barcode field to the label definition.

AddUnitPriceText()
UnitPriceTextBuilder AddUnitPriceText()

Added in version 7.5.0

Adds a unit price text field to the label definition. Returns a builder for configuring the unit price field properties.

AddUnitPriceText()
LabelDefinitionBuilder AddUnitPriceText(UnitPriceText text)

Added in version 7.5.0

Adds a pre-configured unit price text field to the label definition.

AddTotalPriceText()
TotalPriceTextBuilder AddTotalPriceText()

Added in version 7.5.0

Adds a total price text field to the label definition. Returns a builder for configuring the total price field properties.

AddTotalPriceText()
LabelDefinitionBuilder AddTotalPriceText(TotalPriceText text)

Added in version 7.5.0

Adds a pre-configured total price text field to the label definition.

AddWeightText()
WeightTextBuilder AddWeightText()

Added in version 7.5.0

Adds a weight text field to the label definition. Returns a builder for configuring the weight field properties.

AddWeightText()
LabelDefinitionBuilder AddWeightText(WeightText text)

Added in version 7.5.0

Adds a pre-configured weight text field to the label definition.

AddPackingDateText()
PackingDateTextBuilder AddPackingDateText()

Added in version 7.5.0

Adds a packing date text field to the label definition. Returns a builder for configuring the packing date field properties.

AddPackingDateText()
LabelDefinitionBuilder AddPackingDateText(PackingDateText text)

Added in version 7.5.0

Adds a pre-configured packing date text field to the label definition.

AddExpiryDateText()
ExpiryDateTextBuilder AddExpiryDateText()

Added in version 7.5.0

Adds an expiry date text field to the label definition. Returns a builder for configuring the expiry date field properties.

AddExpiryDateText()
LabelDefinitionBuilder AddExpiryDateText(ExpiryDateText text)

Added in version 7.5.0

Adds a pre-configured expiry date text field to the label definition.

AddCustomText()
CustomTextBuilder AddCustomText()

Added in version 7.5.0

Adds a custom text field to the label definition. Returns a builder for configuring the custom text field properties.

AddCustomText()
LabelDefinitionBuilder AddCustomText(CustomText text)

Added in version 7.5.0

Adds a pre-configured custom text field to the label definition.

SetHiddenProperty()
LabelDefinitionBuilder SetHiddenProperty(string key, object value)

Added in version 7.5.0

Sets a hidden property to be used when creating the LabelDefinition object.

SetHiddenProperties()
LabelDefinitionBuilder SetHiddenProperties(IDictionary<string, object> hiddenProperties)

Added in version 7.5.0

Sets hidden properties to be used when creating the LabelDefinition object.

Build()
LabelDefinition Build(string name)

Added in version 7.5.0

Builds the LabelDefinition object with the given name.

BuildFluent()
LabelCaptureSettingsBuilder BuildFluent(string name)

Added in version 7.5.0

Builds the LabelDefinition object with the given name and returns a fluent builder for configuring label capture settings.