Kentico CMS 7.0 Context Help

General tab

General tab

Previous topic Next topic Mail us feedback on this topic!  

General tab

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

The following properties can be entered when editing a form control on the General tab:

 

Display name

Sets the name of the form control used in the interface, e.g. when selecting a control in the field editor.

Code name

Sets the name of the control that is used as its unique identifier, for example in the API.

Type

Allows the selection of a category under which the form control will be placed. The type can be used to filter form controls.

File name

Contains the relative path to the .ascx file that implements the form control.

 

Example: ~/CMSFormControls/Basic/TextBoxControl.ascx

Inherited from

Shows the name of the form control from which the current one is inherited (if applicable). This field replaces the File name for inherited controls (they use the same source file as their parent).

Description

May be used to enter a text description of the control or comments for other administrators.

High priority

When selecting a form control in the field editor, controls with high priority are offered at the top of the list and highlighted using a colored background.

 

Additionally, only high priority form controls are included among the field type options when using the simple mode of the form field editor provided by the Forms module.

 

This option should only be enabled for those controls that are most commonly used.

 

Use control for:

 

The properties under this section determine for which attribute types the form control should be available. Possible attribute types for fields include standard data types (Text, Long text, Decimal, Integer, Long integer, Boolean, Date-time), as well as the following special options:

 

Visibility

This attribute type is used for controls that modify the visibility options of other fields.

 

Please see the Development -> Membership, permissions and security -> Custom field visibility chapter in the Developer's Guide for more details.

Unique identifier (GUID)

Attributes of this type are 32‑character strings used as globally unique identifiers for objects.

File

Used for fields that provide file management.

Document attachments

This attribute type is used for fields that allow the management of document attachments.

 

Show control in:

 

This section of properties is used to specify in which types of forms the control can be used i.e. where in the user interface it can be selected. The following options are available:

 

Document types

Allows use in document type fields, which can be edited in Site Manager -> Development -> Document types. The actual form is displayed when editing a document on the Form tab in CMS Desk -> Content -> Edit.

Custom tables

Allows the control in custom table fields, which can be edited in Site Manager -> Development -> Custom tables. The corresponding data editing form can be found in CMS Desk -> Tools -> Custom tables.

System tables

Allows use in system table fields, which can be edited in Site Manager -> Development -> System tables. The editing forms of system objects are located in various sections of the administration interface or on the live site, depending on the specific object.

Reports

If checked, the control may be used to provide the interface for entering report parameters, which can be defined when editing a report in CMS Desk -> Tools -> Reporting. The reporting parameter form is displayed when a report is viewed in the interface or published on the live site.

Controls and web parts

Allows the control to be used for the properties of web parts and widgets, as defined in Site Manager -> Development -> Web parts/Widgets. This editing form provides the configuration dialog of individual web parts or widget instances.

Forms

If checked, the control may be used to represent fields of forms, which can be edited in CMS Desk -> Tools -> Forms. The High priority flag of the form control also needs to be enabled if you wish to have it offered in the form field editor's simple mode.

 

If you allow a form control for forms, you also need to enter the following default values that will be used if the field is edited in simple mode:

 

Default data type - the data type of the field that will be used by default when a user chooses to create a new field of this type.

Column size - only applies to the Text data type. This sets the maximum size of the database column used to store the field, which also limits amount of characters that may be entered into the field.

 

More resources can be found in:

 

Developer's Guide -> Development -> Form controls

Developer's Guide -> Development -> Form controls -> Developing form controls