sdk-common/com.docusign.androidsdk.dsmodels/DSTab

DSTab

class DSTab : Cloneable

Class which publicly represents a Tab (aka Field) object

Parameters

documentId

the ID of the document where tab is to be placed

recipientId

the ID of the recipient

type

the Tab's type

xPosition

the X position of tab

yPosition

the Y position of the tab

height

height of the Tab

width

width of the Tab

tabLabel

name of the Tab

pageNumber

Page number where tab is placed

name

Name of the tab

optional

boolean indicates whether Tab is optional or required

value

the value of Tab

DSStampType

Signature Stamp type

paymentsAvailable

if the tab is payments tab

anchorString

the string to find in the document and use as the basis for tab placement

anchorXOffset

the X axis location of the tab in anchorUnits relative to the anchorString

anchorYOffset

the Y axis location of the tab in anchorUnits relative to the anchorString

anchorUnits

units of the anchorXOffset and anchorYOffset. Valid units are: pixels, inches, mms, cms

anchorIgnoreIfNotPresent

When true, this tab is ignored if the anchorString is not found in the document

groupLabel

Group label

minimumRequired

Minimum required for tab validation

maximumAllowed

Maximum Allowed for tab validation

groupRule

Group Rule for tab

tabGroupLabel

Tab Group Label

Types

Builder

class Builder

Functions

clone

open override fun clone(): Any

Properties

anchorCaseSensitive

var anchorCaseSensitive: Boolean? = null

anchorIgnoreIfNotPresent

var anchorIgnoreIfNotPresent: Boolean? = null

anchorString

var anchorString: String? = null

anchorUnits

var anchorUnits: String? = null

anchorXOffset

var anchorXOffset: Int? = null

anchorYOffset

var anchorYOffset: Int? = null

concealValueOnDocument

var concealValueOnDocument: Boolean? = null

conditionalParentLabel

var conditionalParentLabel: String? = null

conditionalParentValue

var conditionalParentValue: String? = null

disableAutoSize

var disableAutoSize: Boolean? = null

documentId

var documentId: String

DSStampType

var DSStampType: DSStampType?

errorDetails

var errorDetails: String? = null

font

var font: String? = null

fontColor

var fontColor: String? = null

fontSize

var fontSize: String? = null

groupLabel

var groupLabel: String? = null

groupName

var groupName: String?

groupRule

var groupRule: String? = null

height

var height: Float? = null

listItems

var listItems: List<DSTabListItem>?

locked

var locked: Boolean?

maximumAllowed

var maximumAllowed: Int? = null

maxLength

var maxLength: Int? = null

minimumRequired

var minimumRequired: Int? = null

name

var name: String?

optional

var optional: Boolean?

pageNumber

var pageNumber: Int?

paymentsAvailable

var paymentsAvailable: Boolean? = null

recipientId

var recipientId: String

required

var required: Boolean? = null

requiredRead

var requiredRead: Boolean? = null

scaleValue

var scaleValue: Float? = null

tabGroupLabel

var tabGroupLabel: String? = null

tabId

var tabId: String

tabLabel

var tabLabel: String?

tooltip

var tooltip: String? = null

type

var type: DSTabType

validationMessage

var validationMessage: String? = null

value

var value: String?

width

var width: Float? = null

xPosition

var xPosition: Int? = null

yPosition

var yPosition: Int? = null