Class TextTagDefinition
The text tag model.
Inheritance
Namespace: BoldSign.Api.Model
Assembly: BoldSign.Api.dll
Syntax
public class TextTagDefinition : object
Constructors
| Improve this Doc View SourceTextTagDefinition(String, FieldType, Int32, Boolean, String, String, Font, Validation, Size, String, String, String, List<String>, ImageInfo, String, AttachmentInfo, String)
Initializes a new instance of the TextTagDefinition class.
Declaration
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
Type | Name | Description |
---|---|---|
System.String | definitionId | Gets or sets the definitionId. (required). |
FieldType | type | Gets or sets the type. (required). |
System.Int32 | signerIndex | Gets or sets the signerIndex. |
System.Boolean | isRequired | Gets or sets the isRequired. |
System.String | placeholder | Gets or sets the placeholder for textbox. |
System.String | fieldId | Gets or sets a fieldId. |
Font | font | font. |
Validation | validation | Gets or sets the validation. |
Size | size | Gets or sets the bounds. |
System.String | dateFormat | Gets or sets the dateFormat. |
System.String | radioGroupName | Gets or sets the radioGroupName. |
System.String | value | The form field value, applicable only for label and textbox fields. |
List<System.String> | dropdownOptions | Fets or sets the dropdown Options. |
ImageInfo | imageInfo | Gets or sets the imageInfo. |
System.String | hyperlinkText | Gets or sets the hyperlinkText. |
AttachmentInfo | attachmentInfo | Gets or sets the attachmentInfo. |
System.String | timeFormat | Gets or sets the timeFormat. |
Properties
| Improve this Doc View SourceAttachmentInfo
Gets or sets the attachment info.
Declaration
public AttachmentInfo AttachmentInfo { get; set; }
Property Value
Type | Description |
---|---|
AttachmentInfo |
DateFormat
Gets or sets DateFormat.
Declaration
public string DateFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DefinitionId
Gets or sets DefinitionId.
Declaration
public string DefinitionId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DropdownOptions
Gets or sets dropdown options.
Declaration
public List<string> DropdownOptions { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
FieldId
Gets or sets FieldId.
Declaration
public string FieldId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Font
Gets or sets Font.
Declaration
public Font Font { get; set; }
Property Value
Type | Description |
---|---|
Font |
HyperlinkText
Gets or sets the HyperlinkText.
Declaration
public string HyperlinkText { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ImageInfo
Gets or sets the image info.
Declaration
public ImageInfo ImageInfo { get; set; }
Property Value
Type | Description |
---|---|
ImageInfo |
IsRequired
Gets or sets a value indicating whether field is required.
Declaration
public bool IsRequired { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Label
Gets or sets the label.
Declaration
public string Label { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Placeholder
Gets or sets placeholder for textbox.
Declaration
public string Placeholder { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RadioGroupName
Gets or sets RadioGroupName.
Declaration
public string RadioGroupName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SignerIndex
Gets or sets SignerIndex.
Declaration
public int SignerIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Size
Gets or sets Bounds.
Declaration
public Size Size { get; set; }
Property Value
Type | Description |
---|---|
Size |
TabIndex
Gets or sets the Tab Index.
Declaration
public int? TabIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
TimeFormat
Gets or sets timeFormat.
Declaration
public string TimeFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Type
Gets or sets Type.
Declaration
public FieldType Type { get; set; }
Property Value
Type | Description |
---|---|
FieldType |
Validation
Gets or sets Validation.
Declaration
public Validation Validation { get; set; }
Property Value
Type | Description |
---|---|
Validation |
Value
Gets or sets value for the text tag definition. The value property is allowed only on the textbox and label fields.
Declaration
public string Value { get; set; }
Property Value
Type | Description |
---|---|
System.String |