Class FormField

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

Inheritance
System.Object
FormField
DateSignedField
DropdownField
RadioButtonField
TextBoxField
Implements
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class FormField : object, IFormField

Constructors

| Improve this Doc View Source

FormField()

Initializes a new instance of the FormField class.

Declaration
protected FormField()
| Improve this Doc View Source

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

Initializes a new instance of the FormField class.

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

fieldType (required).
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 hyperlinkText

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

FormField(String, FieldType, Int32, Rectangle, Boolean, String, FontFamily, Int32, String, Boolean, Boolean, Boolean, Int32, Int32, String)

Initializes a new instance of the FormField class.

Declaration
public FormField(string name = null, FieldType type = (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 dataSyncTag = null)
Parameters
Type Name Description
System.String name

Gets or sets the name..
FieldType type

fieldType (required).
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
System.Int32 fontSize
System.String fontHexColor
System.Boolean isBoldFont
System.Boolean isItalicFont
System.Boolean isUnderLineFont
System.Int32 lineHeight
System.Int32 characterLimit
System.String dataSyncTag

Gets or sets the dataSyncTag.

Fields

| Improve this Doc View Source

m_type

Declaration
protected FieldType m_type
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 or sets the Backgroundcolor Value.
| 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 space of the character.

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

Gets or sets the characterSpacing.
| 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, 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

Gets or sets the DataSyncTag.
| 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 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

HyperlinkText

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

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

Gets or sets the HyperlinkText.
| 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

Declaration
public bool IsItalicFont { get; set; }
Property Value
Type Description
System.Boolean
| 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 wherther is read only mode.
| 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

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 or sets the page number.
| Improve this Doc View Source

TabIndex

Gets or sets the Tab Index.

Declaration
public int? TabIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

TextAlign

Gets or sets the TextAlign to be set to the form field.

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

Gets or sets the 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

Gets or sets the direction of the text.
| Improve this Doc View Source

Type

Gets the form field type.

Declaration
public virtual FieldType Type { get; set; }
Property Value
Type Description
FieldType
| 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.

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

Implements