Class CustomFormField

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

Inheritance
System.Object
CustomFormField
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class CustomFormField : object

Constructors

| Improve this Doc View Source

CustomFormField(FieldType, String, String, Nullable<Boolean>, Int32, Nullable<Single>, Nullable<Single>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, String, ValidationType, String, String, ImageInfo, AttachmentInfo, EditableDateFieldSettings, String, String, List<String>, Nullable<Boolean>, TextAlign, TextDirection, Nullable<Single>, Nullable<Single>, Single)

Initializes a new instance of the CustomFormField class.

Declaration
public CustomFormField(FieldType type = (FieldType)0, string value = null, string font = null, bool? isRequired = null, int characterLimit = null, 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 = null)
Parameters
Type Name Description
FieldType type

Gets or sets the element type..
System.String value

Gets or sets the element type..
System.String font

Gets or sets the element type..
System.Nullable<System.Boolean> isRequired

Gets or sets a value indicating whether is required..
System.Int32 characterLimit

Gets or sets the character limit..
System.Nullable<System.Single> lineHeight

Gets or sets the line height..
System.Nullable<System.Single> fontSize

Gets or sets the font size..
System.String fontHexColor

Gets or sets the font hex color..
System.Nullable<System.Boolean> isUnderLineFont

Gets or sets a value indicating whether is Underline font..
System.Nullable<System.Boolean> isItalicFont

Gets or sets a value indicating whether is Italic font..
System.Nullable<System.Boolean> isBoldFont

Gets or sets a value indicating whether isBold font..
System.String placeholder

Gets or sets the placeHolder value..
System.String dateFormat

Gets or sets the dateFormat value..
ValidationType validationType

Gets or sets the textbox ValidationType value..
System.String validationCustomRegex

Gets or sets the textbox ValidationCustomRegex value..
System.String validationCustomRegexMessage

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.
System.String hyperlinkText

Gets or sets the hyperlinkText.
System.String dataSyncTag

Gets or sets the dataSyncTag.
List<System.String> dropdownOptions

Gets or sets the dropdownOptions.
System.Nullable<System.Boolean> isReadOnly

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.
System.Nullable<System.Single> width

Gets or sets the width.
System.Nullable<System.Single> height

Gets or sets the height.
System.Single characterSpacing

Gets or sets the space of the character.

Properties

| Improve this Doc View Source

AttachmentInfo

Gets or sets the Attachment Information. .

Declaration
public AttachmentInfo AttachmentInfo { get; set; }
Property Value
Type Description
AttachmentInfo
| Improve this Doc View Source

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.

Declaration
public string BackgroundHexColor { get; set; }
Property Value
Type Description
System.String

Gets the value of background hex Color.
| Improve this Doc View Source

CharacterLimit

Gets or sets the character limit.

Declaration
public int CharacterLimit { get; set; }
Property Value
Type Description
System.Int32

Gets or sets the line height.
| Improve this Doc View Source

CharacterSpacing

Gets or sets the character spacing.

Declaration
public float CharacterSpacing { get; set; }
Property Value
Type Description
System.Single

Gets the value of character spacing.
| Improve this Doc View Source

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.

Declaration
public string DataSyncTag { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DateFormat

Gets or sets the DateFormat value.

Declaration
public string DateFormat { get; set; }
Property Value
Type Description
System.String

Gets or sets the DateFormat value.
| Improve this Doc View Source

DropdownOptions

Gets or sets the Dropdown Options.

Declaration
public List<string> DropdownOptions { get; set; }
Property Value
Type Description
List<System.String>
| Improve this Doc View Source

EditableDateFieldSettings

Gets or sets the EditableDateFieldSettings Information. .

Declaration
public EditableDateFieldSettings EditableDateFieldSettings { get; set; }
Property Value
Type Description
EditableDateFieldSettings
| Improve this Doc View Source

Font

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

Declaration
public string Font { get; set; }
Property Value
Type Description
System.String

Gets or sets the element type.
| Improve this Doc View Source

FontHexColor

Gets or sets the font color.

Declaration
public string FontHexColor { get; set; }
Property Value
Type Description
System.String

Gets or sets the font color.
| Improve this Doc View Source

FontSize

Gets or sets the font size.

Declaration
public float? FontSize { get; set; }
Property Value
Type Description
System.Nullable<System.Single>

Gets or sets the font size.
| Improve this Doc View Source

Height

Gets or sets the height.

Declaration
public float? Height { get; set; }
Property Value
Type Description
System.Nullable<System.Single>
| Improve this Doc View Source

HyperlinkText

Gets or sets the element HyperlinkText.

Declaration
public string HyperlinkText { get; set; }
Property Value
Type Description
System.String

Gets the value of element HyperlinkText.
| Improve this Doc View Source

IdPrefix

Gets or sets the id format.

Declaration
public string IdPrefix { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ImageInfo

Gets or sets the Image Information. .

Declaration
public ImageInfo ImageInfo { get; set; }
Property Value
Type Description
ImageInfo
| Improve this Doc View Source

IsBoldFont

Gets or sets a value indicating whether isBold.

Declaration
public bool? IsBoldFont { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets or sets a value indicating whether isBold.
| Improve this Doc View Source

IsItalicFont

Gets or sets a value indicating whether isItalic.

Declaration
public bool? IsItalicFont { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets or sets a value indicating whether isItalic.
| Improve this Doc View Source

IsReadOnly

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

Declaration
public bool? IsReadOnly { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets or sets a value indicating whether is read only mode.
| Improve this Doc View Source

IsRequired

Gets or sets a value indicating whether is required.

Declaration
public bool? IsRequired { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets or sets a value indicating whether is required.
| Improve this Doc View Source

IsUnderLineFont

Gets or sets a value indicating whether isUnderline.

Declaration
public bool? IsUnderLineFont { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Gets or sets a value indicating whether isUnderline.
| Improve this Doc View Source

LineHeight

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

Declaration
public float? LineHeight { get; set; }
Property Value
Type Description
System.Nullable<System.Single>

Gets or sets the line height.
| Improve this Doc View Source

Placeholder

Gets or sets the placeHolder value.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

Gets or sets the element type.
| Improve this Doc View Source

RestrictIdPrefixChange

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

Declaration
public bool RestrictIdPrefixChange { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

TextAlign

Gets or sets the textAlign.

Declaration
public TextAlign TextAlign { get; set; }
Property Value
Type Description
TextAlign
| Improve this Doc View Source

TextDirection

Gets or sets the direction of the text.

Declaration
public TextDirection TextDirection { get; set; }
Property Value
Type Description
TextDirection
| Improve this Doc View Source

TimeFormat

Gets or sets the time format value.

Declaration
public string TimeFormat { get; set; }
Property Value
Type Description
System.String

Gets or sets the value of the time format.
| Improve this Doc View Source

Type

Gets or sets the element type.

Declaration
public FieldType Type { get; set; }
Property Value
Type Description
FieldType

Gets or sets the element type.
| Improve this Doc View Source

ValidationCustomRegex

Gets or sets the text ValidationCustomRegex value.

Declaration
public string ValidationCustomRegex { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ValidationCustomRegexMessage

Gets or sets the text ValidationCustomRegexMessage value.

Declaration
public string ValidationCustomRegexMessage { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ValidationType

Gets or sets the textbox ValidationType value.

Declaration
public ValidationType ValidationType { get; set; }
Property Value
Type Description
ValidationType
| Improve this Doc View Source

Value

Gets or sets the element type.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

Gets or sets the element type.
| Improve this Doc View Source

Width

Gets or sets the width.

Declaration
public float? Width { get; set; }
Property Value
Type Description
System.Nullable<System.Single>

Methods

| Improve this Doc View Source

ToJson()

Returns the JSON string presentation of the object

Declaration
public virtual string ToJson()
Returns
Type Description
System.String

JSON string presentation of the object