Skip to content

Commit

Permalink
Describe onSelectionChanging event
Browse files Browse the repository at this point in the history
  • Loading branch information
@vladaskorohodova
vladaskorohodova committed Oct 17, 2024
1 parent 71c3937 commit c7b192b
Show file tree
Hide file tree
Showing 12 changed files with 39 additions and 51 deletions.
2 changes: 1 addition & 1 deletion ...ference/10 UI Components/CollectionWidget/1 Configuration/onSelectionChanged.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default: null
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is executed after a collection item is selected or selection is canceled.

##### param(e): Object
Information about the event.
Expand Down
16 changes: 8 additions & 8 deletions ...erence/10 UI Components/CollectionWidget/1 Configuration/onSelectionChanging.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@ default: null
---
---
##### shortDescription
<!-- Description goes here -->
A function that is executed before a collection item is selected or selection is canceled.

##### param(e): Object
<!-- Description goes here -->
Information about the event.

##### field(e.addedItems): Array<any>
<!-- Description goes here -->
The data of the items that have been selected.

##### field(e.cancel): Boolean | Promise<Boolean>
<!-- Description goes here -->
Allows you to cancel selection.

##### field(e.component): {WidgetName}
<!-- Description goes here -->
The UI component's instance.

##### field(e.element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
<!-- Description goes here -->
The data of the items whose selection has been canceled.

##### field(e.model): any
<!-- Description goes here -->
Model data. Available only if you use Knockout.

---
<!-- Description goes here -->
2 changes: 1 addition & 1 deletion api-reference/10 UI Components/CollectionWidget/4 Events/selectionChanged.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: eventType
---
---
##### shortDescription
Raised when a collection item is selected or selection is canceled.
Raised after a collection item is selected or selection is canceled.

---
Main article: [onSelectionChanged](/api-reference/10%20UI%20Components/CollectionWidget/1%20Configuration/onSelectionChanged.md '{basewidgetpath}/Configuration/#onSelectionChanged')
Expand Down
7 changes: 5 additions & 2 deletions api-reference/10 UI Components/CollectionWidget/4 Events/selectionChanging.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ type: eventType
---
---
##### shortDescription
<!-- Description goes here -->
123 Raised before a collection item is selected or selection is canceled.

---
<!-- Description goes here -->
Main article: [onSelectionChanging]({basewidgetpath}/Configuration/#onSelectionChanged)

#####See Also#####
#include common-link-handleevents
2 changes: 1 addition & 1 deletion api-reference/10 UI Components/dxList/1 Configuration/onSelectionChanged.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: function(e)
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is executed after a collection item is selected or selection is canceled.

##### param(e): ui/list:SelectionChangedEvent
Information about the event.
Expand Down
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxList/1 Configuration/onSelectionChanging.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ type: function(e)
---
---
##### shortDescription
<!-- Description goes here -->
A function that is executed before a collection item is selected or selection is canceled.

##### param(e): ui/list:SelectionChangingEvent
<!-- Description goes here -->
Information about the event.

##### field(e.addedItems): Array<any>
<!-- Description goes here -->
The data of the items that have been selected.

##### field(e.cancel): Boolean | Promise<Boolean>
<!-- Description goes here -->
Allows you to cancel selection.

##### field(e.component): {WidgetName}
<!-- Description goes here -->
The UI component's instance.

##### field(e.element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
<!-- Description goes here -->
The data of the items whose selection has been canceled.

---
<!-- Description goes here -->
5 changes: 0 additions & 5 deletions api-reference/10 UI Components/dxMenu/4 Events/selectionChange.md
View file

This file was deleted.

2 changes: 1 addition & 1 deletion api-reference/10 UI Components/dxTabPanel/1 Configuration/onSelectionChanged.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: function(e)
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is executed after a collection item is selected or selection is canceled.

##### param(e): ui/tab_panel:SelectionChangedEvent
Information about the event.
Expand Down
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxTabPanel/1 Configuration/onSelectionChanging.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ type: function(e)
---
---
##### shortDescription
<!-- Description goes here -->
A function that is executed before a collection item is selected or selection is canceled.

##### param(e): ui/tab_panel:SelectionChangingEvent
<!-- Description goes here -->
Information about the event.

##### field(e.addedItems): Array<any>
<!-- Description goes here -->
The data of the items that have been selected.

##### field(e.cancel): Boolean | Promise<Boolean>
<!-- Description goes here -->
Allows you to cancel selection.

##### field(e.component): {WidgetName}
<!-- Description goes here -->
The UI component's instance.

##### field(e.element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
<!-- Description goes here -->
The data of the items whose selection has been canceled.

---
<!-- Description goes here -->
2 changes: 1 addition & 1 deletion api-reference/10 UI Components/dxTabs/1 Configuration/onSelectionChanged.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: function(e)
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is executed after a collection item is selected or selection is canceled.

##### param(e): ui/tabs:SelectionChangedEvent
Information about the event.
Expand Down
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxTabs/1 Configuration/onSelectionChanging.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ type: function(e)
---
---
##### shortDescription
<!-- Description goes here -->
A function that is executed before a collection item is selected or selection is canceled.

##### param(e): ui/tabs:SelectionChangingEvent
<!-- Description goes here -->
Information about the event.

##### field(e.addedItems): Array<any>
<!-- Description goes here -->
The data of the items that have been selected.

##### field(e.cancel): Boolean | Promise<Boolean>
<!-- Description goes here -->
Allows you to cancel selection.

##### field(e.component): {WidgetName}
<!-- Description goes here -->
The UI component's instance.

##### field(e.element): DxElement
<!-- Description goes here -->
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
<!-- Description goes here -->
The data of the items whose selection has been canceled.

---
<!-- Description goes here -->
10 changes: 0 additions & 10 deletions api-reference/10 UI Components/dxTagBox/4 Events/selectionChanging.md
View file

This file was deleted.

0 comments on commit c7b192b

Please sign in to comment.