Aspose.Barcode for Python via Java Generation and Recognition API docs
DotCodeParameters Class Reference

DotCode parameters. More...

Inherits _MwWrapper.

Public Member Functions

None __init__ (self, _java_class)
 
str __str__ (self)
 Returns a human-readable string representation of this DotCodeParameters. More...
 
float aspect_ratio (self)
 Height/Width ratio of 2D BarCode module. More...
 
None aspect_ratio (self, float value)
 Height/Width ratio of 2D BarCode module. More...
 
int columns (self)
 Identifies columns count. More...
 
None columns (self, int value)
 Identifies columns count. More...
 
DotCodeEncodeMode dot_code_encode_mode (self)
 
None dot_code_encode_mode (self, DotCodeEncodeMode value)
 Identifies DotCode encode mode. More...
 
int dot_code_structured_append_mode_barcode_id (self)
 Identifies the ID of the DotCode structured append mode barcode. More...
 
None dot_code_structured_append_mode_barcode_id (self, int value)
 Identifies the ID of the DotCode structured append mode barcode. More...
 
int dot_code_structured_append_mode_barcodes_count (self)
 Identifies DotCode structured append mode barcodes count. More...
 
None dot_code_structured_append_mode_barcodes_count (self, int value)
 Identifies DotCode structured append mode barcodes count. More...
 
ECIEncodings eci_encoding (self)
 Identifies ECI encoding. More...
 
None eci_encoding (self, ECIEncodings value)
 Identifies ECI encoding. More...
 
DotCodeEncodeMode encode_mode (self)
 
None encode_mode (self, DotCodeEncodeMode value)
 
bool reader_initialization (self)
 Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader. More...
 
None reader_initialization (self, bool value)
 Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader. More...
 
int rows (self)
 Identifies rows count. More...
 
None rows (self, int value)
 Identifies rows count. More...
 
int structured_append_mode_barcode_id (self)
 
None structured_append_mode_barcode_id (self, int value)
 
int structured_append_mode_barcodes_count (self)
 
None structured_append_mode_barcodes_count (self, int value)
 

Detailed Description

DotCode parameters.

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  _java_class 
)

Member Function Documentation

◆ __str__()

str __str__ (   self)

Returns a human-readable string representation of this DotCodeParameters.

Returns
A string that represents this DotCodeParameters.

◆ aspect_ratio() [1/2]

float aspect_ratio (   self)

Height/Width ratio of 2D BarCode module.

◆ aspect_ratio() [2/2]

None aspect_ratio (   self,
float  value 
)

Height/Width ratio of 2D BarCode module.

◆ columns() [1/2]

int columns (   self)

Identifies columns count.

Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of columns must be at least 5. Default value: -1

◆ columns() [2/2]

None columns (   self,
int  value 
)

Identifies columns count.

Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of columns must be at least 5. Default value: -1

◆ dot_code_encode_mode() [1/2]

DotCodeEncodeMode dot_code_encode_mode (   self)
    Identifies DotCode encode mode.
    Default value: Auto.

◆ dot_code_encode_mode() [2/2]

None dot_code_encode_mode (   self,
DotCodeEncodeMode  value 
)

Identifies DotCode encode mode.

Default value: Auto.

◆ dot_code_structured_append_mode_barcode_id() [1/2]

int dot_code_structured_append_mode_barcode_id (   self)

Identifies the ID of the DotCode structured append mode barcode.

ID starts from 1 and must be less or equal to barcodes count. Default value is -1.

◆ dot_code_structured_append_mode_barcode_id() [2/2]

None dot_code_structured_append_mode_barcode_id (   self,
int  value 
)

Identifies the ID of the DotCode structured append mode barcode.

ID starts from 1 and must be less or equal to barcodes count. Default value is -1.

◆ dot_code_structured_append_mode_barcodes_count() [1/2]

int dot_code_structured_append_mode_barcodes_count (   self)

Identifies DotCode structured append mode barcodes count.

Default value is -1. Count must be a value from 1 to 35.

◆ dot_code_structured_append_mode_barcodes_count() [2/2]

None dot_code_structured_append_mode_barcodes_count (   self,
int  value 
)

Identifies DotCode structured append mode barcodes count.

Default value is -1. Count must be a value from 1 to 35.

◆ eci_encoding() [1/2]

ECIEncodings eci_encoding (   self)

Identifies ECI encoding.

Used when DotCodeEncodeMode is Auto. Default value: ISO-8859-1

◆ eci_encoding() [2/2]

None eci_encoding (   self,
ECIEncodings  value 
)

Identifies ECI encoding.

Used when DotCodeEncodeMode is Auto. Default value: ISO-8859-1

◆ encode_mode() [1/2]

DotCodeEncodeMode encode_mode (   self)
Identifies DotCode encode mode.
Default value: Auto.

◆ encode_mode() [2/2]

None encode_mode (   self,
DotCodeEncodeMode  value 
)
Identifies DotCode encode mode.
Default value: Auto.

◆ reader_initialization() [1/2]

bool reader_initialization (   self)

Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader.

Default value is false.

◆ reader_initialization() [2/2]

None reader_initialization (   self,
bool  value 
)

Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader.

Default value is false.

◆ rows() [1/2]

int rows (   self)

Identifies rows count.

Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of rows must be at least 5. Default value: -1

◆ rows() [2/2]

None rows (   self,
int  value 
)

Identifies rows count.

Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of rows must be at least 5. Default value: -1

◆ structured_append_mode_barcode_id() [1/2]

int structured_append_mode_barcode_id (   self)
Identifies the ID of the DotCode structured append mode barcode.
ID starts from 1 and must be less or equal to barcodes count.
Default value is -1.

◆ structured_append_mode_barcode_id() [2/2]

None structured_append_mode_barcode_id (   self,
int  value 
)
Identifies the ID of the DotCode structured append mode barcode.
ID starts from 1 and must be less or equal to barcodes count.
Default value is -1.

◆ structured_append_mode_barcodes_count() [1/2]

int structured_append_mode_barcodes_count (   self)
Identifies DotCode structured append mode barcodes count.
Default value is -1. Count must be a value from 1 to 35.

◆ structured_append_mode_barcodes_count() [2/2]

None structured_append_mode_barcodes_count (   self,
int  value 
)
Identifies DotCode structured append mode barcodes count.
Default value is -1. Count must be a value from 1 to 35.