BarcodeField
Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation, com.aspose.pdf.WidgetAnnotation, com.aspose.pdf.Field, com.aspose.pdf.TextBoxField
public final class BarcodeField extends TextBoxField
Class represents barcode field.
Constructors
Constructor | Description |
---|---|
BarcodeField(Page page, Rectangle rect) | Initializes new instance of the BarcodeField class. |
BarcodeField(IDocument doc, Rectangle rect) | Initializes new instance of the BarcodeField class. |
Methods
Method | Description |
---|---|
getResolution() | Gets the resolution, in dots-per-inch (dpi), at which the barcode object is rendered. |
getCaption() | Gets the caption of the barcode object. |
getSymbology() | Specifies which barcode or glyph technology is to be used on this annotation, see Symbology for details. |
getXSymWidth() | Gets The horizontal distance, in pixels, between two barcode modules. |
getXSymHeight() | Gets the the vertical distance between two barcode modules, measured in pixels. |
getECC() | Gets an integer value representing the error correction coefficient. |
BarcodeField(Page page, Rectangle rect)
public BarcodeField(Page page, Rectangle rect)
Initializes new instance of the BarcodeField class.
Parameters:
Parameter | Type | Description |
---|---|---|
page | Page | The page where to place new barcode. |
rect | Rectangle | Barcode sizes given in rectangle. |
BarcodeField(IDocument doc, Rectangle rect)
public BarcodeField(IDocument doc, Rectangle rect)
Initializes new instance of the BarcodeField class.
Parameters:
Parameter | Type | Description |
---|---|---|
doc | IDocument | Document where field will be created. |
rect | Rectangle | Rectangle where field will be placed on the page. |
getResolution()
public int getResolution()
Gets the resolution, in dots-per-inch (dpi), at which the barcode object is rendered.
Returns: int - int value
getCaption()
public String getCaption()
Gets the caption of the barcode object.
Returns: java.lang.String - String value
getSymbology()
public int getSymbology()
Specifies which barcode or glyph technology is to be used on this annotation, see Symbology for details.
Returns: int - Symbology element
getXSymWidth()
public int getXSymWidth()
Gets The horizontal distance, in pixels, between two barcode modules.
Returns: int - int value
getXSymHeight()
public int getXSymHeight()
Gets the the vertical distance between two barcode modules, measured in pixels. The ratio XSymHeight/XSymWidth shall be an integer value. For PDF417, the acceptable ratio range is from 1 to 4. For QRCode and DataMatrix, this ratio shall always be 1
Returns: int - int value
getECC()
public int getECC()
Gets an integer value representing the error correction coefficient. For PDF417, shall be from 0 to 8. For QRCode, shall be from 0 to 3 (0 for \u2018L\u2019, 1 for \u2018M\u2019, 2 for \u2018Q\u2019, and 3 for \u2018H\u2019).
Returns: int - int value