com.groupdocs.signature.options.sign

Class BarcodeSignOptions

    • Constructor Detail

      • BarcodeSignOptions

        public BarcodeSignOptions()

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

      • BarcodeSignOptions

        public BarcodeSignOptions(String text)

        Initializes a new instance of the BarcodeSignOptions class with text.

        Parameters:
        text - Barcode text
      • BarcodeSignOptions

        public BarcodeSignOptions(String text,
                          BarcodeType encodeType)

        Initializes a new instance of the BarcodeSignOptions class with text.

        Parameters:
        text - Barcode text
        encodeType - Barcode encode type see BarcodeType
    • Method Detail

      • getCodeTextAlignment

        public final int getCodeTextAlignment()

        Gets or sets the alignment of text in the result Barcode image. Default value is None.

      • getEncodeType

        public final BarcodeType getEncodeType()

        Gets or sets Barcode type.

      • getForeColor

        public Color getForeColor()

        Gets or sets the Fore color of Barcode 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 Barcode elements and result image borders.

      • getReturnContent

        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.

      • getReturnContentType

        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()/BarcodeSignature.setFormat(FileType)) 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.

      • setCodeTextAlignment

        public final void setCodeTextAlignment(int value)

        Gets or sets the alignment of text in the result Barcode image. Default value is None.

      • setEncodeType

        public final void setEncodeType(BarcodeType value)

        Gets or sets Barcode type.

      • setForeColor

        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.

        Overrides:
        setForeColor in class TextSignOptions
      • setInnerMargins

        public final void setInnerMargins(Padding value)

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

      • setReturnContent

        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.

      • setReturnContentType

        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()/BarcodeSignature.setFormat(FileType)) 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.

      • validate

        public void validate()

        Internal method to validate the Barcode options parameters.

        Overrides:
        validate in class TextSignOptions