Difference between revisions of "Vtigercrm field properties"
From Studiosg
Jump to navigationJump to search| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{header_en|title=VtigerCRM form field properties| keyword={{Template:keyword_en_vtigercrm}}| description=A list of the many VtigerCRM form field properties explained | link_page=vtigercrm_proprietà_dei_campi}} | |
| − | + | [[En/vtigercrm_intro#VtigerCRM_internals | VtigerCRM internals]] | |
| − | |||
| − | + | == Field Properties == | |
| − | |||
All controls appearing in VtigerCRM forms are cloned from a limited set of "Widgets" designed by the software developers. All of this controls can be used while developing custom modules either through the use of the '''vtlib''' library or writing '''XML description code''' for the module. Control features and behavior can be set through a '''limited set of properties'''. Control properties will be listed below accompanied by a brief description of their function. Were You interested in learning about existing controls properties, You could query the '''vtiger_field''' table, where all of VtigerCRM active controls are listed. | All controls appearing in VtigerCRM forms are cloned from a limited set of "Widgets" designed by the software developers. All of this controls can be used while developing custom modules either through the use of the '''vtlib''' library or writing '''XML description code''' for the module. Control features and behavior can be set through a '''limited set of properties'''. Control properties will be listed below accompanied by a brief description of their function. Were You interested in learning about existing controls properties, You could query the '''vtiger_field''' table, where all of VtigerCRM active controls are listed. | ||
| − | {| border="1" | + | {| bgcolor="darkgrey" border="1" width="90%" |
| + | |+ '''FIELD PROPERTIES''' | ||
| + | |- bgcolor="darkgrey" | ||
! '''Property''' !! '''Description''' | ! '''Property''' !! '''Description''' | ||
|- | |- | ||
| ''name'' || This is mandatory for all fields. The name should be unique for a module. | | ''name'' || This is mandatory for all fields. The name should be unique for a module. | ||
|- | |- | ||
| − | | ''column'' || The database column linked to the form fields. < | + | | ''column'' || The database column linked to the form fields. <br /> Data saved in the software forms will be written in the corresponding column. |
|- | |- | ||
| ''columntype'' || Data type saved into the column. Please consult your database engine of choice documentation for a list of possible entries. | | ''columntype'' || Data type saved into the column. Please consult your database engine of choice documentation for a list of possible entries. | ||
|- | |- | ||
| − | | ''generatedtype'' || Identifies predefined fields and custom user additions. < | + | | ''generatedtype'' || Identifies predefined fields and custom user additions. <br /> While developing a new module all fields will classify as predefined. <br /> Can assume two values: 1 and 2. 1 equals '''Existing''': a field from the module main table, while 2 equals '''User Defined''': A custom field whose content is saved in a custom table named <module name>'''cf'''. |
|- | |- | ||
| − | | ''label'' || The text description associated to each form field. < | + | | ''label'' || The text description associated to each form field. <br /> VtigerCRM uses the saved value as an index for the '''$mod_strings''' array where the program translations reside. <br /> English names only should be used while developing new modules. |
|- | |- | ||
| − | | ''table'' || The column containing table. < | + | | ''table'' || The column containing table. <br /> Standard modules use the '''vtiger_'''<module name> naming convention. |
|- | |- | ||
| ''maximumlength'' || The maximum number of characters / numbers that can be entered in the forms field. | | ''maximumlength'' || The maximum number of characters / numbers that can be entered in the forms field. | ||
|- | |- | ||
| − | | ''typeofdata'' || Form data format. < | + | | ''typeofdata'' || Form data format. <br /> Formatting is imposed by a '''X~Y''' string where X means '''data type''' (Please read [[vtigercrm_data_type | Data types used in VtigerCRM 5]]), while Y can assume two values only: '''M''' for mandatory or '''O''' for optional. |
|- | |- | ||
| − | | ''uitype'' || The Widget that will appear in a form (Please read [[vtigercrm_widget_type]]). | + | | ''uitype'' || The Widget that will appear in a form (Please read [[vtigercrm_widget_type | VtigerCRM 5 Widget list]]). |
|- | |- | ||
| − | | ''displaytype'' || Selects which forms should show the control. < | + | | ''displaytype'' || Selects which forms should show the control. <br /> The potential values range from 1 to 4. <br /> 1 means every view, 2 means '''detail view''' only, never in the '''edit view''', 3 means the field will never be shown alone, but only with other related ones and 4 means the field should be shown during data insert only. Not in the '''detail view''' nor in the '''edit view'''. |
|- | |- | ||
| − | | ''masseditable'' || Should the control be shown in the Mass Edit list ? < | + | | ''masseditable'' || Should the control be shown in the Mass Edit list ? <br /> Can be assigned a value of 0 or 1. <br /> A value of 0 enables the Mass Edit feature for the field while a value of 1 disables it. |
|- | |- | ||
| − | | ''presence'' || Which is the field nature ? < | + | | ''presence'' || Which is the field nature ? <br /> The potential values range from 0 to 2. <br /> 0 identifies a '''system field''' that cannot be hidden by the user. 1 identifies an '''hidden field''', never shown. 2 identifies a '''standard field''': its presence can be configured in the customization forms. |
|- | |- | ||
| − | | ''quickcreate'' || Should the control be shown in the Quick Create form ? < | + | | ''quickcreate'' || Should the control be shown in the Quick Create form ? <br /> Can be assigned a value of 0 or 1. <br /> A value of 0 enables the Quick Create feature for the field while a value of 1 disables it. |
|- | |- | ||
| ''quickcreatesequence'' || Control order of appearance in the Quick Create form. | | ''quickcreatesequence'' || Control order of appearance in the Quick Create form. | ||
|- | |- | ||
| − | | ''readonly'' || Identifies Read Only fields. < | + | | ''readonly'' || Identifies Read Only fields. <br /> A value of 0 means Read Only field, while a value of 1 identifies a Read / Write one. |
|- | |- | ||
| − | | ''selected'' || Gives focus to the control after opening a form. < | + | | ''selected'' || Gives focus to the control after opening a form. <br /> Only one "selected" control should exist for each form. <br /> Can be assigned a value of 0 or 1. <br /> A value of 0 assigns the control the "selected" status while a value of 1 disables it. |
|- | |- | ||
| ''sequence'' || Control order of appearance in the Detail View form. | | ''sequence'' || Control order of appearance in the Detail View form. | ||
| Line 50: | Line 50: | ||
| ''helpinfo'' || Help message for the in-line help. The text message popping-up when the mouse hovers the control. | | ''helpinfo'' || Help message for the in-line help. The text message popping-up when the mouse hovers the control. | ||
|- | |- | ||
| − | | ''info_type'' || In-line help message type < | + | | ''info_type'' || In-line help message type <br /> Can be assigned a value of '''BAS''' for a message regarded as a '''Basic Information''', or '''ADV''' for '''More Information''' messages. |
|} | |} | ||
| Line 57: | Line 57: | ||
| − | + | {{footer_en | link_page=vtigercrm_proprietà_dei_campi}} | |
| − | |||
| − | |||
Latest revision as of 13:55, 21 March 2022
Welcome to Simone Giustetti's wiki pages.
Languages: English - Italiano
Field Properties
All controls appearing in VtigerCRM forms are cloned from a limited set of "Widgets" designed by the software developers. All of this controls can be used while developing custom modules either through the use of the vtlib library or writing XML description code for the module. Control features and behavior can be set through a limited set of properties. Control properties will be listed below accompanied by a brief description of their function. Were You interested in learning about existing controls properties, You could query the vtiger_field table, where all of VtigerCRM active controls are listed.
| Property | Description |
|---|---|
| name | This is mandatory for all fields. The name should be unique for a module. |
| column | The database column linked to the form fields. Data saved in the software forms will be written in the corresponding column. |
| columntype | Data type saved into the column. Please consult your database engine of choice documentation for a list of possible entries. |
| generatedtype | Identifies predefined fields and custom user additions. While developing a new module all fields will classify as predefined. Can assume two values: 1 and 2. 1 equals Existing: a field from the module main table, while 2 equals User Defined: A custom field whose content is saved in a custom table named <module name>cf. |
| label | The text description associated to each form field. VtigerCRM uses the saved value as an index for the $mod_strings array where the program translations reside. English names only should be used while developing new modules. |
| table | The column containing table. Standard modules use the vtiger_<module name> naming convention. |
| maximumlength | The maximum number of characters / numbers that can be entered in the forms field. |
| typeofdata | Form data format. Formatting is imposed by a X~Y string where X means data type (Please read Data types used in VtigerCRM 5), while Y can assume two values only: M for mandatory or O for optional. |
| uitype | The Widget that will appear in a form (Please read VtigerCRM 5 Widget list). |
| displaytype | Selects which forms should show the control. The potential values range from 1 to 4. 1 means every view, 2 means detail view only, never in the edit view, 3 means the field will never be shown alone, but only with other related ones and 4 means the field should be shown during data insert only. Not in the detail view nor in the edit view. |
| masseditable | Should the control be shown in the Mass Edit list ? Can be assigned a value of 0 or 1. A value of 0 enables the Mass Edit feature for the field while a value of 1 disables it. |
| presence | Which is the field nature ? The potential values range from 0 to 2. 0 identifies a system field that cannot be hidden by the user. 1 identifies an hidden field, never shown. 2 identifies a standard field: its presence can be configured in the customization forms. |
| quickcreate | Should the control be shown in the Quick Create form ? Can be assigned a value of 0 or 1. A value of 0 enables the Quick Create feature for the field while a value of 1 disables it. |
| quickcreatesequence | Control order of appearance in the Quick Create form. |
| readonly | Identifies Read Only fields. A value of 0 means Read Only field, while a value of 1 identifies a Read / Write one. |
| selected | Gives focus to the control after opening a form. Only one "selected" control should exist for each form. Can be assigned a value of 0 or 1. A value of 0 assigns the control the "selected" status while a value of 1 disables it. |
| sequence | Control order of appearance in the Detail View form. |
| helpinfo | Help message for the in-line help. The text message popping-up when the mouse hovers the control. |
| info_type | In-line help message type Can be assigned a value of BAS for a message regarded as a Basic Information, or ADV for More Information messages. |
For any feedback, questions, errors and such, please e-mail me at studiosg [at] giustetti [dot] net.
Languages: English - Italiano
