aboutsummaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.form/-form/add-custom.html
blob: 8c3f99780ab30f7de65eb70b3a2bce3b2adf1508 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Form.addCustom - kvision</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.form</a>&nbsp;/&nbsp;<a href="index.html">Form</a>&nbsp;/&nbsp;<a href="./add-custom.html">addCustom</a><br/>
<br/>
<h1>addCustom</h1>
<a name="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))"></a>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">C</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-string-form-control/index.html"><span class="identifier">StringFormControl</span></a><span class="symbol">&gt;</span> <span class="identifier">addCustom</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/key">key</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property1/index.html"><span class="identifier">KProperty1</span></a><span class="symbol">&lt;</span><a href="index.html#K"><span class="identifier">K</span></a><span class="symbol">,</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/control">control</span><span class="symbol">:</span>&nbsp;<a href="add-custom.html#C"><span class="identifier">C</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/required">required</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/requiredMessage">requiredMessage</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/validatorMessage">validatorMessage</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">(</span><a href="add-custom.html#C"><span class="identifier">C</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.Form$addCustom(kotlin.reflect.KProperty1((pl.treksoft.kvision.form.Form.K, kotlin.Any)), pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean, kotlin.String, kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.Form.addCustom.C, kotlin.Boolean)))/validator">validator</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">(</span><a href="add-custom.html#C"><span class="identifier">C</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Form</span></a><span class="symbol">&lt;</span><a href="index.html#K"><span class="identifier">K</span></a><span class="symbol">&gt;</span></code>
<p>Adds a string control to the form bound to custom field type.</p>
<h3>Parameters</h3>
<p><a name="key"></a>
<code>key</code> - key identifier of the control</p>
<p><a name="control"></a>
<code>control</code> - the string form control</p>
<p><a name="required"></a>
<code>required</code> - determines if the control is required</p>
<p><a name="requiredMessage"></a>
<code>requiredMessage</code> - optional required validation message</p>
<p><a name="validatorMessage"></a>
<code>validatorMessage</code> - optional function returning validation message</p>
<p><a name="validator"></a>
<code>validator</code> - optional validation function</p>
<p><strong>Return</strong><br/>
current form</p>
</BODY>
</HTML>