Table of Contents

Class EditFormField

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

The edit form fields request.

[DataContract]
public class EditFormField
Inheritance
EditFormField
Inherited Members

Properties

AllowDeleteFormField

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

[DataMember(Name = "allowDeleteFormField", EmitDefaultValue = false)]
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 = false)]
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 background hex color 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

Bounds

Gets or sets the bounds.

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

Property Value

Rectangle

CharacterLimit

Gets or sets the character limit.

[DataMember(Name = "characterLimit", EmitDefaultValue = false)]
[Range(0, 2147483647, ErrorMessage = "CharacterLimit should be greater than zero.")]
public int? CharacterLimit { get; set; }

Property Value

int?

CharacterSpacing

Gets or sets the space of the character.

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

Property Value

float?

ConditionalRules

Gets or sets the conditional rules value, this property helps to frame rules for checkbox and radiobutton.

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

Property Value

IEnumerable<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 field, 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 date format, and it's only applicable for DateSigned field and EditableDate field. Please use the pre-defined date format. 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 the dropdown options.

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

Property Value

string[]

EditAction

Gets or sets the edit action to be performed.

[Required]
[DataMember(Name = "editAction", EmitDefaultValue = false)]
public EditAction? EditAction { get; set; }

Property Value

EditAction?

EditableDateFieldSettings

Gets or sets the editable date field settings information.

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

Property Value

EditableDateFieldSettings

Font

Gets or sets the font family.

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

Property Value

FontFamily?

FontHexColor

Gets or sets the font hex color.

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

Property Value

string

FontSize

Gets or sets the font size.

[DataMember(Name = "fontSize", EmitDefaultValue = false)]
[Range(0, 3.4028234663852886E+38, ErrorMessage = "FontSize should be greater than zero.")]
public float? FontSize { get; set; }

Property Value

float?

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 for radio button fields.

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

Property Value

string

HyperlinkText

Gets or sets the hyperlink text.

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

Property Value

string

Id

Gets or sets the form field id.

[DataMember(Name = "id", EmitDefaultValue = false)]
public string Id { 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 is bold font.

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

Property Value

bool?

IsItalicFont

Gets or sets a value indicating whether is italic font.

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

Property Value

bool?

IsMasked

Gets or sets a value indicating whether is masked text value.

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

Property Value

bool?

IsReadOnly

Gets or sets a value indicating whether is read only.

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

Property Value

bool?

IsRequired

Gets or sets a value indicating whether is required.

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

Property Value

bool?

IsUnderLineFont

Gets or sets a value indicating whether is underline font.

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

Property Value

bool?

Label

Gets or sets the label for radio button fields.

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

Property Value

string

LineHeight

Gets or sets the line height.

[DataMember(Name = "lineHeight", EmitDefaultValue = false)]
[Range(0, 2147483647, ErrorMessage = "LineHeight should be greater than zero.")]
public int? LineHeight { get; set; }

Property Value

int?

Name

Gets or sets the form field name.

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

Property Value

string

PageNumber

Gets or sets the page number.

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

Property Value

int?

PlaceHolder

Gets or sets the placeholder text for text box.

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

Property Value

string

ResizeOption

Gets or sets the resize option.

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

Property Value

ResizeOptions?

TabIndex

Gets or sets a value of tabIndex.

[DataMember(Name = "tabIndex", EmitDefaultValue = false)]
[Range(-1, 2147483647, ErrorMessage = "The minimum value must be -1 or higher")]
public int? TabIndex { get; set; }

Property Value

int?

TextAlign

Gets or sets the text align.

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

Property Value

TextAlign?

TextDirection

Gets or sets the direction of the text.

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

Property Value

TextDirection?

TimeFormat

Gets or sets the time format.

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

Property Value

string

Type

Gets or sets the type.

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

Property Value

FieldType?

ValidationCustomRegex

Gets or sets the validation custom regex, and it's applicable only to text box field.

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

Property Value

string

ValidationCustomRegexMessage

Gets or sets the validation custom regex message, and it's applicable only to text box field.

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

Property Value

string

ValidationType

Gets or sets the validation type, and it's applicable only to text box field.

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

Property Value

ValidationType?

Value

Gets or sets the value.

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

Property Value

string