SetProperty Function

Format

i = setproperty(『symbol,』property_name,property_value);

Description

The setproperty function modifies the current property, specified by the string expression property_name, associated with an application or a field. If an optional dictionary symbol is specified, then the property must apply to a field. If the symbol is not a field but is intead a block, group, form, or dictionary, then the function will try to apply the property to all fields belonging to that symbol. If no symbol is specified, then the property must be an application property. The property will be modified to the value given in the string expression property_value.

Properties List

The following properties apply to the application:

Name	Settable?	Platform	Values
AppType		All	DataEntry, Batch, Tabulation
AutoAdvanceOnSelection	✔	Mobile	Yes, No
AutoPartialSaveMinutes	✔	All	(integer of the interval)
CAPI		All	Yes, No
CaseTree		All	Always, Desktop, Mobile, Never
CenterForms		Desktop	Yes, No
ComboBoxShowOnlyDiscreteValues	✔	All	Yes, No
CreateListing		All	Yes, No
CreateLog		All	Yes, No
DecimalComma		Desktop	Yes, No
DisplayCodesAlongsideLabels	✔	Mobile	Yes, No
NotesDeleteOtherOperators	✔	All	Yes, No
NotesEditOtherOperators	✔	All	Yes, No
OperatorID		All	Yes, No
ParadataCollection		All	AllEvents, SomeEvents, No
ParadataDeviceStateMinutes	✔	All	(integer of the interval)
ParadataGpsLocationMinutes	✔	All	(integer of the interval)
ParadataRecordCoordinates	✔	All	Yes, No
ParadataRecordIteratorLoadCases	✔	All	Yes, No
ParadataRecordValues	✔	All	Yes, No
PartialSave	✔	All	Yes, No
Path		All	Yes (system controlled), No (operator controlled)
ShowEndCaseDialog	✔	All	Yes, No
ShowErrorMessageNumbers	✔	Mobile	Yes, No
ShowFieldLabels		Mobile	Yes, No
ShowLabelsInCaseTree	✔	Mobile	Yes, No
ShowNavigationControls	✔	Mobile	Yes, No
ShowRefusals	✔	All	Yes, No
ShowSkippedFields	✔	Mobile	Yes, No
SpecialValuesZero	✔	All	Yes, No
UpdateSaveArrayFile	✔	All	Yes, No
ValidateAlphaFields	✔	All	Yes, No
WindowTitle	✔	All	(string of the window title)

The following properties apply to items, none of which are settable:

Name	Values
DataType	Alpha, Numeric
Decimal	(integer)
DecimalChar	Yes, No
Len	(integer)
ZeroFill	Yes, No

The following properties apply to fields:

Name	Settable?	Values
AllowMultiLine		Yes, No
AutoIncrement		Yes, No
CanEnterNotAppl	✔	No, Confirm, NoConfirm
CanEnterOutOfRange	✔	No, Confirm, NoConfirm
CapturePosX	✔	(integer of the X position)
CapturePosY	✔	(integer of the Y position)
CaptureType	✔	Barcode, CheckBox, ComboBox, Date, DropDown, NumberPad, RadioButton, Slider, TextBox
CaptureTypeDateFormat	✔	(string of the date format, e.g., YYYYMMDD)
ForceOutOfRange	✔	Yes, No
HideInCaseTree	✔	Yes, No
Keyboard	✔	(integer of the keyboard ID)
Persistent		Yes, No
Protected	✔	Yes, No
Sequential		Yes, No
SkipTo		(string of the field name)
UpperCase	✔	Yes, No
UseEnterKey	✔	Yes, No
UseUnicodeTextBox		Yes, No
ValidationMethod	✔	Default, Confirm, NoConfirm, Custom
Verify		Yes, No

Return Value

The function returns the number of items whose property was successfully changed. If either the property name or value is invalid, then the function returns default.

Example

PROC CENSUS_QUEST

preproc

if STAFF_ROLE = 1 then // interviewer
setproperty("DisplayCodesAlongsideLabels","No");
setproperty(CENSUS_DICT,"CanEnterNotAppl","No");
setproperty(CENSUS_DICT,"CanEnterOutOfRange","No");

else // supervisor
setproperty("DisplayCodesAlongsideLabels","Yes");
setproperty(CENSUS_DICT,"CanEnterNotAppl","NoConfirm");
setproperty(CENSUS_DICT,"CanEnterOutOfRange","NoConfirm");

endif;

See also: GetProperty Function, Protect Function