SetCapturePos Function

Feature Upgrade: Starting with CSPro 7.1, you should no longer use this function as it may soon be removed from CSPro. To replicate the behavior of the function, you can use the setproperty function with the argument "CapturePosX" or "CapturePosY".

Format

i = setcapturepos(symbol, x_coord, y_coord);

Description

The setcapturepos function modifies the capture position for the capture types associated with a field on a form. The symbol_name may refer to a field, group, form, or an entire dictionary. The two numeric expressions x_coord and y_coord refer to the x (horizontal) and y (vertical) positions of the top-left corner of the capture type window. This position is relative to the form window, not the whole CSEntry window, with (0,0) referring to the top-left corner of the form. If the position given for a field is greater than the size of the form, CSEntry will ignore the argument when displaying the capture type window. This function is useful for CAPI applications in which a part of the screen is left blank specifically for capture type windows. Calls to this function are ignored when executed on mobile devices.

Return Value

The function returns the number of items whose capture positions were successfully changed.

Example

setcapturepos(CAPI_DICT, 700, 20); // draw all windows on the right side of the form