Class FormField

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

The form field properties include character limit, font, font size, and so on.

[DataContract]
public class FormField : IFormField

Inheritance

object

FormField

Implements

IFormField

Derived

DateSignedField

DropdownField

RadioButtonField

TextBoxField

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FormField()

Initializes a new instance of the FormField class.

[JsonConstructor]
protected FormField()

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

Initializes a new instance of the FormField class.

public FormField(FieldType type = (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 hyperlinkText = null, string dataSyncTag = null, bool isReadOnly = false, List<ConditionalRule> conditionalRules = null, TextAlign textAlign = TextAlign.Left, TextDirection textDirection = TextDirection.LTR, float characterSpacing = 0)

Parameters

type FieldType

fieldType (required).

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.

hyperlinkText string

Gets or sets the hyperlinkText.

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.

FormField(string, FieldType, int, Rectangle, bool, string, FontFamily, int, string, bool, bool, bool, int, int, string)

Initializes a new instance of the FormField class.

[Obsolete("Name is deprecated, please use Id instead")]
public FormField(string name = null, FieldType type = (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 dataSyncTag = null)

Parameters

name string

Gets or sets the name..

type FieldType

fieldType (required).

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

fontSize int

fontHexColor string

isBoldFont bool

isItalicFont bool

isUnderLineFont bool

lineHeight int

characterLimit int

dataSyncTag string

Gets or sets the dataSyncTag.

Fields

m_type

protected FieldType m_type

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 = true)]
public string BackgroundHexColor { get; set; }

Property Value

string

Gets or sets the Backgroundcolor Value.

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 space of the character.

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

Property Value

float

Gets or sets the characterSpacing.

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 = true)]
public string DataSyncTag { get; set; }

Property Value

string

Gets or sets the DataSyncTag.

EditableDateFieldSettings

Gets or sets the EditableDateFieldSettings Information. .

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

Property Value

EditableDateFieldSettings

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.

HyperlinkText

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

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

Property Value

string

Gets or sets the HyperlinkText.

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

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

Property Value

bool

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 wherther is read only mode.

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.

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 or sets the page number.

TabIndex

Gets or sets the Tab Index.

[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 TextAlign to be set to the form field.

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

Property Value

TextAlign

Gets or sets the TextAlign.

TextDirection

Gets or sets the direction of the text.

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

Property Value

TextDirection

Gets or sets the direction of the text.

Type

Gets the form field type.

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

Property Value

FieldType

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.

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object