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

Inherits BaseJavaClass.

Public Member Functions

 getTwoDDisplayText ()
 
 setTwoDDisplayText ($value)
 
 getFontMode ()
 
 setFontMode ($value)
 
 getFont ()
 
 setFont (FontUnit $value)
 
 getSpace ()
 
 setSpace (Unit $value)
 
 getAlignment ()
 
 setAlignment ($value)
 
 getColor ()
 
 setColor ($value)
 
 getLocation ()
 
 setLocation ($value)
 
 getNoWrap ()
 
 setNoWrap ($value)
 
 toString ()
 

Detailed Description

Codetext parameters.

Member Function Documentation

◆ getAlignment()

getAlignment ( )

Gets or sets the alignment of the code text. Default value: TextAlignment::CENTER.

◆ getColor()

getColor ( )

Specify the displaying CodeText's Color. Default value BLACK.

◆ getFont()

getFont ( )

Specify the displaying CodeText's font. Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode::AUTO.

◆ getFontMode()

getFontMode ( )

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()

getLocation ( )

Specify the displaying CodeText Location, set to CodeLocation::NONE to hide CodeText. Default value: CodeLocation::BELOW.

◆ getNoWrap()

getNoWrap ( )

Specify word wraps (line breaks) within text.

Returns
bool

◆ getSpace()

getSpace ( )

Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

◆ getTwoDDisplayText()

getTwoDDisplayText ( )

Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ setAlignment()

setAlignment (   $value)

Gets or sets the alignment of the code text. Default value: TextAlignment::CENTER.

◆ setColor()

setColor (   $value)

Specify the displaying CodeText's Color. Default value BLACK.

◆ setFont()

setFont ( FontUnit  $value)

Specify the displaying CodeText's font. Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode::AUTO.

◆ setFontMode()

setFontMode (   $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()

setLocation (   $value)

Specify the displaying CodeText Location, set to CodeLocation::NONE to hide CodeText. Default value: CodeLocation::BELOW.

◆ setNoWrap()

setNoWrap (   $value)

Specify word wraps (line breaks) within text.

◆ setSpace()

setSpace ( 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.

◆ setTwoDDisplayText()

setTwoDDisplayText (   $value)

Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ toString()

toString ( )

Returns a human-readable string representation of this CodetextParameters.

Returns
A string that represents this CodetextParameters.