CodetextParameters

CodetextParameters class

Namespace: Aspose.Barcode.Generation

Codetext parameters.

Constructors

Name	Description
__construct

Properties

Name	Read/Write	Description
Alignment	Read/Write	Gets the alignment of the code text. Default value: TextAlignment::CENTER.
Color	Read/Write	Specify the displaying CodeText’s Color. Default value BLACK.
Font	Read/Write	Specify the displaying CodeText’s font. Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode::AUTO.
FontMode	Read/Write	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	Read/Write	Specify the displaying CodeText Location, set to CodeLocation::NONE to hide CodeText. Default value: CodeLocation::BELOW.
NoWrap	Read/Write	Specify word wraps (line breaks) within text.
Space	Read/Write	Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
TwoDDisplayText	Read/Write	Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

CodetextParameters__construct(CodetextParametersDTO $codetextParametersDto)

Parameter	Type	Description
`$codetextParametersDto`	`CodetextParametersDTO`

Alignment

Access: Read/Write

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

Sets the alignment of the code text. Default value: TextAlignment::CENTER.

Parameter	Type	Description
`$value`	`int`

Color

Access: Read/Write

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

Parameter	Type	Description
`$value`	`string`

Font

Access: Read/Write

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

Parameter	Type	Description
`$value`	`FontUnit`

FontMode

Access: Read/Write

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.

Parameter	Type	Description
`$value`	`int`

Location

Access: Read/Write

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

Parameter	Type	Description
`$value`	`int`

NoWrap

Access: Read/Write

Returns: bool

Specify word wraps (line breaks) within text.

Parameter	Type	Description
`$value`	`bool`

Space

Access: Read/Write

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

Parameter	Type	Description
`$value`	`Unit`

TwoDDisplayText

Access: Read/Write

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

Parameter	Type	Description
`$value`	`string`