CVB.Net 15.0
Loading...
Searching...
No Matches
UpcE Class Referencesealed

Configuration class for UPC-E barcodes. More...

Inherits UpcEanBase< T >.

Public Member Functions

UpcE SetExpansionEnabled (bool enable)
 Enables or disables expansion of detected UPC-E codes to the UPC-A format.
 
UpcE SetStripNumberSystemDigitEnabled (bool enable)
 Enables or disables strip number system.
 
UpcE SetRejectMisreadCodeEnabled (bool enable)
 Enable or disable whether damaged UPC-A or EAN-13 barcodes are rejected.
 
UpcE SetUPCE1Enabled (bool enable)
 Enables or disables UPCE1 decoding.
 
- Public Member Functions inherited from UpcEanBase< T >
SetSupplemental (SupplementalCode supplement, bool required=false, bool addSpace=true)
 Configures supplemental code decoding.
 
SupplementalCode GetSupplemental ()
 Retrieves the current configuration of the supplemental code decoding.
 
SetStripCheckDigitEnabled (bool enabled)
 Sets the strip check digit enable.
 
- Public Member Functions inherited from CompositeCodeBase< T >
CompositeCodeBase< T > SetCCAEnabled (bool enable)
 Sets value for IsCCAEnabled.
 
CompositeCodeBase< T > SetCCBEnabled (bool enable)
 Sets value for IsCCBEnabled.
 
CompositeCodeBase< T > SetCCCEnabled (bool enable)
 Sets value for IsCCCEnabled.
 
- Public Member Functions inherited from ConfigBase< T >
SetEnabled (bool enabled)
 Sets value for IsEnabled.
 

Properties

override bool IsCCAEnabled [get, set]
 Enable/disable CCA.
 
override bool IsCCBEnabled [get, set]
 Enable/disable CCB.
 
override bool IsCCCEnabled [get, set]
 Enable/disable CCC.
 
bool IsExpansionEnabled [get, set]
 Gets or sets a value indicating whether expansion is enabled.
 
bool IsStripNumberSystemDigitEnabled [get, set]
 Gets or sets a value indicating whether stip number system is enabled.
 
bool IsRejectMisreadCodeEnabled [get, set]
 Gets or sets a value indicating whether rejection of partial upce codes is enabled.
 
bool IsUPCE1Enabled [get, set]
 Gets or sets a value indicating whether UPCE1 decoding is enabled.
 
- Properties inherited from UpcEanBase< T >
bool IsStripCheckDigitEnabled [get, set]
 Gets or sets a value indicating whether the strip check digit is enabled.
 
bool IsAddSpaceEnabled [get, set]
 Gets or sets a value indicating whether add space is enabled.
 
bool IsSupplementalRequiredEnabled [get, set]
 Gets or sets a value indicating whether a supplemental code is required.
 
SupplementalCode SupplementalCode [get, set]
 Gets or sets the supplemental code.
 
- Properties inherited from CompositeCodeBase< T >
virtual bool IsCCAEnabled [get, set]
 Enable/disable CCA.
 
virtual bool IsCCBEnabled [get, set]
 Enable/disable CCB.
 
virtual bool IsCCCEnabled [get, set]
 Enable/disable CCC.
 
- Properties inherited from ConfigBase
virtual bool IsEnabled [get, set]
 The enabled state of this symbology.
 
Decoder Decoder [get]
 Decoder this config belongs to.
 

Detailed Description

Configuration class for UPC-E barcodes.

For additional details on configuration including a code example, refer to the GetConfig<T>() method in the Decoder class.

Member Function Documentation

◆ SetExpansionEnabled()

UpcE SetExpansionEnabled ( bool enable)

Enables or disables expansion of detected UPC-E codes to the UPC-A format.

Parameters
enableif set to true expansion is enabled.
Returns

◆ SetRejectMisreadCodeEnabled()

UpcE SetRejectMisreadCodeEnabled ( bool enable)

Enable or disable whether damaged UPC-A or EAN-13 barcodes are rejected.

Parameters
enableif set to true reject upce partial.
Returns

◆ SetStripNumberSystemDigitEnabled()

UpcE SetStripNumberSystemDigitEnabled ( bool enable)

Enables or disables strip number system.

Parameters
enableif set to true [enable strip number system].
Returns

◆ SetUPCE1Enabled()

UpcE SetUPCE1Enabled ( bool enable)

Enables or disables UPCE1 decoding.

Parameters
enableif set to true UPCE1 decoding is enabled.
Returns

Property Documentation

◆ IsCCAEnabled

override bool IsCCAEnabled
getset

Enable/disable CCA.

◆ IsCCBEnabled

override bool IsCCBEnabled
getset

Enable/disable CCB.

◆ IsCCCEnabled

override bool IsCCCEnabled
getset

Enable/disable CCC.

◆ IsExpansionEnabled

bool IsExpansionEnabled
getset

Gets or sets a value indicating whether expansion is enabled.

true if expansion is enabled; otherwise, false.

◆ IsRejectMisreadCodeEnabled

bool IsRejectMisreadCodeEnabled
getset

Gets or sets a value indicating whether rejection of partial upce codes is enabled.

true if reject upce partial is enabled; otherwise, false.

◆ IsStripNumberSystemDigitEnabled

bool IsStripNumberSystemDigitEnabled
getset

Gets or sets a value indicating whether stip number system is enabled.

true if strip number system is enabled; otherwise, false.

◆ IsUPCE1Enabled

bool IsUPCE1Enabled
getset

Gets or sets a value indicating whether UPCE1 decoding is enabled.

true if UPCE1 decoding is enabled; otherwise, false.