Table of Contents

Class CustomFormField

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

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

[DataContract]
public class CustomFormField
Inheritance
CustomFormField
Inherited Members

Constructors

CustomFormField(FieldType, string, string, bool?, int, float?, float?, string, bool?, bool?, bool?, string, string, ValidationType, string, string, ImageInfo, AttachmentInfo, EditableDateFieldSettings, string, string, List<string>, bool?, TextAlign, TextDirection, float?, float?, float)

Initializes a new instance of the CustomFormField class.

public CustomFormField(FieldType type = (FieldType)0, string value = null, string font = null, bool? isRequired = null, int characterLimit = 0, float? lineHeight = null, float? fontSize = null, string fontHexColor = null, bool? isUnderLineFont = null, bool? isItalicFont = null, bool? isBoldFont = 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, List<string> dropdownOptions = null, bool? isReadOnly = null, TextAlign textAlign = TextAlign.Left, TextDirection textDirection = TextDirection.LTR, float? width = null, float? height = null, float characterSpacing = 0)

Parameters

type FieldType

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

characterLimit int

Gets or sets the character limit..

lineHeight float?

Gets or sets the line height..

fontSize float?

Gets or sets the font size..

fontHexColor string

Gets or sets the font hex color..

isUnderLineFont bool?

Gets or sets a value indicating whether is Underline font..

isItalicFont bool?

Gets or sets a value indicating whether is Italic font..

isBoldFont bool?

Gets or sets a value indicating whether isBold font..

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.

dropdownOptions List<string>

Gets or sets the dropdownOptions.

isReadOnly bool?

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

textAlign TextAlign

Gets or sets the textAlign.

textDirection TextDirection

Gets or sets the direction of the text.

width float?

Gets or sets the width.

height float?

Gets or sets the height.

characterSpacing float

Gets or sets the space of the character.

Properties

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 background hex Color.

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 = false)]
public float CharacterSpacing { get; set; }

Property Value

float

Gets the value of character spacing.

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

Font

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

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

Property Value

string

Gets or sets the element type.

FontHexColor

Gets or sets the font color.

[DataMember(Name = "fontHexColor", EmitDefaultValue = false)]
public string FontHexColor { 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.

Height

Gets or sets the height.

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

Property Value

float?

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.

IdPrefix

Gets or sets the id format.

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

Property Value

string

ImageInfo

Gets or sets the Image Information. .

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

Property Value

ImageInfo

IsBoldFont

Gets or sets a value indicating whether isBold.

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

Property Value

bool?

Gets or sets a value indicating whether isBold.

IsItalicFont

Gets or sets a value indicating whether isItalic.

[DataMember(Name = "isItalicFont", EmitDefaultValue = false)]
public bool? IsItalicFont { 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.

IsUnderLineFont

Gets or sets a value indicating whether isUnderline.

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

Property Value

bool?

Gets or sets a value indicating whether isUnderline.

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.

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.

RestrictIdPrefixChange

Gets or sets a value indicating whether gets or sets the value indicating whether change id format.

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

Property Value

bool

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 time format value.

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

Property Value

string

Gets or sets the value of the time format.

Type

Gets or sets the element type.

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

Property Value

FieldType

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.

Width

Gets or sets the width.

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

Property Value

float?

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object