TX Text Control .NET Server

DateFormFieldInfo Object

Object|Introduced in 30.0

Description

Information about a check form field. Is needed by the event argument class DateFormFieldEventArgs.

Syntax

{
   date: <Number>,
   dateFormat: <String>,
   emptyWidth: <Number>
}

Examples

The following example demonstrates DateFormFieldInfo in a practical document-editing workflow. Information about a check form field. Is needed by the event argument class DateFormFieldEventArgs.

function inspectDateFormFieldInfo(dateFormFieldInfo) {
    console.log("date:", dateFormFieldInfo.date);
    console.log("date format:", dateFormFieldInfo.dateFormat);
    console.log("empty width:", dateFormFieldInfo.emptyWidth);
}

Members

Properties

PropertyDescription
boundsThe bounding rectangle of a text field. (Inherited from TextFieldInfo.)
containsInputPositionReturns true if the Textfield contains the current text input position. (Inherited from TextFieldInfo.)
dateThe date as a Unix time stamp in milliseconds.
dateFormatThe date format.
deleteableSpecifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextFieldInfo.)
doubledInputPositionSpecifies whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextFieldInfo.)
editableSpecifies whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from TextFieldInfo.)
emptyWidthThe horizontal width of the empty field in twips.
formattingBoundsThe formatting rectangle of a text field. (Inherited from TextFieldInfo.)
idThe identifier of the text field. (Inherited from TextFieldInfo.)
isSpellCheckingEnabledSpecifies whether a text field's text is checked on misspelled words. (Inherited from TextFieldInfo.)
lengthThe number of characters in the text field. (Inherited from TextFieldInfo.)
nameThe text field's name. (Inherited from TextFieldInfo.)
showActivatedSpecifies whether a text field toggles its background to gray, if the current input position is in the field. (Inherited from TextFieldInfo.)
startThe 1-based first character position of the text field. (Inherited from TextFieldInfo.)
textThe text field's text content. (Inherited from TextFieldInfo.)
typeThe field type ("APPLICATIONFIELD" or "TEXTFIELD"). (Inherited from TextFieldInfo.)