public class BarcodeSignOptions extends TextSignOptions
Represents the Barcode signature options.
DEFAULT_TRANSPARENCY| Constructor and Description |
|---|
BarcodeSignOptions()
Initializes a new instance of the BarcodeSignOptions class with default values.
|
BarcodeSignOptions(String text)
Initializes a new instance of the BarcodeSignOptions class with text.
|
BarcodeSignOptions(String text,
BarcodeType encodeType)
Initializes a new instance of the BarcodeSignOptions class with text.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getCodeTextAlignment()
Gets or sets the alignment of text in the result Barcode image.
|
BarcodeType |
getEncodeType()
Gets or sets Barcode type.
|
Color |
getForeColor()
Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification.
|
Padding |
getInnerMargins()
Gets or sets the space between Barcode elements and result image borders.
|
boolean |
getReturnContent()
Gets or sets flag to get Barcode image content of a signature which was put on document page.
|
FileType |
getReturnContentType()
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
|
void |
setCodeTextAlignment(int value)
Gets or sets the alignment of text in the result Barcode image.
|
void |
setEncodeType(BarcodeType value)
Gets or sets Barcode type.
|
void |
setForeColor(Color value)
Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification.
|
void |
setInnerMargins(Padding value)
Gets or sets the space between Barcode elements and result image borders.
|
void |
setReturnContent(boolean value)
Gets or sets flag to get Barcode image content of a signature which was put on document page.
|
void |
setReturnContentType(FileType value)
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
|
String |
toString()
Override string conversion.
|
void |
validate()
Internal method to validate the Barcode options parameters.
|
getBackground, getBorder, getFont, getFormTextFieldTitle, getFormTextFieldType, getHeight, getHorizontalAlignment, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getNative, getRotationAngle, getShapeType, getSignatureID, getSignatureImplementation, getSizeMeasureType, getStretch, getText, getTextHorizontalAlignment, getTextVerticalAlignment, getTop, getTransparency, getVerticalAlignment, getWidth, setBackground, setBorder, setFont, setFormTextFieldTitle, setFormTextFieldType, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setNative, setRotationAngle, setShapeType, setSignatureID, setSignatureImplementation, setSizeMeasureType, setStretch, setText, setTextHorizontalAlignment, setTextVerticalAlignment, setTop, setTransparency, setVerticalAlignment, setWidthaddSignature, getAllPages, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAllPages, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrderpublic BarcodeSignOptions()
Initializes a new instance of the BarcodeSignOptions class with default values.
public BarcodeSignOptions(String text)
Initializes a new instance of the BarcodeSignOptions class with text.
text - Barcode textpublic BarcodeSignOptions(String text, BarcodeType encodeType)
Initializes a new instance of the BarcodeSignOptions class with text.
text - Barcode textencodeType - Barcode encode type see BarcodeTypepublic final int getCodeTextAlignment()
Gets or sets the alignment of text in the result Barcode image. Default value is None.
public final BarcodeType getEncodeType()
Gets or sets Barcode type.
public Color getForeColor()
Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.
getForeColor in class TextSignOptionspublic final Padding getInnerMargins()
Gets or sets the space between Barcode elements and result image borders.
public final boolean getReturnContent()
Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format ReturnContentType(getReturnContentType()/setReturnContentType(FileType)).
By default this option is disabled.
public final FileType getReturnContentType()
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at BarcodeSignature.Format(BarcodeSignature.getFormat()})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.
public final void setCodeTextAlignment(int value)
Gets or sets the alignment of text in the result Barcode image. Default value is None.
public final void setEncodeType(BarcodeType value)
Gets or sets Barcode type.
public void setForeColor(Color value)
Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.
setForeColor in class TextSignOptionspublic final void setInnerMargins(Padding value)
Gets or sets the space between Barcode elements and result image borders.
public final void setReturnContent(boolean value)
Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format ReturnContentType(getReturnContentType()/setReturnContentType(FileType)).
By default this option is disabled.
public final void setReturnContentType(FileType value)
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at BarcodeSignature.Format(BarcodeSignature.getFormat())
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.
public String toString()
Override string conversion.
toString in class TextSignOptionspublic void validate()
throws Exception
Internal method to validate the Barcode options parameters.
validate in class TextSignOptionsException