Table of Contents

Class DocumentFormFields

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

The document form fields properties include, font, font color, font size and so on.

[DataContract]
public class DocumentFormFields
Inheritance
DocumentFormFields
Inherited Members

Constructors

DocumentFormFields(string, string, string, string, bool?, float?, float?, string, bool?, bool?, bool?, string, string, ValidationType, string, string, ImageInfo, AttachmentInfo, EditableDateFieldSettings, string, string, FileInfo, List<string>, bool?, List<ConditionalRule>, TextAlign, TextDirection, float, string, string)

Initializes a new instance of the DocumentFormFields class.

public DocumentFormFields(string id = null, string type = null, string value = null, string font = null, bool? isRequired = null, float? lineHeight = null, float? fontSize = null, string fontColor = null, bool? isUnderline = null, bool? isItalic = null, bool? isBold = null, string placeholder = null, string dateFormat = null, ValidationType validationType = (ValidationType)0, string validationCustomRegex = null, string validationCustomRegexMessage = null, ImageInfo imageInfo = null, AttachmentInfo attachmentInfo = null, EditableDateFieldSettings editableDateFieldSettings = null, string hyperlinkText = null, string dataSyncTag = null, FileInfo fileInfo = null, List<string> dropdownOptions = null, bool? isReadOnly = null, List<ConditionalRule> conditionalRules = null, TextAlign textAlign = TextAlign.Left, TextDirection textDirection = TextDirection.LTR, float characterSpacing = 0, string label = null, string timeFormat = null)

Parameters

id string

Gets or sets the id..

type string

Gets or sets the element type..

value string

Gets or sets the element type..

font string

Gets or sets the element type..

isRequired bool?

Gets or sets a value indicating whether is required..

lineHeight float?

Gets or sets the line height..

fontSize float?

Gets or sets the font size..

fontColor string

Gets or sets the font color..

isUnderline bool?

Gets or sets a value indicating whether isUnderline..

isItalic bool?

Gets or sets a value indicating whether isItalic..

isBold bool?

Gets or sets a value indicating whether isBold..

placeholder string

Gets or sets the placeHolder value..

dateFormat string

Gets or sets the dateFormat value..

validationType ValidationType

Gets or sets the textbox ValidationType value..

validationCustomRegex string

Gets or sets the textbox ValidationCustomRegex value..

validationCustomRegexMessage string

Gets or sets the textbox ValidationCustomRegexMessage value..

imageInfo ImageInfo

Gets or sets the imageField.

attachmentInfo AttachmentInfo

Gets or sets the attachmentField.

editableDateFieldSettings EditableDateFieldSettings

Gets or sets the editableDateFieldSettings.

hyperlinkText string

Gets or sets the hyperlinkText.

dataSyncTag string

Gets or sets the dataSyncTag.

fileInfo FileInfo

Gets or sets the download attachment fileInfo.

dropdownOptions List<string>

Gets or sets the dropdownOptions.

isReadOnly bool?

Gets or sets a value indicating whether is read only mode.

conditionalRules List<ConditionalRule>

Gets or sets the conditionalRules.

textAlign TextAlign

Gets or sets the textAlign.

textDirection TextDirection

Gets or sets the direction of the text.

characterSpacing float

Gets or sets the space of the character.

label string

Gets or sets the label value.

timeFormat string

Gets or sets the timeFormat value..

Properties

AllowDeleteFormField

Gets or sets a value indicating whether to allow form fields to delete while sending document.

[DataMember(Name = "allowDeleteFormField", EmitDefaultValue = true)]
public bool AllowDeleteFormField { get; set; }

Property Value

bool

AllowEditFormField

Gets or sets a value indicating whether to allow form fields to edit while sending document.

[DataMember(Name = "allowEditFormField", EmitDefaultValue = true)]
public bool AllowEditFormField { get; set; }

Property Value

bool

AttachmentInfo

Gets or sets the Attachment Information. .

[DataMember(Name = "attachmentInfo", EmitDefaultValue = false)]
public AttachmentInfo AttachmentInfo { get; set; }

Property Value

AttachmentInfo

BackgroundHexColor

Gets or sets the background hex color. The BackgroundHexColor property allows you to set the background color of a label field using hexadecimal color codes ("#FF5733"). The default color is transparent or no background color. Default value is null.

[DataMember(Name = "backgroundHexColor", EmitDefaultValue = false)]
public string BackgroundHexColor { get; set; }

Property Value

string

Gets the value of backgroundColor.

Bounds

Gets or sets the bounds.

[DataMember(Name = "bounds", EmitDefaultValue = false)]
public Rectangle Bounds { get; set; }

Property Value

Rectangle

CharacterSpacing

Gets or sets the character spacing.

[DataMember(Name = "characterSpacing", EmitDefaultValue = false)]
public float CharacterSpacing { get; set; }

Property Value

float

Gets the value of character spacing.

ConditionalRules

Gets or sets the conditional rules value, this property helps to frame rules.

[DataMember(Name = "conditionalRules", EmitDefaultValue = false)]
public List<ConditionalRule> ConditionalRules { get; set; }

Property Value

List<ConditionalRule>

DataSyncTag

Gets or sets the data sync tag value, this property helps to group the similar element types and it's only applicable for textbox, image, dropdown, checkbox fields, it won't affect the other fields.

[DataMember(Name = "dataSyncTag", EmitDefaultValue = false)]
public string DataSyncTag { get; set; }

Property Value

string

DateFormat

Gets or sets the DateFormat value.

[DataMember(Name = "dateFormat", EmitDefaultValue = false)]
public string DateFormat { get; set; }

Property Value

string

Gets or sets the DateFormat value.

DropdownOptions

Gets or sets the Dropdown Options.

[DataMember(Name = "dropdownOptions", EmitDefaultValue = false)]
public List<string> DropdownOptions { get; set; }

Property Value

List<string>

EditableDateFieldSettings

Gets or sets the EditableDateFieldSettings Information. .

[DataMember(Name = "editableDateFieldSettings", EmitDefaultValue = false)]
public EditableDateFieldSettings EditableDateFieldSettings { get; set; }

Property Value

EditableDateFieldSettings

FileInfo

Gets or sets the file info.

[DataMember(Name = "fileInfo", EmitDefaultValue = false)]
public FileInfo FileInfo { get; set; }

Property Value

FileInfo

Font

Gets or sets the Font type among the three available types courier, helvetica, times new roman, carlito.

[DataMember(Name = "font", EmitDefaultValue = false)]
public string Font { get; set; }

Property Value

string

Gets or sets the element type.

FontColor

Gets or sets the font color.

[DataMember(Name = "fontColor", EmitDefaultValue = false)]
public string FontColor { get; set; }

Property Value

string

Gets or sets the font color.

FontSize

Gets or sets the font size.

[DataMember(Name = "fontSize", EmitDefaultValue = false)]
public float? FontSize { get; set; }

Property Value

float?

Gets or sets the font size.

FormulaFieldSettings

Gets or sets the formula settings.

[DataMember(Name = "formulaFieldSettings", EmitDefaultValue = false)]
public FormulaFieldSettings FormulaFieldSettings { get; set; }

Property Value

FormulaFieldSettings

GroupName

Gets or sets the group name of a radio field.

[DataMember(Name = "groupName", EmitDefaultValue = true)]
public string GroupName { get; set; }

Property Value

string

Gets or sets the name.

Hidden

Gets or sets a value indicating whether the form field is hidden.

[DataMember(Name = "hidden", EmitDefaultValue = true)]
public bool Hidden { get; set; }

Property Value

bool

HyperlinkText

Gets or sets the element HyperlinkText.

[DataMember(Name = "hyperlinkText", EmitDefaultValue = false)]
public string HyperlinkText { get; set; }

Property Value

string

Gets the value of element HyperlinkText.

Id

Gets or sets the Id.

[DataMember(Name = "id", EmitDefaultValue = false)]
public string Id { get; set; }

Property Value

string

Gets or sets the id.

ImageInfo

Gets or sets the Image Information. .

[DataMember(Name = "imageInfo", EmitDefaultValue = false)]
public ImageInfo ImageInfo { get; set; }

Property Value

ImageInfo

IsBold

Gets or sets a value indicating whether isBold.

[DataMember(Name = "isBold", EmitDefaultValue = false)]
public bool? IsBold { get; set; }

Property Value

bool?

Gets or sets a value indicating whether isBold.

IsItalic

Gets or sets a value indicating whether isItalic.

[DataMember(Name = "isItalic", EmitDefaultValue = false)]
public bool? IsItalic { get; set; }

Property Value

bool?

Gets or sets a value indicating whether isItalic.

IsReadOnly

Gets or sets a value indicating whether is read only mode.

[DataMember(Name = "isReadOnly", EmitDefaultValue = false)]
public bool? IsReadOnly { get; set; }

Property Value

bool?

Gets or sets a value indicating whether is read only mode.

IsRequired

Gets or sets a value indicating whether is required.

[DataMember(Name = "isRequired", EmitDefaultValue = false)]
public bool? IsRequired { get; set; }

Property Value

bool?

Gets or sets a value indicating whether is required.

IsUnderline

Gets or sets a value indicating whether isUnderline.

[DataMember(Name = "isUnderline", EmitDefaultValue = false)]
public bool? IsUnderline { get; set; }

Property Value

bool?

Gets or sets a value indicating whether isUnderline.

Label

Gets or sets the Label for radio button fields.

[DataMember(Name = "label", EmitDefaultValue = true)]
public string Label { get; set; }

Property Value

string

LineHeight

Gets or sets the line height for the content in form fields such as text box.

[DataMember(Name = "lineHeight", EmitDefaultValue = false)]
public float? LineHeight { get; set; }

Property Value

float?

Gets or sets the line height.

PageNumber

Gets or sets the pageNumber.

[DataMember(Name = "pageNumber", EmitDefaultValue = false)]
public int PageNumber { get; set; }

Property Value

int

Placeholder

Gets or sets the placeHolder value.

[DataMember(Name = "placeholder", EmitDefaultValue = false)]
public string Placeholder { get; set; }

Property Value

string

Gets or sets the element type.

ResizeOption

Gets or sets the resize option.

[DataMember(Name = "resizeOption", EmitDefaultValue = true)]
public ResizeOptions? ResizeOption { get; set; }

Property Value

ResizeOptions?

TabIndex

Gets or sets the tab index position .

[DataMember(Name = "tabIndex", EmitDefaultValue = true)]
public int TabIndex { get; set; }

Property Value

int

TextAlign

Gets or sets the textAlign.

[DataMember(Name = "textAlign", EmitDefaultValue = true)]
public TextAlign TextAlign { get; set; }

Property Value

TextAlign

TextDirection

Gets or sets the direction of the text.

[DataMember(Name = "textDirection", EmitDefaultValue = true)]
public TextDirection TextDirection { get; set; }

Property Value

TextDirection

TimeFormat

Gets or sets the TimeFormat value.

[DataMember(Name = "timeFormat", EmitDefaultValue = false)]
public string TimeFormat { get; set; }

Property Value

string

Gets the value of TimeFormat.

Type

Gets or sets the element type.

[DataMember(Name = "type", EmitDefaultValue = false)]
public string Type { get; set; }

Property Value

string

Gets or sets the element type.

ValidationCustomRegex

Gets or sets the text ValidationCustomRegex value.

[DataMember(Name = "validationCustomRegex", EmitDefaultValue = false)]
public string ValidationCustomRegex { get; set; }

Property Value

string

ValidationCustomRegexMessage

Gets or sets the text ValidationCustomRegexMessage value.

[DataMember(Name = "validationCustomRegexMessage", EmitDefaultValue = false)]
public string ValidationCustomRegexMessage { get; set; }

Property Value

string

ValidationType

Gets or sets the textbox ValidationType value.

[DataMember(Name = "validationType", EmitDefaultValue = false)]
public ValidationType ValidationType { get; set; }

Property Value

ValidationType

Value

Gets or sets the element type.

[DataMember(Name = "value", EmitDefaultValue = false)]
public string Value { get; set; }

Property Value

string

Gets or sets the element type.

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object