FormatSpecification Object Parameters

Content Organization Control

Parameter Name	Description
`FormatSpecification.Name`	The name of the FormatSpecification object.

Name

The name of the FormatSpecification object.

Remarks
It must be a unique name.

JSON Definition

Parent Object	Key Name	Key Value Type	Default Value
FormatSpecification	Name	string	It must be a mandatory setting value.

JSON Example

{
    "Name":"FormatSpecification1"
}

Format Control

Parameter Name	Description
`FormatSpecification.AllModuleDeviation`	Sets the module size deviation from the standard barcode module size.
`FormatSpecification.AustralianPostEncodingTable`	Sets the encoding table used to code the Customer Information Field of Australian Post Customer Barcode.
`FormatSpecification.BarcodeAngleRangeArray`	Sets the range of angles (in degrees) for barcodes search.
`FormatSpecification.BarcodeBytesLengthRangeArray`	Sets the range of barcode bytes length for barcodes search.
`FormatSpecification.BarcodeBytesRegExPattern`	Specifies the regular express pattern of barcode byte characters.
`FormatSpecification.BarcodeFormatIds`	Sets which barcode format the current FormatSpecification configuration is applied to.
`FormatSpecification.BarcodeFormatIds_2`	Sets which barcode format in BarcodeFormat group 2 the current FormatSpecification configuration is applied to.
`FormatSpecification.BarcodeHeightRangeArray`	Sets the range of barcode heights (in pixels) to for barcodes search.
`FormatSpecification.BarcodeTextLengthRangeArray`	Sets the range of barcode text length for barcodes search.
`FormatSpecification.BarcodeTextRegExPattern`	Specifies the regular express pattern of barcode characters.
`FormatSpecification.BarcodeWidthRangeArray`	Sets the range of barcode widths (in pixels) for barcodes search.(Hint).
`FormatSpecification.BarcodeZoneBarCountRangeArray`	Sets the range of bar count of the barcode zone for barcodes search.
`FormatSpecification.BarcodeZoneMinDistanceToImageBorders`	Sets the minimum distance (in pixels) between barcode zone and image borders.
`FormatSpecification.Code128Subset`	Sets the code 128 subset.
`FormatSpecification.EnableDataMatrixECC000-140`	Specifies whether to decode DataMatrix ECC000-140 barcodes.
`FormatSpecification.EnableQRCodeModel1`	Specifies whether to decode QRCode model 1 barcodes.
`FormatSpecification.FindUnevenModuleBarcode`	Specifies whether to find barcodes with uneven barcode modules. Not support yet.
`FormatSpecification.HeadModuleRatio`	Sets the module count and module size ratio of the barcode head part.
`FormatSpecification.MinQuietZoneWidth`	The minimum width of the barcode quiet zone.
`FormatSpecification.MinRatioOfBarcodeZoneWidthToHeight`	Sets the minimum ratio (width/height) of the barcode zone.
`FormatSpecification.MirrorMode`	Sets whether to decode mirrored barcodes.
`FormatSpecification.ModuleSizeRangeArray`	Sets the range of module size (in pixels) for barcodes search. (Hint).
`FormatSpecification.MSICodeCheckDigitCalculation`	Sets the scheme used for calculating a check digit of an MSI barcode.
`FormatSpecification.PartitionModes`	Sets the mode used to apply partition process.
`FormatSpecification.PatchCodeSearchingMargins`	Sets the margins for searching PatchCode.
`FormatSpecification.RequireStartStopChars`	Sets whether the start and stop characters are required when searching for common 1D barcodes.
`FormatSpecification.StandardFormat`	Sets the standard barcode format.
`FormatSpecification.TailModuleRatio`	Sets the module count and module size ratio of the barcode tail part.
`FormatSpecification.VerifyCheckDigit`	Sets the value determining whether to verify the check digit in barcodes where this check digit is optional.

Image Process Control

Parameter Name	Description
`FormatSpecification.DeblurLevel`	Sets the degree of blurriness of the barcode for the current specified barcode format.
`FormatSpecification.DeformationResistingModes`	Sets the mode and priority for deformation resisting for the current specified barcode format. Not support yet.
`FormatSpecification.BarcodeComplementModes`	Sets the mode and priority to complement the missing parts in the barcode for current specified barcode format. Not support yet.

Result Control

Parameter Name	Description
`FormatSpecification.MinResultConfidence`	The minimum confidence of the result.
`FormatSpecification.ReturnPartialBarcodeValue`	Sets whether or not to return partial barcode value(s). Not support yet.