QrCodeSignOptions

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.

Constructors

Constructor	Description
QrCodeSignOptions()	Initializes a new instance of the QRCodeSignOptions class with default values.
QrCodeSignOptions(String text)	Initializes a new instance of the QRCodeSignOptions class with text.
QrCodeSignOptions(String text, QrCodeType encodeType)	Initializes a new instance of the BarcodeSignOptions class with text.

Methods

Method	Description
getEncodeType()	Gets or sets QRCode type.
setEncodeType(QrCodeType value)	Gets or sets QRCode type.
getForeColor()	Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification.
setForeColor(Color value)	Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification.
setForeColor(String value)	Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification.
getInnerMargins()	Gets or sets the space between QRCode elements and result image borders.
setInnerMargins(Padding value)	Gets or sets the space between QRCode elements and result image borders.
getCodeTextAlignment()	Gets or sets the alignment of text in the result QR-code image.
setCodeTextAlignment(int value)	Gets or sets the alignment of text in the result QR-code image.
getLogoFilePath()	Gets or sets the QR-code logo image file name.
setLogoFilePath(String value)	Gets or sets the QR-code logo image file name.
getLogoStream()	Gets or sets the QR-code logo image stream.
setLogoStream(InputStream value)	Gets or sets the QR-code logo image stream.
getData()	Gets or sets custom object to serialize to QR-Code content.
setData(Object value)	Gets or sets custom object to serialize to QR-Code content.
getDataEncryption()	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
setDataEncryption(IDataEncryption value)	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
getReturnContent()	Gets or sets flag to get QR-Code image content of a signature which was put on document page.
setReturnContent(boolean value)	Gets or sets flag to get QR-Code image content of a signature which was put on document page.
getReturnContentType()	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
setReturnContentType(FileType value)	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
toString()	Override string conversion.
signature()

QrCodeSignOptions()

public QrCodeSignOptions()

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

QrCodeSignOptions(String text)

public QrCodeSignOptions(String text)

Initializes a new instance of the QRCodeSignOptions class with text.

Parameters:

Parameter	Type	Description
text	java.lang.String	Signature text.

QrCodeSignOptions(String text, QrCodeType encodeType)

public QrCodeSignOptions(String text, QrCodeType encodeType)

Initializes a new instance of the BarcodeSignOptions class with text.

Parameters:

Parameter	Type	Description
text	java.lang.String	QRCode text
encodeType	QrCodeType	QRCode encode type see QrCodeType

getEncodeType()

public final QrCodeType getEncodeType()

Gets or sets QRCode type.

Returns: QrCodeType

setEncodeType(QrCodeType value)

public final void setEncodeType(QrCodeType value)

Gets or sets QRCode type.

Parameters:

Parameter	Type	Description
value	QrCodeType

getForeColor()

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

setForeColor(Color value)

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:

Parameter	Type	Description
value	java.awt.Color

setForeColor(String value)

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:

Parameter	Type	Description
value	java.lang.String

getInnerMargins()

public final Padding getInnerMargins()

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

Returns: Padding

setInnerMargins(Padding value)

public final void setInnerMargins(Padding value)

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

Parameters:

Parameter	Type	Description
value	Padding

getCodeTextAlignment()

public final int getCodeTextAlignment()

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

Returns: int

setCodeTextAlignment(int value)

public final void setCodeTextAlignment(int value)

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

Parameters:

Parameter	Type	Description
value	int

getLogoFilePath()

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

setLogoFilePath(String value)

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:

Parameter	Type	Description
value	java.lang.String

getLogoStream()

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

setLogoStream(InputStream value)

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:

Parameter	Type	Description
value	java.io.InputStream

getData()

public final Object getData()

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

Returns: java.lang.Object

setData(Object value)

public final void setData(Object value)

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

Parameters:

Parameter	Type	Description
value	java.lang.Object

getDataEncryption()

public final IDataEncryption getDataEncryption()

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

Returns: IDataEncryption

setDataEncryption(IDataEncryption value)

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:

Parameter	Type	Description
value	IDataEncryption

getReturnContent()

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

setReturnContent(boolean value)

public final void setReturnContent(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getReturnContentType()

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

setReturnContentType(FileType value)

public final void setReturnContentType(FileType value)

Parameters:

Parameter	Type	Description
value	FileType

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -

signature()

public BaseSignature signature()

Returns: BaseSignature

MetadataSignOptions SignOptions