Class TemplateFormField

The template form field properties.

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

Constructors

| Improve this Doc View Source

TemplateFormField(FieldType, Int32, Rectangle, Boolean, String, FontFamily, Int32, String, Boolean, Boolean, Boolean, Int32, Int32, String, AttachmentInfo, ImageInfo, EditableDateFieldSettings, String, List<String>, String, String, ValidationType, String, String, String, Boolean, List<ConditionalRule>, TextAlign, TextDirection, Single, String, String, String, String)

Initializes a new instance of the TemplateFormField class.

Declaration
public TemplateFormField(FieldType fieldType = (FieldType)0, int pageNumber = null, Rectangle bounds = null, bool isRequired = null, string value = null, FontFamily font = default(FontFamily), int fontSize = null, string fontHexColor = null, bool isBoldFont = null, bool isItalicFont = null, bool isUnderLineFont = null, int lineHeight = null, int characterLimit = null, 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 = null, List<ConditionalRule> conditionalRules = null, TextAlign textAlign = TextAlign.Left, TextDirection textDirection = TextDirection.LTR, float characterSpacing = null, string type = null, string hyperlinkText = null, string label = null, string timeFormat = null)
Parameters
Type Name Description
FieldType fieldType

fieldType.
System.Int32 pageNumber

Gets or sets the page number. (required).
Rectangle bounds

bounds (required).
System.Boolean isRequired

Gets or sets a value indicating whether is required..
System.String value

Gets or sets the value..
FontFamily font

Gets or sets the font.
System.Int32 fontSize

Gets or sets the fontSize.
System.String fontHexColor

Gets or sets the fontHexColor.
System.Boolean isBoldFont

Gets or sets the isBoldFont.
System.Boolean isItalicFont

Gets or sets the isItalicFont.
System.Boolean isUnderLineFont

Gets or sets the isUnderLineFont.
System.Int32 lineHeight

Gets or sets the lineHeight.
System.Int32 characterLimit

Gets or sets the characterLimit.
System.String id

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

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

dropdownOptions.
System.String placeholder

placeHolder.
System.String dateFormat

Gets or sets the dateFormat..
ValidationType validationType

Gets or sets the validationType..
System.String validationCustomRegex

Gets or sets the validationCustomRegex..
System.String validationCustomRegexMessage

Gets or sets the validationCustomRegexMessage..
System.String dataSyncTag

Gets or sets the dataSyncTag.
System.Boolean isReadOnly

Gets or sets a value indicating whether is read only mode.
List<ConditionalRule> conditionalRules

Gets or sets the conditionalRules.
TextAlign textAlign

Gets or sets the textAlign.
TextDirection textDirection

Gets or sets the direction of the text.
System.Single characterSpacing

Gets or sets the space of the character.
System.String type

Gets or sets the fieldType.
System.String hyperlinkText

Gets or sets the hyperlinkText.
System.String label

Gets or sets the label value.
System.String timeFormat

Gets or sets the timeFormat.

Fields

| Improve this Doc View Source

mType

FieldType type.

Declaration
protected FieldType mType
Field Value
Type Description
FieldType

Properties

| Improve this Doc View Source

AttachmentInfo

Gets or sets the AttachmentInfo.

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

Gets or sets the Attachment Information.
| 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 backgroundColor.
| Improve this Doc View Source

Bounds

Gets or Sets bounds of the form field.

Declaration
public Rectangle Bounds { get; set; }
Property Value
Type Description
Rectangle
| 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

ConditionalRules

Gets or sets the conditional rules value, this property helps to frame rules.

Declaration
public List<ConditionalRule> ConditionalRules { get; set; }
Property Value
Type Description
List<ConditionalRule>
| Improve this Doc View Source

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.

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

Gets or sets the DataSyncTag.
| Improve this Doc View Source

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.

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

DropdownOptions

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

FieldType

Gets or sets the field type.

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

Gets the value of field type.
| Improve this Doc View Source

Font

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

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

FontHexColor

Gets or sets the font color in hex code.

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

Gets or sets the name.
| Improve this Doc View Source

FontSize

Gets or sets the font size.

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

Gets or sets the page number.
| Improve this Doc View Source

GroupName

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

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

HyperlinkText

Gets or sets the hyperlink text.

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

Gets the value of hyperlink text.
| Improve this Doc View Source

Id

Gets or Sets id in form field.

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

ImageInfo

Gets or sets the ImageInfo.

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

Gets or sets the Image Information.
| Improve this Doc View Source

IsBoldFont

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

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

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

IsItalicFont

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

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

Gets or sets a value indicating whether is required.
| 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.Boolean

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

IsRequired

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

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

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

IsUnderLineFont

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

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

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

Label

Gets or sets the Label for radio button fields.

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

LineHeight

Gets or sets the line height for the contents in form field.

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

Gets or sets the page number.
| Improve this Doc View Source

Name

Gets or sets the form field name.

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

Gets or sets the name.
| Improve this Doc View Source

PageNumber

Gets or sets the page number.

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

Gets the value of page number.
| Improve this Doc View Source

Placeholder

Gets or Sets Placeholder value.

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

TabIndex

Gets or sets the tab index position .

Declaration
public int TabIndex { get; set; }
Property Value
Type Description
System.Int32
| 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 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.

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

Type

Gets or sets the form field type.

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

ValidationCustomRegex

Gets or Sets ValidationCustomRegex.

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

ValidationCustomRegexMessage

Gets or Sets ValidationCustomRegexMessage.

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

ValidationType

Gets or Sets ValidationType.

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

Value

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

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

Gets or sets the value.