FormTextData Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents a form related data associated with the parent FormText field within the document.

• C#
• VB.NET

public sealed class FormTextData : FormFieldData

Public NotInheritable Class FormTextData
    Inherits FormFieldData

Inheritance:

System.Object

FormFieldData

FormTextData

Properties

DefaultValue

Gets or sets the default string for the parent text box form field.

• C#
• VB.NET

public string DefaultValue { get; set; }

Public Property DefaultValue As String

Property Value

System.String

The default string for the parent text box form field.

Remarks

This string is the content which shall be displayed in the document story within this form field if its current run contents are empty (i.e. there is not actual content within the text box). If the TextType of the current form field is Calculation, then this string shall hold the calculation to be performed.

MaximumLength

Gets or sets the maximum length of text which should be allowed within the parent text box form field before any formatting specified by the ValueFormat property. Default value is System.Int32.MaxValue (unlimited).

• C#
• VB.NET

public int MaximumLength { get; set; }

Public Property MaximumLength As Integer

Property Value

System.Int32

The maximum length of text which should be allowed within the parent text box form field before any formatting specified by the ValueFormat property.

TextType

Gets or sets the type of the contents of the current text box form field. Default value is RegularText.

• C#
• VB.NET

public FormTextType TextType { get; set; }

Public Property TextType As FormTextType

Property Value

FormTextType

The type of the contents of the current text box form field.

Value

Gets or sets the current value for a text form field.

• C#
• VB.NET

public object Value { get; set; }

Public Property Value As Object

Property Value

System.Object

The current value for a text form field.

ValueFormat

Gets or sets the field formatting which shall be applied to the contents of the parent form field whenever those contents are modified.

• C#
• VB.NET

public string ValueFormat { get; set; }

Public Property ValueFormat As String

Property Value

System.String

The field formatting which shall be applied to the contents of the parent form field whenever those contents are modified.

Inherited Properties

CalculateOnExit	Gets or sets a value indicating whether the content of all fields within the document shall be recalculated from their field codes when the content of the parent form field is modified. (Inherited from FormFieldData)
Enabled	Gets or sets a value indicating whether the parent form field shall behave as though it is enabled or disabled when it is displayed in the document. Default value is true. (Inherited from FormFieldData)
EntryMacro	Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is entered. (Inherited from FormFieldData)
ExitMacro	Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is exited. (Inherited from FormFieldData)
Field	Gets the parent form field. (Inherited from FormFieldData)
HelpText	Gets or sets the optional help text which shall be associated with the parent form field. (Inherited from FormFieldData)
IsHelpTextAutoEntry	Gets or sets a value indicating whether HelpText should be interpreted as the name of a glossary document entry whose contents contain the help text. (Inherited from FormFieldData)
IsStatusTextAutoEntry	Gets or sets a value indicating whether StatusText should be interpreted as the name of a glossary document entry whose contents contain the status text. (Inherited from FormFieldData)
Name	Gets or sets the name of the form field. (Inherited from FormFieldData)
StatusText	Gets or sets the optional status text which shall be associated with the parent form field. (Inherited from FormFieldData)
ValueOrDefault	Gets the value of this form field explicitly set by the user or default value, if value was not explicitly set. Type of the value depends on form field type as explained in remarks. (Inherited from FormFieldData)

Inherited Methods

Reset()	Resets the Value of this form field instance. (Inherited from FormFieldData)
ToString()	Returns a System.String that represents this FormFieldData instance. (Inherited from FormFieldData)

Examples

Update Word Form Controls in C# and VB.NET

Read Word Form Controls in C# and VB.NET

Create Word Form Controls in C# and VB.NET