SetCaptureType 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 "CaptureType" or "CaptureDateFormat".

Format

i = setcapturetype(symbol_name, capture_typeʃ, date_formatʅ);

Description

The setcapturetype function modifies the capture type currently associated with a field on a form. The symbol_name may refer to a field, group, form, or an entire dictionary. The numeric expression capture_type refers to a capture type code, listed in the table below. If specifying a date, the format can be specified with the optional string expression date_format.

Code	Capture Type
0	Text Box
1	Radio Button
2	Check Box
3	Drop Down Box
4	Combo Box
5	Date Picker
6	Number Pad (desktop CSEntry only)
7	Barcode (Android only)
8	Slider (Android only)
9	Toggle Button

Return Value

The function returns the number of items that were successfully changed to the specified capture type. An item's capture type can be successfully changed if the current value set associated with the item supports the requested capture type. For instance, if an item's value set contains ranges, the capture type cannot be changed to a radio button. The success of changing a field to a date picker does not depend on the date format, so if the date format is not valid for the field the capture type will be changed to the default date format for the item.

Example

setcapturetype(DATE_OF_BIRTH, 5, "YYYYMMDD");

errmsg("%d fields changed to radio buttons on the housing form",setcapturetype(HOUSING_FORM,1));