An InkPicture control collects pen input (“ink”) on a Tablet PC and layers it on a picture. It is used to collect ink annotations to a picture or signatures. It has no handwriting recognition capability.
Using with animation features
InkPicture controls may not paint correctly when you use animation
features.
InkPicture property |
Datatype |
Description |
---|---|---|
AutoErase |
Boolean |
Specifies whether the auto erase feature available on some styluses is turned on. 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 (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. |
InkCollectionMode (enumerated) |
Specifies whether ink only, gestures only, or ink and gestures are collected. 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. |
|
DynamicRendering |
Boolean |
Specifies whether the ink is rendered (displayed in the control) as it is drawn. The default is true. |
InkPicEditMode |
Specifies whether the editing mode of the control is set for drawing ink, editing ink, or deleting ink. Values are:
|
|
Boolean |
Specifies whether the control is enabled (can be selected). Values are:
|
|
EraserMode |
Integer |
Specifies whether ink is removed by stroke or point. Values are:
|
EraserWidth |
Integer |
Specifies the width of the eraser pen tip in pixels. The default is 212 pixels. |
Integer |
Specifies the height of the control, in PowerBuilder units. |
|
HighContrastInk |
Boolean |
Specifies whether ink is rendered in a single color when the system is in high contrast mode and draws the selection rectangle and handles in high contrast. 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. |
|
Boolean |
Specifies whether the InkPicture control collects pen input. Values are:
|
|
InkFileName |
String |
Specifies the name of the file that the ink was loaded from. |
Integer |
A drawing attribute that specifies the height of the side of the rectangular pen tip in pixels. The default is 1. |
|
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. 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. |
|
MarginX |
Integer |
Specifies the x-axis margin around the control in PowerBuilder units. The default value is 0. |
MarginY |
Integer |
Specifies the y-axis margin around the control in PowerBuilder units. The default value is 0. |
PenTip |
InkPenTip (enumerated) |
A drawing attribute that specifies whether the pen tip is round or rectangular. Values are:
|
PictureFileName |
String |
Specifies the name of a file that contains the picture for the control. The default is an empty string. Supported formats are BMP, GIF, JPEG, PNG, and TIF. |
PictureSizeMode |
DisplaySizeMode |
Specifies how the picture is displayed in the control. Values are:
|
String |
Specifies the name of the stock pointer or the file containing the pointer used for the control. |
|
String |
Specifies a PowerTip for the control. |
|
InkPicStatus |
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! 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. |
|
Boolean |
Specifies whether the control is visible. Values are:
|
|
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. |
InkPicture event |
Occurs |
---|---|
When the left mouse button is clicked in the control |
|
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 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 Windows message occurs that is not a PowerBuilder event |
|
When the right mouse button is pressed on the control |
|
When an item in the control is selected |
|
When the selection is changing. Return 1 to prevent the selection from changing or 0 to allow it |
|
SizeChanged |
When the control has been resized |
When a stroke has occurred |
InkPicture function |
Datatype returned |
Description |
---|---|---|
String |
Returns the name of the control. |
|
Integer |
Starts or ends the dragging of a 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 |
Loads ink from a file or blob. |
|
Integer |
Loads a picture from a file or blob. |
|
Integer |
Moves a control or object to a specified location. |
|
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. |
|
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 |
Clears ink from the control. |
|
Integer |
Clears a picture from the control. |
|
Integer |
Resizes a control to the specified dimensions. |
|
Integer |
Saves a picture and optionally any overlay ink to a file or blob in one of the following formats: bitmap, JPEG, GIF, TIF, or PNG. |
|
Integer |
Saves ink to a file or blob in one of the following formats: Ink Serialized Format (ISF), GIF, Base-64 encoded ISF, or Base-64 encoded GIF. |
|
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. |