QrCodeSignOptions Leave feedback

Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions

public class QrCodeSignOptions extends TextSignOptions

Represents the QR-Code signature options.

public QrCodeSignOptions()

Initializes a new instance of the QRCodeSignOptions class with default values.

public QrCodeSignOptions(String text)

Initializes a new instance of the QRCodeSignOptions class with text.

Parameters:

public QrCodeSignOptions(String text, QrCodeType encodeType)

Initializes a new instance of the BarcodeSignOptions class with text.

Parameters:

public final QrCodeType getEncodeType()

Gets or sets QRCode type.

Returns: QrCodeType

public final void setEncodeType(QrCodeType value)

Gets or sets QRCode type.

Parameters:

public Color getForeColor()

Gets or sets the Fore color of QR-Code 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 QR-Code bars Using of this property could cause problems with verification. Use it carefully.

Parameters:

public void setForeColor(String value)

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

Parameters:

public final Padding getInnerMargins()

Gets or sets the space between QRCode elements and result image borders.

Returns: Padding

public final void setInnerMargins(Padding value)

Gets or sets the space between QRCode elements and result image borders.

Parameters:

public final int getCodeTextAlignment()

Gets or sets the alignment of text in the result QR-code image. Default value is None.

Returns: int

public final void setCodeTextAlignment(int value)

Gets or sets the alignment of text in the result QR-code image. Default value is None.

Parameters:

public final String getLogoFilePath()

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

Returns: java.lang.String

public final void setLogoFilePath(String value)

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

Parameters:

public final InputStream getLogoStream()

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

Returns: java.io.InputStream

public final void setLogoStream(InputStream value)

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

Parameters:

public final Object getData()

Gets or sets custom object to serialize to QR-Code content.

Returns: java.lang.Object

public final void setData(Object value)

Gets or sets custom object to serialize to QR-Code content.

Parameters:

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Returns: IDataEncryption

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Parameters:

public final boolean getReturnContent()

Gets or sets flag to get QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code 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 QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code 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:

public final FileType getReturnContentType()

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format (QrCodeSignature.getFormat/{@link QrCodeSignature#(FileType)}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code 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 QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format (QrCodeSignature.getFormat/{@link QrCodeSignature#(FileType)}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in .png format will be returned.

Parameters:

public String toString()

Override string conversion.

Returns: java.lang.String -

public BaseSignature signature()

Returns: BaseSignature