BarcodeSignOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
public class BarcodeSignOptions extends TextSignOptions
Represents the Barcode signature options.
| Constructor | 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. |
| Method | Description |
|---|---|
| getEncodeType() | Gets or sets Barcode type. |
| setEncodeType(BarcodeType value) | Gets or sets Barcode type. |
| getForeColor() | Gets or sets the Fore color of Barcode bars |
| Using of this property could cause problems with verification. | |
| setForeColor(Color value) | Gets or sets the Fore color of Barcode bars |
| Using of this property could cause problems with verification. | |
| setForeColor(String value) | Gets or sets the Fore color of Barcode bars |
| Using of this property could cause problems with verification. | |
| getInnerMargins() | Gets or sets the space between Barcode elements and result image borders. |
| setInnerMargins(Padding value) | Gets or sets the space between Barcode elements and result image borders. |
| getCodeTextAlignment() | Gets or sets the alignment of text in the result Barcode image. |
| setCodeTextAlignment(int value) | Gets or sets the alignment of text in the result Barcode image. |
| getReturnContent() | Gets or sets flag to get Barcode image content of a signature which was put on document page. |
| setReturnContent(boolean value) | Gets or sets flag to get Barcode image content of a signature which was put on document page. |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| validate() | Internal method to validate the Barcode options parameters. |
| toString() | Override string conversion. |
public 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| text | java.lang.String | Barcode text |
public BarcodeSignOptions(String text, BarcodeType encodeType)
Initializes a new instance of the BarcodeSignOptions class with text.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| text | java.lang.String | Barcode text |
| encodeType | BarcodeType | Barcode encode type see BarcodeType |
public final BarcodeType getEncodeType()
Gets or sets Barcode type.
Returns: BarcodeType
public final void setEncodeType(BarcodeType value)
Gets or sets Barcode type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BarcodeType |
public Color getForeColor()
Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.
Returns: java.awt.Color
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.awt.Color |
public void setForeColor(String value)
Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final Padding getInnerMargins()
Gets or sets the space between Barcode elements and result image borders.
Returns: Padding
public final void setInnerMargins(Padding value)
Gets or sets the space between Barcode elements and result image borders.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Padding |
public final int getCodeTextAlignment()
Gets or sets the alignment of text in the result Barcode image. Default value is None.
Returns: int
public final void setCodeTextAlignment(int value)
Gets or sets the alignment of text in the result Barcode image. Default value is None.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
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.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Returns: boolean
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.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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.
Returns: FileType
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FileType |
public void validate()
Internal method to validate the Barcode options parameters.
public String toString()
Override string conversion.
Returns: java.lang.String -
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.