[fix] descriptions of form controls events

DHTMLX · Aug 28, 2023 · c0f6f7d · c0f6f7d
1 parent f1cd65b
commit c0f6f7d
Show file tree

Hide file tree

Showing 16 changed files with 17 additions and 17 deletions.
diff --git a/docs/form/api/calendar/calendar_beforechange_event.md b/docs/form/api/calendar/calendar_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Datepicker control of
 @signature: {'beforeChange: (value: string | Date) => boolean | void;'}
 
 @params:
-- `value: string | Date` - the current value of the control
+- `value: string | Date` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/checkbox/checkbox_beforechange_event.md b/docs/form/api/checkbox/checkbox_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Checkbox control of F
 @signature: {'beforeChange: (value: string | boolean) => boolean | void;'}
 
 @params:
-- `value: string | boolean` - the current value of the control
+- `value: string | boolean` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md b/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Checkbox Group contro
 @signature: {'beforeChange: (value: {[id: string]: boolean | string}) => boolean | void;'}
 
 @params:
-- `value: object` - the current value of the control. The object contains a set of <i>key:value</i> pairs where <i>key</i> is the id of a checkbox and <i>value</i> is the value/state of the checkbox.
+- `value: object` - the value to be set for the control. The object contains a set of <i> the key:value</i> pairs where the <i>key</i> is the id of a checkbox and the <i>value</i> is the value/state of the checkbox
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/colorpicker/colorpicker_beforechange_event.md b/docs/form/api/colorpicker/colorpicker_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Colorpicker control o
 @signature: {'beforeChange: (value: string) => boolean | void;'}
 
 @params:
-- `value: string` - the current value of the control
+- `value: string` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/form_beforechange_event.md b/docs/form/api/form_beforechange_event.md
@@ -12,7 +12,7 @@ description: You can explore the beforeChange event of Form in the documentation
 
 @params:
 - `name | id: string` - the name (or id, if the name is not specified) of the Form control
-- `value: any` - the value set for the control
+- `value: any` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/form_blur_event.md b/docs/form/api/form_blur_event.md
@@ -16,7 +16,7 @@ description: You can explore the blur event of Form in the documentation of the
 - `id: string` - optional, the id of the element of the control of Form (for RadioGroup, CheckboxGroup)
 
 @example:
-form.event.on("blur", function(name, value, id) {
+form.events.on("blur", function(name, value, id) {
     console.log(name, value, id);
 });
 @examplestop:

diff --git a/docs/form/api/form_focus_event.md b/docs/form/api/form_focus_event.md
@@ -16,7 +16,7 @@ description: You can explore the focus event of Form in the documentation of the
 - `id: string` - optional, the id of the element of the control of Form (for RadioGroup, CheckboxGroup)
 
 @example:
-form.event.on("focus", function(name, value, id) {
+form.events.on("focus", function(name, value, id) {
     console.log(name, value);
 });
 @examplestop:

diff --git a/docs/form/api/input/input_beforechange_event.md b/docs/form/api/input/input_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Input control of Form
 @signature: {'beforeChange: (value: string | number) => boolean | void;'}
 
 @params:
-- `value: string | number` - the current value of the control
+- `value: string | number` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/radiogroup/radiogroup_beforechange_event.md b/docs/form/api/radiogroup/radiogroup_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Radiogroup control of
 @signature: {'beforeChange: (value: string) => boolean | void;'}
 
 @params:
-- `value: string` - the current value of the control
+- `value: string` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/select/select_beforechange_event.md b/docs/form/api/select/select_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Select control of For
 @signature: {'beforeChange: (value: string | number) => boolean | void;'}
 
 @params:
-- `value: string | number` - the current value of the control
+- `value: string | number` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/slider/slider_beforechange_event.md b/docs/form/api/slider/slider_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Slider control of For
 @signature: {'beforeChange: (value: number[]) => boolean | void;'}
 
 @params:
-- `value: number[]` - the current value of the control
+- `value: number[]` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/textarea/textarea_beforechange_event.md b/docs/form/api/textarea/textarea_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Textarea control of F
 @signature: {'beforeChange: (value: string) => boolean | void;'}
 
 @params:
-- `value: string` - the current value of the control
+- `value: string` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/timepicker/timepicker_beforechange_event.md b/docs/form/api/timepicker/timepicker_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Timepicker control of
 @signature: {'beforeChange: (value: string | object) => boolean | void;'}
 
 @params:
-- `value: string | object` - the current value of the control
+- `value: string | object` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/toggle/toggle_beforechange_event.md b/docs/form/api/toggle/toggle_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Toggle control of For
 @signature: {'beforeChange: (value: string | number | boolean) => boolean | void;'}
 
 @params:
-- `value: string | number | boolean` - the current value of the control
+- `value: string | number | boolean` - the value to be set for the control
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`.

diff --git a/docs/form/api/togglegroup/togglegroup_beforechange_event.md b/docs/form/api/togglegroup/togglegroup_beforechange_event.md
@@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Toggle Group control
 @signature: {'beforeChange: (value: {[id: string]: string | number |boolean}) => boolean | void;'}
 
 @params:
-- `value: object` - the current value of the control. The object contains a set of <i>key:value</i> pairs where <i>key</i> is the id of a toggle and <i>value</i> is the value/state of the toggle
+- `value: object` - the value to be set for the control. The object contains a set of the <i>key:value</i> pairs where the <i>key</i> is the id of a toggle and the <i>value</i> is the value/state of the toggle
 
 @returns:
 Return `false` to prevent changing the value of the control; otherwise, `true`

diff --git a/docs/whatsnew.md b/docs/whatsnew.md
@@ -19,7 +19,7 @@ Released on August 28, 2023
 
 #### DataCollection/TreeCollection
 
-- New [filter](data_collection/api/datacollection_filter_event.md) event and [resetFilter()](data_collection/api/datacollection_resetfilter_method.md), [getFilter()](data_collection/api/datacollection_getfilters_method.md) methods
+- New [filter](data_collection/api/datacollection_filter_event.md) event and [resetFilter()](data_collection/api/datacollection_resetfilter_method.md), [getFilters()](data_collection/api/datacollection_getfilters_method.md) methods
 
 #### Grid/TreeGrid
 
@@ -35,7 +35,7 @@ Released on August 28, 2023
 
 #### Chart
 
-- The [series](chart/api/chart_series_config.md) configuration property is extended with the **label** option for setting the text of the legend for a series (for  "line", "spline", "bar", "x-bar", "area", "splineArea", "radar", "scatter" chart types)
+- The [series](chart/api/chart_series_config.md) configuration property is extended with the **label** option for setting the text of the legend for a series (for the "line", "spline", "bar", "x-bar", "area", "splineArea", "radar", "scatter" chart types)
 
 #### DataCollection/TreeCollection