Difference between revisions of "Vtigercrm widget type"

From Studiosg
Jump to navigationJump to search
(Written page about VtigerCRM widget types)
 
(Partial page redesign)
Line 1: Line 1:
−
Welcome to Simone Giustetti's wiki pages.
+
{{header_en|title=Widgets used in VtigerCRM forms| keyword={{Template:keyword_en_vtigercrm}}| description=A list of widgets and controls used in VtigerCRM form fields | link_page=vtigercrm_tipi_di_widget}}
  
  
−
Languages: '''English''' - [http://www.giustetti.net/wiki/index.php?title=vtigercrm_tipi_di_widget Italiano]
+
[[vtigercrm_field_properties | VtigerCRM 5 form field properties]]
  
  
−
----
+
== Introduction ==
  
−
[[vtigercrm_field_properties]]
 
−
 
−
== Introduction ==
 
 
VtigerCRM uses a set of predefined controls to draw and populate user pages. Using controls from a library imposes a standard look and feel and guarantees reuse of large chunks of code. Developers can use the very same controls and widgets including the '''Vtlib''' library in their projects. Developing new modules or customizing existing ones recurring to the Vtlib library, code can be written faster retaining greater compatibility with the CRM.
 
VtigerCRM uses a set of predefined controls to draw and populate user pages. Using controls from a library imposes a standard look and feel and guarantees reuse of large chunks of code. Developers can use the very same controls and widgets including the '''Vtlib''' library in their projects. Developing new modules or customizing existing ones recurring to the Vtlib library, code can be written faster retaining greater compatibility with the CRM.
  
Line 16: Line 13:
 
The widget set covers all of the main CRM functions. The control count and standard behavior slightly vary depending on the VtigerCRM or the Vtlib version. It is good practice to '''check for Vtlib library version prior to writing new code''' in order to prevent undesired side effects. A list of known controls can be obtained reading some source code files where standard detail view or update view behavior are defined: '''include/utils/DetailViewUtils.php''', '''include/utils/EditViewUtils.php'''.
 
The widget set covers all of the main CRM functions. The control count and standard behavior slightly vary depending on the VtigerCRM or the Vtlib version. It is good practice to '''check for Vtlib library version prior to writing new code''' in order to prevent undesired side effects. A list of known controls can be obtained reading some source code files where standard detail view or update view behavior are defined: '''include/utils/DetailViewUtils.php''', '''include/utils/EditViewUtils.php'''.
  
−
 
+
{| bgcolor="darkgrey" border="1" width="80%"
−
{| border="1"
+
|+ '''WIDGET LIST'''
 +
|- bgcolor="darkgrey"
 
! '''Type''' !! '''Description / Purpose'''
 
! '''Type''' !! '''Description / Purpose'''
 
|-
 
|-
−
| ''1'' || Text field. <BR> Single line input only.
+
| ''1'' || Text field. <br /> Single line input only.
 
|-
 
|-
 
| ''2'' || Equals type 1, but the field is mandatory.
 
| ''2'' || Equals type 1, but the field is mandatory.
 
|-
 
|-
−
| ''3'' || Text field, cannot be updated. <BR> Auto generated incremental values used as entity identifiers.
+
| ''3'' || Text field, cannot be updated. <br /> Auto generated incremental values used as entity identifiers.
 
|-
 
|-
−
| ''4'' || Auto generated values. <BR> Can be customized for each module independently.
+
| ''4'' || Auto generated values. <br /> Can be customized for each module independently.
 
|-
 
|-
−
| ''5'' || Date field. <BR> Links to the '''jsCalendar''' object. <BR> Uses user defined date format. <BR> Inserted dates are checked for consistency prior to saving.
+
| ''5'' || Date field. <br /> Links to the '''jsCalendar''' object. <br /> Uses user defined date format. <br /> Inserted dates are checked for consistency prior to saving.
 
|-
 
|-
−
| ''6'' || Date Time field. <BR> Time can be inserted recurring to a pick list control. <BR> Links to the '''jsCalendar''' object. <BR> Inserted dates are checked for consistency prior to saving. <BR> Inserted Date / Time should be later than current ones.
+
| ''6'' || Date Time field. <br /> Time can be inserted recurring to a pick list control. <br /> Links to the '''jsCalendar''' object. <br /> Inserted dates are checked for consistency prior to saving. <br /> Inserted Date / Time should be later than current ones.
 
|-
 
|-
−
| ''7'' || Numeric field. <BR> Single line only.
+
| ''7'' || Numeric field. <br /> Single line only.
 
|-
 
|-
−
| ''8'' || Text Area. <BR> Text is saved as a set of comma separated strings.
+
| ''8'' || Text Area. <br /> Text is saved as a set of comma separated strings.
 
|-
 
|-
−
| ''9'' || Percent field. <BR> Only accepts values greater than 0 and lower than 100.
+
| ''9'' || Percent field. <br /> Only accepts values greater than 0 and lower than 100.
 
|-
 
|-
 
| ''10'' || Relates to other modules entities. A general relate field for entity relationships.
 
| ''10'' || Relates to other modules entities. A general relate field for entity relationships.
 
|-
 
|-
−
| ''11'' || Single line text field. <BR> No consistency check performed prior to saving.
+
| ''11'' || Single line text field. <br /> No consistency check performed prior to saving.
 
|-
 
|-
−
| ''12'' || E-mail field. <BR> Saves a link to the address book e-mail address upon sending a message.
+
| ''12'' || E-mail field. <br /> Saves a link to the address book e-mail address upon sending a message.
 
|-
 
|-
−
| ''13'' || E-mail field. <BR> An user provided address is required. <BR> A consistency check is performed prior to message sending.
+
| ''13'' || E-mail field. <br /> An user provided address is required. <br /> A consistency check is performed prior to message sending.
 
|-
 
|-
−
| ''15'' || Pick list. <BR> Listed values differ between modules and '''based upon user role'''.
+
| ''15'' || Pick list. <br /> Listed values differ between modules and '''based upon user role'''.
 
|-
 
|-
−
| ''16'' || Pick list. <BR> Listed values differ between modules but '''not based upon user role'''.
+
| ''16'' || Pick list. <br /> Listed values differ between modules but '''not based upon user role'''.
 
|-
 
|-
−
| ''17'' || Web link. <BR> No check performed prior to saving.
+
| ''17'' || Web link. <br /> No check performed prior to saving.
 
|-
 
|-
 
| ''19'' || Text Area used for long descriptions.
 
| ''19'' || Text Area used for long descriptions.
Line 58: Line 56:
 
| ''21'' || 5 rows long text field. Used for addresses and short descriptions.
 
| ''21'' || 5 rows long text field. Used for addresses and short descriptions.
 
|-
 
|-
−
| ''22'' || Text Area field specifically used to insert the "Title" field in some modules. <BR> Mandatory field.
+
| ''22'' || Text Area field specifically used to insert the "Title" field in some modules. <br /> Mandatory field.
 
|-
 
|-
−
| ''23'' || Date field. <BR> Equals type 5, but it is usually used to insert end dates.
+
| ''23'' || Date field. <br /> Equals type 5, but it is usually used to insert end dates.
 
|-
 
|-
−
| ''24'' || Text Area sized around 5 lines. Primarily used to store "Billing Address". <BR> When a contact is selected, the field is automatically filled in with the contact address. <BR> Field is mandatory.
+
| ''24'' || Text Area sized around 5 lines. Primarily used to store "Billing Address". <br /> When a contact is selected, the field is automatically filled in with the contact address. <br /> Field is mandatory.
 
|-
 
|-
 
| ''25'' || Email Status Tracking field. Counts the number of times an email is opened.
 
| ''25'' || Email Status Tracking field. Counts the number of times an email is opened.
 
|-
 
|-
−
| ''26'' || Documents folder. <BR> Used to select documents for upload.
+
| ''26'' || Documents folder. <br /> Used to select documents for upload.
 
|-
 
|-
−
| ''27'' || File type. <BR> Shows a pick list on the left side of the control. Selecting a choice, values in the right change accordingly.
+
| ''27'' || File type. <br /> Shows a pick list on the left side of the control. Selecting a choice, values in the right change accordingly.
 
|-
 
|-
−
| ''28'' || File name. <BR> File type should be selected in another field.
+
| ''28'' || File name. <br /> File type should be selected in another field.
 
|-
 
|-
 
| ''30'' || Drop down box used to set the reminder time when creating an activity.
 
| ''30'' || Drop down box used to set the reminder time when creating an activity.
 
|-
 
|-
−
| ''33'' || Text Area behaving like a pick list. Values can be selected from a predefined list. <BR> Values cannot be edited or inserted anew. only existing choices can be selected.
+
| ''33'' || Text Area behaving like a pick list. Values can be selected from a predefined list. <br /> Values cannot be edited or inserted anew. only existing choices can be selected.
 
|-
 
|-
 
| ''51'' || Select an account or a contact from a pop-up window.
 
| ''51'' || Select an account or a contact from a pop-up window.
 
|-
 
|-
−
| ''52'' || A drop down combo box used to select users. <BR> The inserted user is the handler for the entity being created.
+
| ''52'' || A drop down combo box used to select users. <br /> The inserted user is the handler for the entity being created.
 
|-
 
|-
−
| ''53'' || A drop down combo box user to select an user or a group. <BR> List choices can be filtered by users or groups.
+
| ''53'' || A drop down combo box user to select an user or a group. <br /> List choices can be filtered by users or groups.
 
|-
 
|-
 
| ''55'' || A pick list used to select a Salutation.
 
| ''55'' || A pick list used to select a Salutation.
Line 88: Line 86:
 
| ''57'' || Pop-up contact selection window.
 
| ''57'' || Pop-up contact selection window.
 
|-
 
|-
−
| ''255'' || Salutation. <BR> This is used in the '''Leads''' or '''Contacts''' module only.
+
| ''255'' || Salutation. <br /> This is used in the '''Leads''' or '''Contacts''' module only.
 
|}
 
|}
  
Line 95: Line 93:
  
  
−
----
+
{{footer_en | link_page=vtigercrm_tipi_di_widget}}
−
 
 
−
Languages: '''English''' - [http://www.giustetti.net/wiki/index.php?title=vtigercrm_tipi_di_widget Italiano]
 

Revision as of 14:18, 15 April 2016

Welcome to Simone Giustetti's wiki pages.


Languages: English - Italiano


VtigerCRM 5 form field properties


Introduction

VtigerCRM uses a set of predefined controls to draw and populate user pages. Using controls from a library imposes a standard look and feel and guarantees reuse of large chunks of code. Developers can use the very same controls and widgets including the Vtlib library in their projects. Developing new modules or customizing existing ones recurring to the Vtlib library, code can be written faster retaining greater compatibility with the CRM.


Widget types

The widget set covers all of the main CRM functions. The control count and standard behavior slightly vary depending on the VtigerCRM or the Vtlib version. It is good practice to check for Vtlib library version prior to writing new code in order to prevent undesired side effects. A list of known controls can be obtained reading some source code files where standard detail view or update view behavior are defined: include/utils/DetailViewUtils.php, include/utils/EditViewUtils.php.

WIDGET LIST
Type Description / Purpose
1 Text field.
Single line input only.
2 Equals type 1, but the field is mandatory.
3 Text field, cannot be updated.
Auto generated incremental values used as entity identifiers.
4 Auto generated values.
Can be customized for each module independently.
5 Date field.
Links to the jsCalendar object.
Uses user defined date format.
Inserted dates are checked for consistency prior to saving.
6 Date Time field.
Time can be inserted recurring to a pick list control.
Links to the jsCalendar object.
Inserted dates are checked for consistency prior to saving.
Inserted Date / Time should be later than current ones.
7 Numeric field.
Single line only.
8 Text Area.
Text is saved as a set of comma separated strings.
9 Percent field.
Only accepts values greater than 0 and lower than 100.
10 Relates to other modules entities. A general relate field for entity relationships.
11 Single line text field.
No consistency check performed prior to saving.
12 E-mail field.
Saves a link to the address book e-mail address upon sending a message.
13 E-mail field.
An user provided address is required.
A consistency check is performed prior to message sending.
15 Pick list.
Listed values differ between modules and based upon user role.
16 Pick list.
Listed values differ between modules but not based upon user role.
17 Web link.
No check performed prior to saving.
19 Text Area used for long descriptions.
20 Equals type 19. Field is mandatory.
21 5 rows long text field. Used for addresses and short descriptions.
22 Text Area field specifically used to insert the "Title" field in some modules.
Mandatory field.
23 Date field.
Equals type 5, but it is usually used to insert end dates.
24 Text Area sized around 5 lines. Primarily used to store "Billing Address".
When a contact is selected, the field is automatically filled in with the contact address.
Field is mandatory.
25 Email Status Tracking field. Counts the number of times an email is opened.
26 Documents folder.
Used to select documents for upload.
27 File type.
Shows a pick list on the left side of the control. Selecting a choice, values in the right change accordingly.
28 File name.
File type should be selected in another field.
30 Drop down box used to set the reminder time when creating an activity.
33 Text Area behaving like a pick list. Values can be selected from a predefined list.
Values cannot be edited or inserted anew. only existing choices can be selected.
51 Select an account or a contact from a pop-up window.
52 A drop down combo box used to select users.
The inserted user is the handler for the entity being created.
53 A drop down combo box user to select an user or a group.
List choices can be filtered by users or groups.
55 A pick list used to select a Salutation.
56 Check box that accepts "Yes" / "No" input.
57 Pop-up contact selection window.
255 Salutation.
This is used in the Leads or Contacts module only.


For any feedback, questions, errors and such, please e-mail me at studiosg [at] giustetti [dot] net.


Languages: English - Italiano

Retrieved from "http://www.giustetti.net/wiki/index.php?title=Vtigercrm_widget_type&oldid=676"