Packages

com.groupdocs.signature.options.sign

Classes

java.lang.Object
- com.groupdocs.signature.options.sign.SignOptions
- - com.groupdocs.signature.options.sign.TextSignOptions
  - - com.groupdocs.signature.options.sign.QrCodeSignOptions

All Implemented Interfaces:

IAlignment, IRectangle, IRotation, ITransparency
```
public class QrCodeSignOptions
extends TextSignOptions
```
Represents the QR-Code signature options.

Field Summary
- Fields inherited from class com.groupdocs.signature.options.sign.TextSignOptions
  DEFAULT_TRANSPARENCY

Constructor Summary

Constructors
Constructor and 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.

Method Summary

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

Methods inherited from class com.groupdocs.signature.options.sign.TextSignOptions
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, setWidth, validate

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions
addSignature, getAllPages, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAllPages, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - QrCodeSignOptions
```
public QrCodeSignOptions()
```
    Initializes a new instance of the QRCodeSignOptions class with default values.
  - QrCodeSignOptions
```
public QrCodeSignOptions(String text)
```
    Initializes a new instance of the QRCodeSignOptions class with text.
    
    Parameters:
    
    text - Signature text.
  - QrCodeSignOptions
```
public QrCodeSignOptions(String text,
                         QrCodeType encodeType)
```
    Initializes a new instance of the BarcodeSignOptions class with text.
    
    Parameters:
    
    text - QRCode text
    
    encodeType - QRCode encode type see QrCodeType
- Method Detail
  - getCodeTextAlignment
```
public final int getCodeTextAlignment()
```
    Gets or sets the alignment of text in the result QR-code image. Default value is None.
  - getData
```
public final Object getData()
```
    Gets or sets custom object to serialize to QR-Code content.
  - getDataEncryption
```
public final IDataEncryption getDataEncryption()
```
    Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
  - getEncodeType
```
public final QrCodeType getEncodeType()
```
    Gets or sets QRCode type.
  - 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.
    
    Overrides:
    
    getForeColor in class TextSignOptions
  - getInnerMargins
```
public final Padding getInnerMargins()
```
    Gets or sets the space between QRCode elements and result image borders.
  - 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.
  - 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.
  - 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()/setReturnContentType(FileType)). By default this option is disabled.
  - 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()/QrCodeSignature.setFormat(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.
  - setCodeTextAlignment
```
public final void setCodeTextAlignment(int value)
```
    Gets or sets the alignment of text in the result QR-code image. Default value is None.
  - setData
```
public final void setData(Object value)
```
    Gets or sets custom object to serialize to QR-Code content.
  - setDataEncryption
```
public final void setDataEncryption(IDataEncryption value)
```
    Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
  - setEncodeType
```
public final void setEncodeType(QrCodeType value)
```
    Gets or sets QRCode type.
  - setForeColor
```
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.
    
    Overrides:
    
    setForeColor in class TextSignOptions
  - setInnerMargins
```
public final void setInnerMargins(Padding value)
```
    Gets or sets the space between QRCode elements and result image borders.
  - setLogoFilePath
```
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.
  - setLogoStream
```
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.
  - setReturnContent
```
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()/setReturnContentType(FileType)). By default this option is disabled.
  - setReturnContentType
```
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()/QrCodeSignature.setFormat(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.
  - signature
```
public BaseSignature signature()
```
    Overrides:
    
    signature in class TextSignOptions
  - toString
```
public String toString()
```
    Override string conversion.
    
    Overrides:
    
    toString in class TextSignOptions
    
    Returns:

Packages

com.groupdocs.signature.options.sign

Classes

Class QrCodeSignOptions

Field Summary

Fields inherited from class com.groupdocs.signature.options.sign.TextSignOptions

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.signature.options.sign.TextSignOptions

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions

Methods inherited from class java.lang.Object

Constructor Detail

QrCodeSignOptions

QrCodeSignOptions

QrCodeSignOptions

Method Detail

getCodeTextAlignment

getData

getDataEncryption

getEncodeType

getForeColor

getInnerMargins

getLogoFilePath

getLogoStream

getReturnContent

getReturnContentType

setCodeTextAlignment

setData

setDataEncryption

setEncodeType

setForeColor

setInnerMargins

setLogoFilePath

setLogoStream

setReturnContent

setReturnContentType

signature

toString