The <custom> form tag opens up your data-entry forms to an ever-expanding world of custom controls developed for XMod. These custom controls perform differing functions and can greatly enhance your form's functionality. The <custom> tag, working in conjunction with the <register> tag, is used to tell XMod you're using a custom control. It provides some basic information that XMod needs in order to create the control. The custom control may also require additional information. See the custom control's documentation for more details.
|
ref |
Name of the control. XMod uses this value to identify the control. It must be unique within the form. (Required) [String value] Names must begin with a letter and may only include letters, numbers and the underscore character. |
|
tagprefix |
This is the prefix XMod uses to match the control with the assembly that contains the custom control (specified in the <register> tag). (Required) [String value] |
|
name |
The name of the control. This will vary according to which control you're using. For example, if you're using a file upload control from KnowBetter, you're control's declaration might look something like this: <custom tagprefix="kb" name="upload" ref="FileUpload"> .... </custom> |
|
The caption used to identify the control on the form. It is also displayed to the user in other situations such as in a drop-down list box of field names they can sort by. |
Below is a sample for a hypothetical custom control. Notice that you must supply the information required by XMod (ref, tagprefix, name, etc.) and, depending on the control you're using, you may also provide additional attributes and child tag values. XMod-required values are in red and values required by the custom control are in blue.
<custom ref="MyRoles" tagprefix="acme" name="DnnRolePicker" showprivateroles="true" showpublicroles="true" rows="5">
<label>Flavors: </label>
<defaultrole>Registered User</defaultrole>
</custom>