• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
      • Introduction to Data Entry
      • Data Entry Application
      • Data Entry Editing
      • CAPI Data Entry
      • Network Data Entry
      • Android Data Entry
        • Android Development
        • Android Limitations
        • Android Navigation
        • CSEntry Settings Modification
        • Interacting With Other Android Applications
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
    • Templated Reporting System
    • HTML and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataViewer>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

CSEntry Settings Modification

It is possible to customize the menus presented to the user, and other settings, when running CSEntry on an Android device. By using the savesetting function to save a setting, you can override the default behavior of a menu option. You must execute this function call in logic before the menu setting takes effect, so if you are interested in immediately applying your customized settings, you can distribute your application with the PFF's CommonStore attribute set to a settings file with your predefined settings.
Settings List and Description
/* General Options */
"CSEntry.Setting.HelpUrl"
A website URL or filename that is opened when the operator clicks on the "Help" menu.
 
"CSEntry.Menu.Help"
Whether to show the "Help" menu option. Values: "Yes" (show) or "No" (hide)
 
/* Application Listing Options */
"CSEntry.Setting.LaunchSingleApplicationAutomatically"
Whether CSEntry should automatically open an application if there is only one PFF on the device. Values: "Yes" (open) or "No" (do not open)
 
"CSEntry.Menu.AddApplication"
Whether to show the "Add Application" menu option. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Menu.Settings"
Whether to show the "Settings" menu option. Values: "Yes" (show) or "No" (hide)
 
/* Settings Options */
"CSEntry.Menu.ShowHiddenApplications"
Whether to show the "Show Hidden Applications" option in the settings. Values: "Yes" (show) or "No" (hide)
 
/* Data Entry Options */
"CSEntry.Menu.AdvanceToEnd"
Whether to show the "Advance to End" menu option. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Menu.ReviewAllNotes"
Whether to show the "Review All Notes" menu option. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Menu.ShowCaseTree"
Whether to show the "Show Case Tree" menu option on tablets. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Menu.ShowRefusals"
Whether to show the "Show Refusal Options" menu option. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Setting.ShowNavigationControls"
Whether to display the navigation controls. If this value is set, then the "Show/Hide Navigation Controls" menu option is hidden. Values: "Yes" (show) or "No" (hide)
 
/* Case Tree Options */
"CSEntry.Menu.AddInsertOccurrence"
Whether to show the "Add Occurrence" and "Insert Occurrence" menu options when clicking on a group. Values: "Yes" (show) or "No" (hide)
 
"CSEntry.Menu.DeleteOccurrence"
Whether to show the "Delete Occurrence" menu option when clicking on a group. Values: "Yes" (show) or "No" (hide) 
 
"Setting.ShowCaseTreeInOverlay"
Whether to always show the case tree (as opposed to it being displayed only on user demand). Values: "BasedOnScreenSize" (generally yes for tablets, no for phones), "Yes" (always), or "No" (hidden until user demand)
 
/* Other Options */
"CSEntry.Setting.CameraAspectRatio"
Specifies the aspect ratio (width to height) to use when taking photos; e.g., 16 / 9.
Examples
// prevent the user from adding new applications
savesetting("CSEntry.Menu.AddApplication", "No");

// override the help menu so that it opens the survey documentation
savesetting("CSEntry.Setting.HelpUrl", pathname(Application) + "Enumerator Manual.pdf");
See also: loadsetting Function, savesetting Function, User and Configuration Settings