An InkEdit control collects pen input (ink) on a Tablet PC and converts it to text. It is used with the handwriting recognition engine (“recognizer”) that is part of the Tablet PC platform.
Using with animation features
InkEdit controls may not paint correctly when you use animation
features.
InkEdit property |
Datatype |
Description |
---|---|---|
String |
A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users. |
|
String |
A label that briefly describes the control, such as the text in a button or the name of a menu item. |
|
AccessibleRole (enumerated) |
Describes what kind of user interface element the control is. |
|
Alignment (enumerated) |
Specifies the alignment of text in the control. Values are:
|
|
Long |
Specifies the numeric value of the background color: –2 to 16,777,215. For more information about color, see the RGB function in the PowerScript Reference. |
|
Boolean |
Specifies whether the control has a border. Values are:
|
|
BorderStyle |
BorderStyle (enumerated) |
Specifies the border style of the control. Values are:
|
Boolean |
Specifies whether PowerBuilder moves the control to the top of the front-to-back order. |
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
Boolean |
Specifies whether the text is display only and cannot be changed by the user. Values are:
|
|
Boolean |
Specifies whether PowerBuilder puts the control automatically into Drag mode. Values are:
|
|
String |
Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control. When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays. |
|
Boolean |
Specifies whether the control is enabled (can be selected). Values are:
|
|
String |
Specifies the name of the typeface in which the text of the control displays (for example, Arial or Courier). |
|
String |
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. |
|
FontCharSet (enumerated) |
Specifies the font character set used for the text in the control. The application must be running on an appropriate version of PowerBuilder under an operating system that supports the selected character set. For a complete list of possible values, see the list of properties for the FontCharSet enumerated datatype on the Enumerated tab page of the Browser. |
|
FontFamily (enumerated) |
Specifies the font family (type style) used for the text in the control. Values are:
|
|
FontPitch (enumerated) |
Specifies the font pitch used for the text in the control. Values are:
|
|
Integer |
Specifies the height of the control, in PowerBuilder units. |
|
Boolean |
Specifies whether a horizontal scroll bar displays. Values are:
|
|
Boolean |
A drawing attribute that specifies whether the drawn ink gets wider as the pressure of the pen tip on the tablet surface increases. Values are:
|
|
Boolean |
A drawing attribute that specifies whether the foreground and background colors along the edge of the drawn ink are blended (antialiased) to make the stroke smoother and sharper. Values are:
|
|
Long |
A drawing attribute that specifies the current ink color. The default color is black. |
|
Integer |
A drawing attribute that specifies the height of the side of the rectangular pen tip in pixels. The default is 1pixel. |
|
InkMode (enumerated) |
Specifies whether ink collection is enabled and whether ink only or ink and gestures are collected. Values are:
|
|
InkTransparency |
Integer |
A drawing attribute that specifies the transparency of drawn ink. The range of values is from 0 for totally opaque (the default) to 255 for totally transparent. |
Integer |
A drawing attribute that specifies the width of the pen in pixels. The default is 53 pixels. If the IgnorePressure property is not set, the actual width varies between .5 times the value of the Width property for minimum pressure and 1.5 times its value for maximum pressure. |
|
Boolean |
Specifies whether the ink is inserted as text or as ink. Values are:
|
|
Boolean |
Specifies whether the text in the control is italic. Values are:
|
|
Integer |
Specifies the maximum number of characters (0 to 32,767) that can be entered in the control (0 means unlimited). |
|
Boolean |
Specifies whether the text in the control has been modified since it was opened or last saved. Modified is the control's “dirty” flag, indicating that the control is in an unsaved state. Values are:
When the first change is made to a newly opened or saved control, PowerBuilder sets the Modified property to true and triggers the Modified event. |
|
PenTip |
InkPenTip (enumerated) |
A drawing attribute that specifies whether the pen tip is round or rectangular. Values are:
|
String |
Specifies the name of the stock pointer or the file containing the pointer used for the control. |
|
Long |
Specifies the time period in milliseconds between the last ink stroke and the start of text recognition. The default is 2000 (two seconds). |
|
Boolean |
Specifies that characters should be displayed in right-to-left order. The application must be running on an operating system that supports right-to-left display. Values are:
|
|
InkEditStatus (enumerated) |
A read-only property available at runtime that provides the current status of the control so that the user does not need to monitor the Stroke event. Values are CollectingInk!, RecognizingInk!, and Idle!. |
|
Integer |
Specifies the tab value of the control within the window (0 means the user cannot tab to the control). |
|
String |
Specifies the tag value assigned to the control. |
|
String |
Specifies the text that displays in the control. |
|
Long |
Specifies the numeric value of the color used for text: -2 to 16,777,215. |
|
Integer |
Specifies the size of the text in the control, in points. For backward compatibility, the size is stored as a negative number; for example, 10-point text size is stored as -10. |
|
Boolean |
Specifies whether the text in the control is underlined. Values are:
|
|
Boolean |
Specifies whether the mouse can be used for input on a Tablet PC. Values are:
|
|
Boolean |
Specifies whether the control is visible. Values are:
|
|
Boolean |
Specifies whether a vertical scroll bar is displayed on the right of the control. Values are:
|
|
Integer |
Specifies the stroke weight of the text in the control; for example, 400 for normal (default) or 700 for bold. |
|
Integer |
Specifies the width of the control, in PowerBuilder units. |
|
Integer |
Specifies the X position (the distance from the left edge of the window), in PowerBuilder units. |
|
Integer |
Specifies the Y position (the distance from the top of the window), in PowerBuilder units. |
InkEdit event |
Occurs |
---|---|
When the object is created, immediately before the Open event occurs in the window. |
|
When the object is destroyed, immediately after the Close event occurs in the window. |
|
When a dragged control is dropped on the control. |
|
When a dragged control enters the control. |
|
When a dragged control leaves the control. |
|
When a dragged control is within the control. |
|
When a gesture has occurred. |
|
Just before the control receives focus (before it is selected and becomes active). |
|
When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control. |
|
When the control loses focus (becomes inactive). |
|
When a control has been changed and loses focus. |
|
When a Windows message occurs that is not a PowerBuilder event. |
|
When the right mouse button is pressed on the control. |
|
When a recognition has occurred. |
|
When a stroke has occurred. |
InkEdit function |
Datatype returned |
Description |
---|---|---|
String |
Returns the name of the control. |
|
Integer |
Clears the selected text (if any) from the control (but does not place it in the clipboard). |
|
Integer |
Copies (but does not delete) the selected text (if any) from the control to the clipboard. |
|
Integer |
Cuts (deletes) the selected text (if any) from the control to the clipboard. |
|
Integer |
Starts or ends the dragging of an InkEdit item. |
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
PowerObject |
Returns a reference to the name of the parent object. |
|
Integer |
Hides the specified InkEdit item. |
|
Integer |
Moves a control or object to a specified location. |
|
Integer |
Inserts the contents of the clipboard (if any) at the insertion point in the control. |
|
Integer |
Determines the distance from the left edge of an object to the pointer location. |
|
Integer |
Determines the distance from the top edge of an object to the pointer location. |
|
Integer |
Returns the position of the insertion point in the control. |
|
Boolean |
Adds the event to the end of the event queue of an object. |
|
Integer |
Includes this object in a print job. Only the part visible on the screen is printed. |
|
Integer |
Resizes a control to the specified dimensions. |
|
Integer |
Specifies that ink recognition should occur. |
|
Integer |
Replaces the currently selected text (if any) with the specified string. If no text is selected, the ReplaceText function inserts the text at the insertion point. |
|
Integer |
Returns the length of the selected text (if any) in the control. |
|
String |
Returns a string with the selected text (if any) from the control. |
|
Long |
Selects the text specified by the starting position and length. |
|
Integer |
Sets focus for a specified object or control. |
|
Integer |
Sets the position of the InkEdit control in the front-to-back order within a window. |
|
Integer |
Controls the automatic redraw of an object after its properties have changed. |
|
Integer |
Makes an object or control visible if it is hidden. If the object is already visible, Show brings it to the top. |
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
Object |
Returns the type of the control. |