 | IEncoderOptions Interface |
Defines options for encoding barcodes.
Namespace: Opait.Barcoder.Api
Assembly: Opait.Barcoder (in Opait.Barcoder.dll) Version: 1.3.4.0
SyntaxC#
public interface IEncoderOptions
The IEncoderOptions type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AddChecksum |
Gets or sets a flag indicating whether a checksum will be added
for the barcode types that support them.
|
| AlternateText |
Gets or sets an alternative string for the label that will be printed instead
of the barcode content. The ShowText flag must also be set.
|
| BackColor |
The background color of the barcode.
|
| BarColor |
Gets or sets the color used to draw bars.
|
| Bottom |
Gets or sets the y-coordinate of the barcode in PDF page units.
|
| FontName |
Gets or sets the font family name used to draw the label.
Defaults to Arial.
|
| FontSize |
Gets or sets the font size for the label.
|
| Height |
Gets or sets the height of the generated barcode in logical units.
|
| Left |
Gets or sets the x-coordinate of the barcode in PDF page units.
|
| Pages |
Gets or sets the list of 1-based PDF page numbers for adding barcodes.
For example "1,2-5,8-". Can also use "odd" or "even" for all odd/even
numbered pages in the PDF file. Barcodes will be inserted in the same
location on the specified pages. Default is a single barcode on page 1.
|
| ShowChecksum |
Gets or sets a flag indicating whether the checksum will be appended
to the label. The ShowText flag must also be set.
|
| ShowGuards |
Gets or sets a flag indicating whether the guard lines will be shown
for barcode types that support them.
|
| ShowText |
Gets or sets a flag to indicate whether the text of the barcode should be
included when the barcode is rendered. This flag will only apply to formats
that support printing of text labels.
|
| StoreContent |
Gets or sets a flag to indicate whether barcode content will be stored
as hidden text behind the barcode in PDF files.
|
| TextColor |
Gets or sets the color used to draw barcode labels.
|
| Width |
Gets or sets the width of the generated barcode in logical units.
|
Methods| Name | Description | |
|---|---|---|
 | GetPageNumbers |
Gets the list of page numbers that should receive barcodes. Parses the
Pages string to generate a list of zero-based page numbers.
|
| Reset |
Resets the encoder options to their default values.
|
See Also