SignTextOptions (GroupDocs.Signature for Java (18.4) API Reference)

java.lang.Object
- com.groupdocs.signature.options.SignOptions
- - com.groupdocs.signature.options.textsignature.SignTextOptions

All Implemented Interfaces:

IAlignment, IRectangle, IRotation

Direct Known Subclasses:

BarcodeSignOptions, CellsSignTextOptions, ImagesSignTextOptions, PdfSignTextOptions, QRCodeSignOptions, SlidesSignTextOptions, WordsSignTextOptions
```
public abstract class SignTextOptions
extends SignOptions
implements IRectangle, IAlignment, IRotation
```
Represents the Text Signature Options.

Constructor Summary

Constructors
Constructor and Description
`SignTextOptions()` Initializes a new instance of the SignTextOptions class with default values.
`SignTextOptions(String text)` Initializes a new instance of the SignTextOptions class with text.

Method Summary

Methods
Modifier and Type	Method and Description
`Brush`	`getBackgroundBrushStyle()` Gets or sets the signature background brush.
`Color`	`getBackgroundColor()` Gets or sets the background color of signature.
`Color`	`getBorderColor()` Gets or sets the border color of signature.
`SignatureFont`	`getFont()` Gets or sets the font of signature.
`Color`	`getForeColor()` Gets or sets the fore color of signature.
`int`	`getHeight()` Height of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType property).
`int`	`getHorizontalAlignment()` Horizontal alignment of signature on document page.
`protected com.groupdocs.signature.domain.helpers.ImageHelper`	`getImageHelper()`
`int`	`getLeft()` Left X position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType property).
`int`	`getLocationMeasureType()` Measure type (pixels or percent) for Left and Top properties.
`Padding`	`getMargin()` Gets or sets the space between Sign and Document edges.
`int`	`getMarginMeasureType()` Gets or sets the measure type (pixels or percent) for Margin.
`int`	`getRotationAngle()` Rotation angle of signature on document page (clockwise).
`boolean`	`getSignAllPages()` Put signature on all document pages.
`int`	`getSizeMeasureType()` Measure type (pixels or percent) for Width and Height properties.
`int`	`getStretch()` Stretch mode on Document Page.
`String`	`getText()` Gets or sets the text of signature.
`int`	`getTop()` Top Y Position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType property).
`int`	`getVerticalAlignment()` Vertical alignment of signature on document page.
`int`	`getWidth()` Width of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType property).
`void`	`setBackgroundBrushStyle(Brush value)` Gets or sets the signature background brush.
`void`	`setBackgroundColor(Color value)` Gets or sets the background color of signature.
`void`	`setBorderColor(Color value)` Gets or sets the border color of signature.
`void`	`setFont(SignatureFont value)` Gets or sets the font of signature.
`void`	`setForeColor(Color value)` Gets or sets the fore color of signature.
`void`	`setHeight(int value)` Height of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType property).
`void`	`setHorizontalAlignment(int value)` Horizontal alignment of signature on document page.
`void`	`setLeft(int value)` Left X position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType property).
`void`	`setLocationMeasureType(int value)` Measure type (pixels or percent) for Left and Top properties.
`void`	`setMargin(Padding value)` Gets or sets the space between Sign and Document edges.
`void`	`setMarginMeasureType(int value)` Gets or sets the measure type (pixels or percent) for Margin.
`void`	`setRotationAngle(int value)` Rotation angle of signature on document page (clockwise).
`void`	`setSignAllPages(boolean value)` Put signature on all document pages.
`void`	`setSizeMeasureType(int value)` Measure type (pixels or percent) for Width and Height properties.
`void`	`setStretch(int value)` Stretch mode on Document Page.
`void`	`setText(String value)` Gets or sets the text of signature.
`void`	`setTop(int value)` Top Y Position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType property).
`void`	`setVerticalAlignment(int value)` Vertical alignment of signature on document page.
`void`	`setWidth(int value)` Width of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType property).
`String`	`toString()` Override string conversion.

Methods inherited from class com.groupdocs.signature.options.SignOptions
getAppearance, getDocumentPageNumber, getExtensions, getPagesSetup, release, setAppearance, setDocumentPageNumber, setPagesSetup, validate

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

- Constructor Detail
  - SignTextOptions
```
public SignTextOptions()
```
    Initializes a new instance of the SignTextOptions class with default values.
  - SignTextOptions
```
public SignTextOptions(String text)
```
    Initializes a new instance of the SignTextOptions 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. If this property has a value it will be used instead BackgroundBrush property.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Gets or sets the background color of signature.
  - getBorderColor
```
public Color getBorderColor()
```
    Gets or sets the border color of signature.
  - getFont
```
public SignatureFont getFont()
```
    Gets or sets the font of signature.
  - getForeColor
```
public Color getForeColor()
```
    Gets or sets the fore color of signature.
  - getHeight
```
public int getHeight()
```
    Height of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property).
    
    Specified by:
    
    getHeight in interface IRectangle
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
    Horizontal alignment of signature on document page.
    
    Specified by:
    
    getHorizontalAlignment in interface IAlignment
  - getImageHelper
```
protected com.groupdocs.signature.domain.helpers.ImageHelper getImageHelper()
```
  - getLeft
```
public int getLeft()
```
    Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).
    
    Specified by:
    
    getLeft in interface IRectangle
  - getLocationMeasureType
```
public int getLocationMeasureType()
```
    Measure type (pixels or percent) for Left and Top properties.
    
    Specified by:
    
    getLocationMeasureType in interface IRectangle
  - getMargin
```
public Padding getMargin()
```
    Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
    
    Specified by:
    
    getMargin in interface IAlignment
  - getMarginMeasureType
```
public int getMarginMeasureType()
```
    Gets or sets the measure type (pixels or percent) for Margin.
    
    Specified by:
    
    getMarginMeasureType in interface IAlignment
  - getRotationAngle
```
public int getRotationAngle()
```
    Rotation angle of signature on document page (clockwise).
    
    Specified by:
    
    getRotationAngle in interface IRotation
  - getSignAllPages
```
public boolean getSignAllPages()
```
    Put signature on all document pages.
  - getSizeMeasureType
```
public int getSizeMeasureType()
```
    Measure type (pixels or percent) for Width and Height properties.
    
    Specified by:
    
    getSizeMeasureType in interface IRectangle
  - getStretch
```
public int getStretch()
```
    Stretch mode on Document Page.
    
    Specified by:
    
    getStretch in interface IRectangle
  - getText
```
public String getText()
```
    Gets or sets the text of signature.
  - getTop
```
public int getTop()
```
    Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).
    
    Specified by:
    
    getTop in interface IRectangle
  - getVerticalAlignment
```
public int getVerticalAlignment()
```
    Vertical alignment of signature on document page.
    
    Specified by:
    
    getVerticalAlignment in interface IAlignment
  - getWidth
```
public int getWidth()
```
    Width of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property).
    
    Specified by:
    
    getWidth in interface IRectangle
  - setBackgroundBrushStyle
```
public void setBackgroundBrushStyle(Brush value)
```
    Gets or sets the signature background brush. Value by default is null. If this property has a value it will be used instead BackgroundBrush property.
  - setBackgroundColor
```
public void setBackgroundColor(Color value)
```
    Gets or sets the background color of signature.
  - setBorderColor
```
public void setBorderColor(Color value)
```
    Gets or sets the border color of signature.
  - setFont
```
public void setFont(SignatureFont value)
```
    Gets or sets the font of signature.
  - setForeColor
```
public void setForeColor(Color value)
```
    Gets or sets the fore color of signature.
  - setHeight
```
public void setHeight(int value)
```
    Height of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property).
    
    Specified by:
    
    setHeight in interface IRectangle
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int value)
```
    Horizontal alignment of signature on document page.
    
    Specified by:
    
    setHorizontalAlignment in interface IAlignment
  - setLeft
```
public void setLeft(int value)
```
    Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).
    
    Specified by:
    
    setLeft in interface IRectangle
  - setLocationMeasureType
```
public void setLocationMeasureType(int value)
```
    Measure type (pixels or percent) for Left and Top properties.
    
    Specified by:
    
    setLocationMeasureType in interface IRectangle
  - setMargin
```
public void setMargin(Padding value)
```
    Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
    
    Specified by:
    
    setMargin in interface IAlignment
  - setMarginMeasureType
```
public void setMarginMeasureType(int value)
```
    Gets or sets the measure type (pixels or percent) for Margin.
    
    Specified by:
    
    setMarginMeasureType in interface IAlignment
  - setRotationAngle
```
public void setRotationAngle(int value)
```
    Rotation angle of signature on document page (clockwise).
    
    Specified by:
    
    setRotationAngle in interface IRotation
  - setSignAllPages
```
public void setSignAllPages(boolean value)
```
    Put signature on all document pages.
  - setSizeMeasureType
```
public void setSizeMeasureType(int value)
```
    Measure type (pixels or percent) for Width and Height properties.
    
    Specified by:
    
    setSizeMeasureType in interface IRectangle
  - setStretch
```
public void setStretch(int value)
```
    Stretch mode on Document Page.
    
    Specified by:
    
    setStretch in interface IRectangle
  - setText
```
public void setText(String value)
```
    Gets or sets the text of signature.
  - setTop
```
public void setTop(int value)
```
    Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).
    
    Specified by:
    
    setTop in interface IRectangle
  - setVerticalAlignment
```
public void setVerticalAlignment(int value)
```
    Vertical alignment of signature on document page.
    
    Specified by:
    
    setVerticalAlignment in interface IAlignment
  - setWidth
```
public void setWidth(int value)
```
    Width of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property).
    
    Specified by:
    
    setWidth in interface IRectangle
  - toString
```
public String toString()
```
    Override string conversion.
    
    Overrides:
    
    toString in class SignOptions
    
    Returns:

Class SignTextOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SignTextOptions

SignTextOptions

Method Detail

getBackgroundBrushStyle

getBackgroundColor

getBorderColor

getFont

getForeColor

getHeight

getHorizontalAlignment

getImageHelper

getLeft

getLocationMeasureType

getMargin

getMarginMeasureType

getRotationAngle

getSignAllPages

getSizeMeasureType

getStretch

getText

getTop

getVerticalAlignment

getWidth

setBackgroundBrushStyle

setBackgroundColor

setBorderColor

setFont

setForeColor

setHeight

setHorizontalAlignment

setLeft

setLocationMeasureType

setMargin

setMarginMeasureType

setRotationAngle

setSignAllPages

setSizeMeasureType

setStretch

setText

setTop

setVerticalAlignment

setWidth

toString