1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>CustomField
</class>
6 <name>civicrm_custom_field
</name>
7 <comment>Stores info about an extended (custom) property (data and form field info).
</comment>
12 <type>int unsigned
</type>
13 <required>true
</required>
14 <comment>Unique Custom Field ID
</comment>
19 <autoincrement>true
</autoincrement>
22 <name>custom_group_id
</name>
23 <type>int unsigned
</type>
24 <required>true
</required>
25 <comment>FK to civicrm_custom_group.
</comment>
28 <table>civicrm_custom_group
</table>
29 <keyColumn>id
</keyColumn>
30 <labelColumn>title
</labelColumn>
37 <name>custom_group_id
</name>
38 <table>civicrm_custom_group
</table>
41 <onDelete>CASCADE
</onDelete>
47 <comment>Variable name/programmatic handle for this group.
</comment>
54 <required>true
</required>
55 <localizable>true
</localizable>
56 <comment>Text for form field label (also friendly name for administering this custom property).
</comment>
60 <name>data_type
</name>
63 <required>true
</required>
64 <comment>Controls location of data storage in extended_data table.
</comment>
66 <callback>CRM_Core_BAO_CustomField::dataType
</callback>
74 <name>html_type
</name>
77 <required>true
</required>
78 <comment>HTML types plus several built-in extended types.
</comment>
80 <callback>CRM_Core_BAO_CustomField::dataToHtml
</callback>
85 <name>default_value
</name>
88 <comment>Use form_options.is_default for field_types which use options.
</comment>
92 <name>is_required
</name>
94 <comment>Is a value required for this property.
</comment>
98 <name>is_searchable
</name>
100 <comment>Is this property searchable.
</comment>
104 <name>is_search_range
</name>
106 <comment>Is this property range searchable.
</comment>
113 <required>true
</required>
115 <comment>Controls field display order within an extended property group.
</comment>
119 <name>help_pre
</name>
121 <localizable>true
</localizable>
122 <comment>Description and/or help text to display before this field.
</comment>
126 <name>help_post
</name>
128 <localizable>true
</localizable>
129 <comment>Description and/or help text to display after this field.
</comment>
136 <comment>Optional format instructions for specific field types, like date types.
</comment>
140 <name>attributes
</name>
143 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
147 <name>javascript
</name>
150 <comment>Optional scripting attributes for field.
</comment>
154 <name>is_active
</name>
156 <comment>Is this property active?
</comment>
162 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
166 <name>options_per_line
</name>
167 <type>int unsigned
</type>
168 <comment>number of options per line for checkbox and radio
</comment>
171 <name>text_length
</name>
172 <type>int unsigned
</type>
173 <comment>field length if alphanumeric
</comment>
177 <name>start_date_years
</name>
179 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
183 <name>end_date_years
</name>
185 <comment>Date may be up to end_date_years years after the current date.
</comment>
189 <name>date_parts
</name>
192 <comment>which date part included in display
</comment>
197 <name>date_format
</name>
200 <comment>date format for custom date
</comment>
204 <name>time_format
</name>
205 <type>int unsigned
</type>
206 <comment>time format for custom date
</comment>
210 <name>note_columns
</name>
211 <type>int unsigned
</type>
212 <comment> Number of columns in Note Field
</comment>
216 <name>note_rows
</name>
217 <type>int unsigned
</type>
218 <comment> Number of rows in Note Field
</comment>
222 <name>column_name
</name>
225 <comment>Name of the column that holds the values for this field.
</comment>
229 <name>option_group_id
</name>
230 <type>int unsigned
</type>
231 <comment>For elements with options, the option group id that is used
</comment>
238 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
242 <name>in_selector
</name>
245 <comment>Should the multi-record custom field values be displayed in tab table listing
</comment>
249 <name>UI_label_custom_group_id
</name>
250 <fieldName>label
</fieldName>
251 <fieldName>custom_group_id
</fieldName>
252 <unique>true
</unique>
256 <name>UI_name_custom_group_id
</name>
257 <fieldName>name
</fieldName>
258 <fieldName>custom_group_id
</fieldName>
259 <unique>true
</unique>