Table of Contents

Class TemplateFormField

Namespace
BoldSign.Api.Model
Assembly
BoldSign.Api.dll

The template form field properties.

[DataContract]
public class TemplateFormField
Inheritance
TemplateFormField
Inherited Members

Constructors

TemplateFormField(FieldType, int, Rectangle, bool, string, FontFamily, int, string, bool, bool, bool, int, int, string, AttachmentInfo, ImageInfo, EditableDateFieldSettings, string, List<string>, string, string, ValidationType, string, string, string, bool, List<ConditionalRule>, TextAlign, TextDirection, float, string, string, string, string)

Initializes a new instance of the TemplateFormField class.

public TemplateFormField(FieldType fieldType = (FieldType)0, int pageNumber = 0, Rectangle bounds = null, bool isRequired = false, string value = null, FontFamily font = FontFamily.Helvetica, int fontSize = 0, string fontHexColor = null, bool isBoldFont = false, bool isItalicFont = false, bool isUnderLineFont = false, int lineHeight = 0, int characterLimit = 0, string id = null, AttachmentInfo attachmentInfo = null, ImageInfo imageInfo = null, EditableDateFieldSettings editableDateFieldSettings = null, string groupName = null, List<string> dropdownOptions = null, string placeholder = null, string dateFormat = null, ValidationType validationType = (ValidationType)0, string validationCustomRegex = null, string validationCustomRegexMessage = null, string dataSyncTag = null, bool isReadOnly = false, List<ConditionalRule> conditionalRules = null, TextAlign textAlign = TextAlign.Left, TextDirection textDirection = TextDirection.LTR, float characterSpacing = 0, string type = null, string hyperlinkText = null, string label = null, string timeFormat = null)

Parameters

fieldType FieldType

fieldType.

pageNumber int

Gets or sets the page number. (required).

bounds Rectangle

bounds (required).

isRequired bool

Gets or sets a value indicating whether is required..

value string

Gets or sets the value..

font FontFamily

Gets or sets the font.

fontSize int

Gets or sets the fontSize.

fontHexColor string

Gets or sets the fontHexColor.

isBoldFont bool

Gets or sets the isBoldFont.

isItalicFont bool

Gets or sets the isItalicFont.

isUnderLineFont bool

Gets or sets the isUnderLineFont.

lineHeight int

Gets or sets the lineHeight.

characterLimit int

Gets or sets the characterLimit.

id string

Gets or sets the id.

attachmentInfo AttachmentInfo

Gets or sets the attachmentInfo.

imageInfo ImageInfo

Gets or sets the imageInfo.

editableDateFieldSettings EditableDateFieldSettings

Gets or sets the editableDateFieldSettings.

groupName string

Gets or sets the groupName.

dropdownOptions List<string>

dropdownOptions.

placeholder string

placeHolder.

dateFormat string

Gets or sets the dateFormat..

validationType ValidationType

Gets or sets the validationType..

validationCustomRegex string

Gets or sets the validationCustomRegex..

validationCustomRegexMessage string

Gets or sets the validationCustomRegexMessage..

dataSyncTag string

Gets or sets the dataSyncTag.

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.

type string

Gets or sets the fieldType.

hyperlinkText string

Gets or sets the hyperlinkText.

label string

Gets or sets the label value.

timeFormat string

Gets or sets the timeFormat.

Fields

mType

FieldType type.

protected FieldType mType

Field Value

FieldType

Properties

AttachmentInfo

Gets or sets the AttachmentInfo.

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

Property Value

AttachmentInfo

Gets or sets the Attachment Information.

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 bounds of the form field.

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

Property Value

Rectangle

CharacterLimit

Gets or sets the character limit.

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

Property Value

int

Gets or sets the line height.

CharacterSpacing

Gets or sets the character spacing.

[DataMember(Name = "characterSpacing", EmitDefaultValue = true)]
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 and it's only applicable for textbox, image, dropdown, checkbox fields, it won't affect the other fields.

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

Property Value

string

Gets or sets the DataSyncTag.

DateFormat

Gets or sets the DateFormat and it's only applicable for DateSigned field and for EditableDate field. Please use the pre-defined DateFormat. Supported formats: MM/dd/yyyy, dd/MM/yyyy, dd-MMM-yyyy, MMM-dd-yyyy, MMM dd,yyyy, dd MMM,yyyy, yyyy,MMM dd, yyyy/MM/dd, dd-MM-yyyy, MM-dd-yyyy, yyyy-MM-dd. The default value is date format specified in the business profile.

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

Property Value

string

DropdownOptions

Gets or Sets 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

FieldType

Gets or sets the field type.

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

Property Value

string

Gets the value of field type.

Font

Gets or Sets font name for the content in form field.

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

Property Value

FontFamily

FontHexColor

Gets or sets the font color in hex code.

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

Property Value

string

Gets or sets the name.

FontSize

Gets or sets the font size.

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

Property Value

int

Gets or sets the page number.

GroupName

Gets or sets the group name for the radio button field.

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

Property Value

string

HyperlinkText

Gets or sets the hyperlink text.

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

Property Value

string

Gets the value of hyperlink text.

Id

Gets or Sets id in form field.

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

Property Value

string

ImageInfo

Gets or sets the ImageInfo.

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

Property Value

ImageInfo

Gets or sets the Image Information.

IsBoldFont

Gets or sets a value indicating whether the font style is bold.

[DataMember(Name = "isBoldFont", EmitDefaultValue = false)]
public bool IsBoldFont { get; set; }

Property Value

bool

Gets or sets a value indicating whether is required.

IsItalicFont

Gets or sets a value indicating whether the font style is italic.

[DataMember(Name = "isItalicFont", EmitDefaultValue = false)]
public bool IsItalicFont { get; set; }

Property Value

bool

Gets or sets a value indicating whether is required.

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 readOnlyMode.

IsRequired

Gets or sets a value indicating whether the field is required.

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

Property Value

bool

Gets or sets a value indicating whether is required.

IsUnderLineFont

Gets or sets a value indicating whether the font style is underline.

[DataMember(Name = "isUnderLineFont", EmitDefaultValue = false)]
public bool IsUnderLineFont { get; set; }

Property Value

bool

Gets or sets a value indicating whether is required.

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 contents in form field.

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

Property Value

int

Gets or sets the page number.

Name

Gets or sets the form field name.

[Obsolete("Name is deprecated, please use Id instead")]
[DataMember(Name = "name", EmitDefaultValue = true)]
public string Name { get; set; }

Property Value

string

Gets or sets the name.

PageNumber

Gets or sets the page number.

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

Property Value

int

Gets the value of page number.

Placeholder

Gets or Sets Placeholder value.

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

Property Value

string

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 and it's only applicable for DateSigned field. Please use the pre-defined TimeFormat. Supported formats: hh:mm tt, h:mm tt, HH:mm, H:mm. The default value is time format specified in the business profile.

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

Property Value

string

Type

Gets or sets the form field type.

[DataMember(Name = "fieldType", EmitDefaultValue = true)]
[Obsolete("Type is deprecated, please use FieldType instead.")]
public virtual FieldType Type { get; set; }

Property Value

FieldType

ValidationCustomRegex

Gets or Sets ValidationCustomRegex.

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

Property Value

string

ValidationCustomRegexMessage

Gets or Sets ValidationCustomRegexMessage.

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

Property Value

string

ValidationType

Gets or Sets ValidationType.

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

Property Value

ValidationType

Value

Gets or sets the Value to be set to the form field (if required).

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

Property Value

string

Gets or sets the value.