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

Codetext parameters. More...

Inherits BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
def init (self)
 
def getTwoDDisplayText (self)
 Text that will be displayed instead of codetext in 2D barcodes. More...
 
def setTwoDDisplayText (self, value)
 Text that will be displayed instead of codetext in 2D barcodes. More...
 
def getFontMode (self)
 Specify FontMode. More...
 
def setFontMode (self, value)
 Specify FontMode. More...
 
def getFont (self)
 Specify the displaying CodeText's font. More...
 
def setFont (self, value)
 Specify the displaying CodeText's font. More...
 
def getSpace (self)
 Space between the CodeText and the BarCode in Unit value. More...
 
def setSpace (self, value)
 Space between the CodeText and the BarCode in Unit value. More...
 
def getAlignment (self)
 Gets the alignment of the code text. More...
 
def setAlignment (self, value)
 Sets the alignment of the code text. More...
 
def getColor (self)
 Specify the displaying CodeText's Color, representation of an RGB tuple. More...
 
def setColor (self, value)
 Specify the displaying CodeText's Color, representation of an RGB tuple. More...
 
def getLocation (self)
 Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More...
 
def setLocation (self, value)
 Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More...
 
def getNoWrap (self)
 Specify word wraps (line breaks) within text. More...
 
def setNoWrap (self, value)
 Specify word wraps (line breaks) within text. More...
 
def toString (self)
 Returns a human-readable string representation of this CodetextParameters. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Public Attributes

 font
 
 space
 
- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Codetext parameters.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ getAlignment()

def getAlignment (   self)

Gets the alignment of the code text.

Default value: TextAlignment.CENTER.

◆ getColor()

def getColor (   self)

Specify the displaying CodeText's Color, representation of an RGB tuple.

Default value (0,0,0).

◆ getFont()

def getFont (   self)

Specify the displaying CodeText's font.

Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.

◆ getFontMode()

def getFontMode (   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.

◆ getLocation()

def getLocation (   self)

Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.

Default value: CodeLocation.NONE.

◆ getNoWrap()

def getNoWrap (   self)

Specify word wraps (line breaks) within text.

Returns
bool

◆ getSpace()

def getSpace (   self)

Space between the CodeText and the BarCode in Unit value.

Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

◆ getTwoDDisplayText()

def getTwoDDisplayText (   self)

Text that will be displayed instead of codetext in 2D barcodes.

Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ init()

def init (   self)

Reimplemented from BaseJavaClass.

◆ setAlignment()

def setAlignment (   self,
  value 
)

Sets the alignment of the code text.

Default value: TextAlignment.CENTER.

◆ setColor()

def setColor (   self,
  value 
)

Specify the displaying CodeText's Color, representation of an RGB tuple.

Default value (0,0,0).

◆ setFont()

def setFont (   self,
  value 
)

Specify the displaying CodeText's font.

Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.

◆ setFontMode()

def setFontMode (   self,
  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.

◆ setLocation()

def setLocation (   self,
  value 
)

Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.

Default value: CodeLocation.NONE.

◆ setNoWrap()

def setNoWrap (   self,
  value 
)

Specify word wraps (line breaks) within text.

◆ setSpace()

def setSpace (   self,
  value 
)

Space between the CodeText and the BarCode in Unit value.

Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

◆ setTwoDDisplayText()

def setTwoDDisplayText (   self,
  value 
)

Text that will be displayed instead of codetext in 2D barcodes.

Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ toString()

def toString (   self)

Returns a human-readable string representation of this CodetextParameters.

Returns
A string that represents this CodetextParameters.

Member Data Documentation

◆ font

font

◆ space

space