Packages

 

com.groupdocs.signature.options.textsignature

Class CellsSignTextOptions

    • Constructor Detail

      • CellsSignTextOptions

        public CellsSignTextOptions()

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

      • CellsSignTextOptions

        public CellsSignTextOptions(String text)

        Initializes a new instance of the CellsSignTextOptions class with text.

        Parameters:
        text - Signature text
    • Method Detail

      • getBackgroundBrushStyle

        public Brush getBackgroundBrushStyle()

        Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. It is not used for Watermark implementation.

        Overrides:
        getBackgroundBrushStyle in class SignTextOptions
      • getBackgroundTransparency

        public final double getBackgroundTransparency()

        Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).

      • getBorderDashStyle

        public final int getBorderDashStyle()

        Gets or sets the signature border style.

      • getBorderTransparency

        public final double getBorderTransparency()

        Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

      • getBorderVisiblity

        public final boolean getBorderVisiblity()

        Gets or sets the signature border visibility.

      • getBorderWeight

        public final double getBorderWeight()

        Gets or sets the weight of the signature border.

      • getColumnNumber

        public final int getColumnNumber()

        Gets or sets the left column number of signature (min value is 0). This property is mutually exclusive with Top property. When ColumnNumber is set Left property will be reset to 0.

        Specified by:
        getColumnNumber in interface ICellsPosition
      • getDocumentPageNumber

        public int getDocumentPageNumber()

        Gets or sets worksheet number for signing. Minimal value is 1.

        Overrides:
        getDocumentPageNumber in class SignOptions
      • getLeft

        public int getLeft()

        Gets or sets the position of the left edge of the Signature area in pixels. This property is mutually exclusive with Column property. If Left property is set ColumnNumber will be reset to 0.

        Specified by:
        getLeft in interface IRectangle
        Overrides:
        getLeft in class SignTextOptions
      • getLocationMeasureType

        public int getLocationMeasureType()

        Measure type (pixels, percents or millimeters) for Left and Top properties. If measure type is percents signature location is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        getLocationMeasureType in interface IRectangle
        Overrides:
        getLocationMeasureType in class SignTextOptions
      • getMargin

        public Padding getMargin()

        Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).

        Specified by:
        getMargin in interface IAlignment
        Overrides:
        getMargin in class SignTextOptions
      • getMarginMeasureType

        public int getMarginMeasureType()

        Gets or sets the measure type (pixels, percents or millimeters) for Margin. If measure type is percents signature margin is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        getMarginMeasureType in interface IAlignment
        Overrides:
        getMarginMeasureType in class SignTextOptions
      • getOpacity

        public final double getOpacity()

        Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency

        Specified by:
        getOpacity in interface IOpacity
      • getRowNumber

        public final int getRowNumber()

        Gets or sets the top row number of signature (min value is 0). This property is mutually exclusive with Left property. When RowNumber is set Top property will be reset to 0.

        Specified by:
        getRowNumber in interface ICellsPosition
      • getShapeType

        public final int getShapeType()

        Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

      • getSheetNumber

        public final int getSheetNumber()

        Gets or sets worksheet number for signing.

      • getSignatureImplementation

        public final int getSignatureImplementation()

        Gets or sets the type of text signature implementation.

      • getSizeMeasureType

        public int getSizeMeasureType()

        Measure type (pixels, percents or millimeters) for Width and Height properties. If measure type is percents signature size is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        getSizeMeasureType in interface IRectangle
        Overrides:
        getSizeMeasureType in class SignTextOptions
      • getTop

        public int getTop()

        Gets or sets the position of the top edge of the Signature area in pixels. This property is mutually exclusive with Row property. If Top property is set RowNumber will be reset to 0.

        Specified by:
        getTop in interface IRectangle
        Overrides:
        getTop in class SignTextOptions
      • setBackgroundBrushStyle

        public void setBackgroundBrushStyle(Brush value)

        Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. It is not used for Watermark implementation.

        Overrides:
        setBackgroundBrushStyle in class SignTextOptions
      • setBackgroundTransparency

        public final void setBackgroundTransparency(double value)

        Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).

      • setBorderDashStyle

        public final void setBorderDashStyle(int value)

        Gets or sets the signature border style.

      • setBorderTransparency

        public final void setBorderTransparency(double value)

        Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

      • setBorderVisiblity

        public final void setBorderVisiblity(boolean value)

        Gets or sets the signature border visibility.

      • setBorderWeight

        public final void setBorderWeight(double value)

        Gets or sets the weight of the signature border.

      • setColumnNumber

        public final void setColumnNumber(int value)

        Gets or sets the left column number of signature (min value is 0). This property is mutually exclusive with Top property. When ColumnNumber is set Left property will be reset to 0.

        Specified by:
        setColumnNumber in interface ICellsPosition
      • setDocumentPageNumber

        public void setDocumentPageNumber(int value)

        Gets or sets worksheet number for signing. Minimal value is 1.

        Overrides:
        setDocumentPageNumber in class SignOptions
      • setLeft

        public void setLeft(int value)

        Gets or sets the position of the left edge of the Signature area in pixels. This property is mutually exclusive with Column property. If Left property is set ColumnNumber will be reset to 0.

        Specified by:
        setLeft in interface IRectangle
        Overrides:
        setLeft in class SignTextOptions
      • setLocationMeasureType

        public void setLocationMeasureType(int value)

        Measure type (pixels, percents or millimeters) for Left and Top properties. If measure type is percents signature location is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        setLocationMeasureType in interface IRectangle
        Overrides:
        setLocationMeasureType in class SignTextOptions
      • setMargin

        public void setMargin(Padding value)

        Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).

        Specified by:
        setMargin in interface IAlignment
        Overrides:
        setMargin in class SignTextOptions
      • setMarginMeasureType

        public void setMarginMeasureType(int value)

        Gets or sets the measure type (pixels, percents or millimeters) for Margin. If measure type is percents signature margin is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        setMarginMeasureType in interface IAlignment
        Overrides:
        setMarginMeasureType in class SignTextOptions
      • setOpacity

        public final void setOpacity(double value)

        Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency

        Specified by:
        setOpacity in interface IOpacity
      • setRowNumber

        public final void setRowNumber(int value)

        Gets or sets the top row number of signature (min value is 0). This property is mutually exclusive with Left property. When RowNumber is set Top property will be reset to 0.

        Specified by:
        setRowNumber in interface ICellsPosition
      • setShapeType

        public final void setShapeType(int value)

        Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

      • setSheetNumber

        public final void setSheetNumber(int value)

        Gets or sets worksheet number for signing.

      • setSignatureImplementation

        public final void setSignatureImplementation(int value)

        Gets or sets the type of text signature implementation.

      • setSizeMeasureType

        public void setSizeMeasureType(int value)

        Measure type (pixels, percents or millimeters) for Width and Height properties. If measure type is percents signature size is calculated according to worksheet area where cells with data or style are located.

        Specified by:
        setSizeMeasureType in interface IRectangle
        Overrides:
        setSizeMeasureType in class SignTextOptions
      • setTextHorizontalAlignment

        public final void setTextHorizontalAlignment(int value)

        Horizontal alignment of text inside a signature.

        Specified by:
        setTextHorizontalAlignment in interface ITextAlignment
      • setTextVerticalAlignment

        public final void setTextVerticalAlignment(int value)

        Vertical alignment of text inside a signature.

        Specified by:
        setTextVerticalAlignment in interface ITextAlignment
      • setTop

        public void setTop(int value)

        Gets or sets the position of the top edge of the Signature area in pixels. This property is mutually exclusive with Row property. If Top property is set RowNumber will be reset to 0.

        Specified by:
        setTop in interface IRectangle
        Overrides:
        setTop in class SignTextOptions