Class TextTagDefinition

Namespace

BoldSign.Api.Model

Assembly

BoldSign.Api.dll

The text tag model.

public class TextTagDefinition

Inheritance

object

TextTagDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TextTagDefinition(string, FieldType, int, bool, string, string, Font, Validation, Size, string, string, string, List<string>, ImageInfo, string, AttachmentInfo, string)

Initializes a new instance of the TextTagDefinition class.

public TextTagDefinition(string definitionId, FieldType type, int signerIndex, bool isRequired, string placeholder = null, string fieldId = null, Font font = null, Validation validation = null, Size size = null, string dateFormat = null, string radioGroupName = null, string value = null, List<string> dropdownOptions = null, ImageInfo imageInfo = null, string hyperlinkText = null, AttachmentInfo attachmentInfo = null, string timeFormat = null)

Parameters

definitionId string

Gets or sets the definitionId. (required).

type FieldType

Gets or sets the type. (required).

signerIndex int

Gets or sets the signerIndex.

isRequired bool

Gets or sets the isRequired.

placeholder string

Gets or sets the placeholder for textbox.

fieldId string

Gets or sets a fieldId.

font Font

font.

validation Validation

Gets or sets the validation.

size Size

Gets or sets the bounds.

dateFormat string

Gets or sets the dateFormat.

radioGroupName string

Gets or sets the radioGroupName.

value string

The form field value, applicable only for label and textbox fields.

dropdownOptions List<string>

Fets or sets the dropdown Options.

imageInfo ImageInfo

Gets or sets the imageInfo.

hyperlinkText string

Gets or sets the hyperlinkText.

attachmentInfo AttachmentInfo

Gets or sets the attachmentInfo.

timeFormat string

Gets or sets the timeFormat.

Properties

AttachmentInfo

Gets or sets the attachment info.

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

Property Value

AttachmentInfo

DateFormat

Gets or sets DateFormat.

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

Property Value

string

DefinitionId

Gets or sets DefinitionId.

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

Property Value

string

DropdownOptions

Gets or sets dropdown options.

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

Property Value

List<string>

FieldId

Gets or sets FieldId.

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

Property Value

string

Font

Gets or sets Font.

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

Property Value

Font

HyperlinkText

Gets or sets the HyperlinkText.

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

Property Value

string

ImageInfo

Gets or sets the image info.

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

Property Value

ImageInfo

IsRequired

Gets or sets a value indicating whether field is required.

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

Property Value

bool

Label

Gets or sets the label.

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

Property Value

string

Placeholder

Gets or sets placeholder for textbox.

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

Property Value

string

RadioGroupName

Gets or sets RadioGroupName.

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

Property Value

string

SignerIndex

Gets or sets SignerIndex.

[Range(1, 50)]
[DataMember(Name = "signerIndex", EmitDefaultValue = false)]
public int SignerIndex { get; set; }

Property Value

int

Size

Gets or sets Bounds.

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

Property Value

Size

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?

TimeFormat

Gets or sets timeFormat.

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

Property Value

string

Type

Gets or sets Type.

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

Property Value

FieldType

Validation

Gets or sets Validation.

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

Property Value

Validation

Value

Gets or sets value for the text tag definition. The value property is allowed only on the textbox and label fields.

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

Property Value

string