InkEdit.property

Description

Properties that control the behavior of a column with the InkEdit edit style.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.InkEdit.property

Describe and Modify argument:

"columnname.InkEdit.property { = value }"

Parameter	Description
columnname	The name of a column that has the InkEdit edit style.
property	A property for the InkEdit column. Properties and their settings are listed in the table below.
value	The value to be assigned to the property.

Property for InkEdit	Value
AutoSelect	Whether to select the contents of the edit control automatically when it receives focus. Values are: Yes – Select automatically (default). No – Do not select automatically. You can use AutoSelect with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Selection option.
DisplayOnly	Specifies whether the text is display-only and cannot be changed by the user. Values are: true – Text cannot be changed by user. false – Text can be changed by user (default). Painter: Display Only option.
Factoid	Specifies a context for ink recognition. Set this property if the input data is of a known type, such as a date or Web address, to constrain the search for a recognition result. Possible values include digit, e-mail, Web, date, time, number, currency, percent, and telephone. For a list of values, see the table that follows. Painter: Factoid option.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) will surround the current row of the column when the column has focus. Values are: Yes – (Default) Display the focus rectangle. No – Do not display the focus rectangle (default). You can use FocusRectangle with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Show Focus Rectangle option.
HScrollbar	Whether a horizontal scroll bar displays in the edit control. Values are: Yes – Display the horizontal scroll bar. No – Do not display the horizontal scroll bar (default). Painter: Horizontal Scroll Bar option.
InkMode	Specifies whether ink collection is enabled and whether ink only or ink and gestures are collected. Values are: InkDisabled (0) – Ink collection is disabled. CollectInkOnly (1) – Only ink is collected. CollectInkAndGestures (2) – Ink and gestures are collected (default). Painter: InkMode option.
Limit	A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited. Painter: Limit option.
NilIsNull	Whether to set the data value of the InkEdit to null when the user leaves the edit box blank. Values are: Yes – Make the Empty string null. No – Do not make the empty string null (default). Painter: Empty String is null option.
RecognitionTimer	Specifies the time period in milliseconds between the last ink stroke and the start of text recognition. The default is 2000 (two seconds). Painter: RecognitionTimer option.
Required	Whether the column is required. Values are: Yes – Required. No – (Default) Not required. Painter: Required option.
UseMouseForInput	Specifies whether the mouse can be used for input on a Tablet PC. Values are: true – The mouse can be used for input false – The mouse cannot be used for input (default) Painter: UseMouseForInput option.
VScrollbar	Whether a vertical scroll bar displays in the edit control. Values are: Yes – Display a vertical scroll bar. No – Do not display a vertical scroll bar (default). Painter: Vertical Scroll Bar option.

Usage

The following values for Factoid are available. After the Default and None factoids, the drop-down list in the Properties view displays factoids for special formats in alphabetical order, followed by single-character factoids and Asian-language factoids. You can set multiple factoids by separating them with the pipe ( | ) character.

Factoid	Description
Default	Returns recognizer to the default setting. For Western languages, the default setting includes the user and system dictionaries, various punctuation marks, and the Web and Number factoids. For Eastern languages, the default setting includes all characters supported by the recognizer.
None	Disables all factoids, dictionaries, and the language model.
Currency	Currency in pounds, dollars, euros, and yen.
Date	Dates written in English; for example 8/19/2005, Aug 19, 2005, or Friday, August 19, 2005.
E-mail	E-mail addresses.
Filename	Windows file name paths. The name cannot include the following characters: / : " < > \|
Number	Numeric values, including ordinals, decimals, separators, common suffixes, and mathematical symbols. This factoid includes the Currency and Time factoids.
Percent	A number followed by the percent symbol.
Postal Code	Postal codes as written in English, for example 01730 or CT17 9PW.
System Dictionary	Words in the system dictionary only.
Telephone	Telephone numbers as written in English, for example (555) 555 5555 or +44 1234 123456.
Time	Times as written in English, for example 15:05 or 3:05 pm.
Web	Various URL formats.
Word List	Words on the word list associated with the recognizer context only.
Digit	A single digit (0–9).
One Char	A single ANSI character.
Upper Char	A single uppercase character.

In addition, the following Asian-language factoids are available:

Bopomofo	Kanji Common
Hangul Common	Katakana
Hiragana	Korean Common
Jamo	Simplified Chinese Common
Japanese Common	Traditional Chinese Common

In the painter

Select the control and set values in the Properties view, Ink tab for properties relating to Ink, or the Edit tab for properties common to other edit styles. The Style Type on the Edit tab must be set to InkEdit.

Examples

Example 1

string str

str = dw1.Object.emp_name.InkEdit.Factoid

dw1.Object.emp_name.InkEdit.Factoid = EMAIL

Example 2

str = dw1.Describe("emp_bd.InkEdit.Factoid")

dw1.Modify("emp_bd.InkEdit.Factoid=EMAIL")

Example 3

string str

str = dw1.Object.emp_name.InkEdit.AutoHScroll

dw1.Object.emp_name.InkEdit.Required = "no"