Class DecodingOptions

Namespace

ZXing.Common

Assembly

zxing.dll

Defines an container for encoder options

public class DecodingOptions

Inheritance

object

DecodingOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DecodingOptions()

Initializes a new instance of the DecodingOptions class.

public DecodingOptions()

Properties

AllowedEANExtensions

Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this. Maps to an int[] of the allowed extension lengths, for example [2], [5], or [2, 5]. If it is optional to have an extension, do not set this hint. If this is set, and a UPC or EAN barcode is found but an extension is not, then no result will be returned at all.

public int[] AllowedEANExtensions { get; set; }

Property Value

int[]

AllowedLengths

Allowed lengths of encoded data -- reject anything else. Maps to an int[].

public int[] AllowedLengths { get; set; }

Property Value

int[]

AssumeCode39CheckDigit

Assume Code 39 codes employ a check digit. Maps to bool.

public bool AssumeCode39CheckDigit { get; set; }

Property Value

bool

true if it should assume a Code 39 check digit; otherwise, false.

AssumeGS1

Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed. For example this affects FNC1 handling for Code 128 (aka GS1-128).

public bool AssumeGS1 { get; set; }

Property Value

bool

true if it should assume GS1; otherwise, false.

AssumeMSICheckDigit

Assume MSI codes employ a check digit. Maps to bool.

public bool AssumeMSICheckDigit { get; set; }

Property Value

bool

true if it should assume a MSI check digit; otherwise, false.

CharacterSet

Specifies what character encoding to use when decoding, where applicable (type String)

public string CharacterSet { get; set; }

Property Value

string

The character set.

Hints

Gets the data container for all options

[Browsable(false)]
public IDictionary<DecodeHintType, object> Hints { get; }

Property Value

IDictionary<DecodeHintType, object>

PossibleFormats

Image is known to be of one of a few possible formats. Maps to a {@link java.util.List} of {@link BarcodeFormat}s.

public IList<BarcodeFormat> PossibleFormats { get; set; }

Property Value

IList<BarcodeFormat>

The possible formats.

PureBarcode

Image is a pure monochrome image of a barcode.

public bool PureBarcode { get; set; }

Property Value

bool

true if monochrome image of a barcode; otherwise, false.

ReturnCodabarStartEnd

If true, return the start and end digits in a Codabar barcode instead of stripping them. They are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them to not be. Doesn't matter what it maps to; use bool.

public bool ReturnCodabarStartEnd { get; set; }

Property Value

bool

TryHarder

Gets or sets a flag which cause a deeper look into the bitmap

public bool TryHarder { get; set; }

Property Value

bool

true if [try harder]; otherwise, false.

TryInverted

Gets or sets a value indicating whether the image should be automatically inverted if no result is found in the original image. ATTENTION: Please be carefully because it slows down the decoding process if it is used

public bool TryInverted { get; set; }

Property Value

bool

true if image should be inverted; otherwise, false.

UseCode39ExtendedMode

if Code39 could be detected try to use extended mode for full ASCII character set

public bool UseCode39ExtendedMode { get; set; }

Property Value

bool

UseCode39RelaxedExtendedMode

Don't fail if a Code39 is detected but can't be decoded in extended mode. Return the raw Code39 result instead. Maps to bool.

public bool UseCode39RelaxedExtendedMode { get; set; }

Property Value

bool

Events

ValueChanged

event is raised when a value is changed

public event Action<object, EventArgs> ValueChanged

Event Type

Action<object, EventArgs>