Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 2.25 KB

SubFormFieldsPerDocumentHyperlink.md

File metadata and controls

25 lines (21 loc) · 2.25 KB

Dropbox.Sign.Model.SubFormFieldsPerDocumentHyperlink

This class extends SubFormFieldsPerDocumentBase.

Properties

Name Type Description Notes
DocumentIndex int Represents the integer index of the file or file_url document the field should be attached to.
ApiId string An identifier for the field that is unique across all documents in the request.
Height int Size of the field in pixels.
Required bool Whether this field is required.
Signer string Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

NOTE: To set the value of the field as the preparer you must set this to me_now

NOTE: If type is text-merge or checkbox-merge, you must set this to sender in order to use pre-filled data.
Width int Size of the field in pixels.
X int Location coordinates of the field in pixels.
Y int Location coordinates of the field in pixels.
Name string Display name for the field. [optional]
Page int? Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both coordinate systems and how to use them.
[optional]
Type string A hyperlink field. Use the SubFormFieldsPerDocumentHyperlink class. [default to "hyperlink"]
Content string Link Text.
ContentUrl string Link URL.
FontFamily string Font family for the field. [optional]
FontSize int The initial px font size for the field contents. Can be any integer value between 7 and 49.

NOTE: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
[optional] [default to 12]

[Back to Model list] [Back to API list] [Back to README]