 |
Aspose.Barcode for Python via Java Generation and Recognition API docs
|
Codetext parameters. More...
Inherits _MwWrapper.
Public Member Functions | |
| None | __init__ (self, _java_class) |
| str | __str__ (self) |
| Returns a string representation of the CodetextParameters instance. More... | |
| TextAlignment | alignment (self) |
| Gets the alignment of the code text. More... | |
| None | alignment (self, TextAlignment value) |
| Sets the alignment of the code text. More... | |
| Tuple[int, int, int] | color (self) |
| Specify the displaying CodeText's Color, representation of an RGB tuple. More... | |
| None | color (self, Tuple[int, int, int] value) |
| Specify the displaying CodeText's Color, representation of an RGB tuple. More... | |
| Optional[FontUnit] | font (self) |
| Specify the displaying CodeText's font. More... | |
| None | font (self, FontUnit value) |
| Specify the displaying CodeText's font. More... | |
| FontMode | font_mode (self) |
| Specify FontMode. More... | |
| None | font_mode (self, FontMode value) |
| Specify FontMode. More... | |
| CodeLocation | location (self) |
| Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More... | |
| None | location (self, CodeLocation value) |
| Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More... | |
| bool | no_wrap (self) |
| Specify word wraps (line breaks) within text. More... | |
| None | no_wrap (self, bool value) |
| Specify word wraps (line breaks) within text. More... | |
| Optional[Unit] | space (self) |
| Space between the CodeText and the BarCode in Unit value. More... | |
| None | space (self, Unit value) |
| Space between the CodeText and the BarCode in Unit value. More... | |
| Optional[str] | two_d_display_text (self) |
| Text that will be displayed instead of codetext in 2D barcodes. More... | |
| None | two_d_display_text (self, str value) |
| Text that will be displayed instead of codetext in 2D barcodes. More... | |
Detailed Description
Codetext parameters.
Constructor & Destructor Documentation
◆ __init__()
| None __init__ | ( | self, | |
| _java_class | |||
| ) |
Member Function Documentation
◆ __str__()
| str __str__ | ( | self | ) |
Returns a string representation of the CodetextParameters instance.
- Returns
- A string that represents this CodetextParameters.
◆ alignment() [1/2]
| TextAlignment alignment | ( | self | ) |
Gets the alignment of the code text.
Default value: TextAlignment.CENTER.
◆ alignment() [2/2]
| None alignment | ( | self, | |
| TextAlignment | value | ||
| ) |
Sets the alignment of the code text.
Default value: TextAlignment.CENTER.
◆ color() [1/2]
| Tuple[int, int, int] color | ( | self | ) |
Specify the displaying CodeText's Color, representation of an RGB tuple.
Default value (0,0,0).
◆ color() [2/2]
| None color | ( | self, | |
| Tuple[int, int, int] | value | ||
| ) |
Specify the displaying CodeText's Color, representation of an RGB tuple.
Default value (0,0,0).
◆ font() [1/2]
| Optional[FontUnit] font | ( | self | ) |
Specify the displaying CodeText's font.
Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.
◆ font() [2/2]
| None font | ( | self, | |
| FontUnit | value | ||
| ) |
Specify the displaying CodeText's font.
Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.
◆ font_mode() [1/2]
| FontMode font_mode | ( | self | ) |
Specify FontMode.
If FontMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontMode.AUTO especially in AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. Default value: FontMode.AUTO.
◆ font_mode() [2/2]
| None font_mode | ( | self, | |
| FontMode | value | ||
| ) |
Specify FontMode.
If FontMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontMode.AUTO especially in AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. Default value: FontMode.AUTO.
◆ location() [1/2]
| CodeLocation location | ( | self | ) |
Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.
Default value: CodeLocation.NONE.
◆ location() [2/2]
| None location | ( | self, | |
| CodeLocation | value | ||
| ) |
Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.
Default value: CodeLocation.NONE.
◆ no_wrap() [1/2]
| bool no_wrap | ( | self | ) |
Specify word wraps (line breaks) within text.
- Returns
- bool
◆ no_wrap() [2/2]
| None no_wrap | ( | self, | |
| bool | value | ||
| ) |
Specify word wraps (line breaks) within text.
◆ space() [1/2]
| Optional[Unit] space | ( | self | ) |
Space between the CodeText and the BarCode in Unit value.
Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
◆ space() [2/2]
| None space | ( | self, | |
| Unit | value | ||
| ) |
Space between the CodeText and the BarCode in Unit value.
Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
◆ two_d_display_text() [1/2]
| Optional[str] two_d_display_text | ( | self | ) |
Text that will be displayed instead of codetext in 2D barcodes.
Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
◆ two_d_display_text() [2/2]
| None two_d_display_text | ( | self, | |
| str | value | ||
| ) |
Text that will be displayed instead of codetext in 2D barcodes.
Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode