| Name | Description | |
|---|---|---|
 | TextField Constructor | Initializes a new instance of the TextField class. |
The following tables list the members exposed by TextField.
| Name | Description | |
|---|---|---|
| TextField Constructor | Initializes a new instance of the TextField class. |
| Name | Description | |
|---|---|---|
 | AcroForm | Gets the AcroForm that owns this object. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ActualJustification | Gets the actual justification to be used when displaying the field’s text. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| AlternateName | Gets or sets an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| CalculationIndex | Gets or sets an index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices.
If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection. Field.TriggerEvents.RecalculateValue can be used to specify JavaScript that is used to calculate the field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Children | Gets the list of child fields. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| DefaultStyleString | Gets or sets the default style string used when the field value is specified using RichTextValue. See PDF specification for details.
Note that GcPdf does not automatically regenerates appearance streams for text fields containing RTF text. |
| DefaultValue | Gets or sets the default value of this TextField, applied when the field is reset. |
| Doc | Gets the GrapeCity.Documents.Pdf.GcPdfDocument owning this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Events | Gets the Field.TriggerEvents object defining events of this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Export | Gets or sets a value indicating whether the field must not be exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| GcProps | Gets the GrapeCity.Documents.Pdf.Spec.PdfDict object that can be used to associate arbitrary data with this field.
Note that for text values, in most cases the GrapeCity.Documents.Pdf.Spec.PdfString type should be used rather than System.String. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| HasGcProps | Gets a value indicating whether the GcProps is not empty (i.e. whether this filed has any associated custom properties). (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Justification | Gets or sets the justification to be used in displaying the field’s text.
Note that this field is used only if GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation.Justification is not specified. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| MappingName | Gets or sets the mapping name to be used when exporting interactive form field data from the document. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| MaxLen | Gets or sets the maximum length of the field’s text, in characters. |
| Multiline | Gets or sets a value indicating whether the field can contain multiple lines of text. |
| Name | Gets or sets the field's name. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ObjID | Gets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| Owner | Gets the FieldCollection containing this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Parent | Gets the parent field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Password | Gets or sets a value indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen. |
| PdfDefaultValue | Gets or sets the default field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| PdfDict | Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper) |
| PdfObject | Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>) |
| PdfValue | Gets or sets the field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ReadOnly | Gets or sets a value indicating whether the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Required | Gets or sets a value indicating whether the field must have a value at the time it is exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| RichText | Gets or sets a value indicating whether the value of this field should be represented as a rich text string. |
| RichTextValue | Gets or sets the rich text to be displayed in the TextField. This text can be formatted using HTML tags, see PDF specification for details.
Note that GcPdf does not automatically regenerates appearance streams for text fields containing RTF text. |
| Scrollable | Gets or sets a value indicating whether the field is scrollable to accommodate more text than fits within its annotation rectangle. |
| SpellCheck | Gets or sets a value indicating whether the text entered in the field is spell-checked. |
| UserData | Gets or sets arbitrary data associated with the current field.
Note that this data is runtime only and is not persisted in the PDF. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Value | Gets or sets the value of TextField. |
| Widget | Gets the GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation defining view properties of the text field. |
| Widgets | Gets the list of widget annotations associated with this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Name | Description | |
|---|---|---|
 | GetPdfStream | Gets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| GetPdfStreamData | Gets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| GetPdfStreamInfo | Gets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| SetDateFormat | Imposes the specified date format string on the current TextField.
The syntax of the format string is similar to .NET format strings. Some examples are "m/d/yyyy" or "d-mmm-yy". Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams. |
| SetDateValue | Imposes the specified date format string on the current TextField, and assigns to it the specified value as a date.
The syntax of the format string is similar to .NET format strings. Some examples are "m/d/yyyy" or "d-mmm-yy". |
| SetNumberFormat | Imposes the specified numeric formatting options on the current TextField.
Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams. |
| SetNumberValue | Imposes the specified numeric formatting options on the current TextField, and assigns to it the specified value as a number. |
| SetPercentFormat | Imposes the specified percentage formatting options on the current TextField.
Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams. |
| SetPercentValue | Imposes the specified percentage formatting options on the current TextField, and assigns to it the specified value as percentage. |
| SetSpecialFormat | Imposes the specified special format on the current TextField.
Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams. |
| SetSpecialFormatValue | Sets the value of the current TextField as a value formatted according to format.
This method assumes that value is already formatted as required. E.g. if format is SSN, value should look like "123-45-6789". |
| SetTimeFormat | Imposes the specified time format string on the current TextField.
The syntax of the format string is similar to .NET format strings. Some examples are "HH:MM" or "H:MM tt". Note that this method initializes the values of Field.Events.FormatValue and Field.Events.KeyPress only, it does not change the field's value or widget appearance streams. |
| SetTimeValue | Imposes the specified time format string on the current TextField, and assigns to it the specified value as time.
The syntax of the format string is similar to .NET format strings. Some examples are "HH:MM" or "H:MM tt". |