Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Describe onSelectionChanging event #6722

Merged
merged 8 commits into from
Oct 21, 2024
Merged

Describe onSelectionChanging event #6722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c7b192b
Describe onSelectionChanging event
vladaskorohodova Oct 17, 2024
d36d552
Minor fix
vladaskorohodova Oct 17, 2024
67a2fea
Add type descriotions
vladaskorohodova Oct 17, 2024
92f6fe0
Add List info
vladaskorohodova Oct 17, 2024
49e3984
Update after review
vladaskorohodova Oct 18, 2024
a43f37d
Apply suggestions from code review
vladaskorohodova Oct 21, 2024
a698412
Apply suggestions from code review
vladaskorohodova Oct 21, 2024
b63e5aa
Update after review
vladaskorohodova Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...ference/10 UI Components/CollectionWidget/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ default: null
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is called after selection changes.

##### param(e): Object
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -23,7 +23,7 @@ The UI component's instance.
Model data. Available only if you use Knockout.

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
16 changes: 8 additions & 8 deletions ...erence/10 UI Components/CollectionWidget/1 Configuration/onSelectionChanging.md
View file
Open in desktop
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 called before selection changes.

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

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

##### 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 removed from selection.

##### 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
Open in desktop
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 selection changes.

---
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
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ type: eventType
---
---
##### shortDescription
<!-- Description goes here -->
Raised before selection changes.

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

#####See Also#####
#include common-link-handleevents
4 changes: 2 additions & 2 deletions api-reference/10 UI Components/dxAccordion/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A function that is executed when a collection item is selected or selection is c
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,6 +19,6 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
4 changes: 2 additions & 2 deletions api-reference/10 UI Components/dxContextMenu/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A function that is executed when a collection item is selected or selection is c
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
4 changes: 2 additions & 2 deletions api-reference/10 UI Components/dxGallery/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A function that is executed when a collection item is selected or selection is c
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
6 changes: 3 additions & 3 deletions api-reference/10 UI Components/dxList/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ type: function(e)
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is called after selection changes.

##### param(e): ui/list:SelectionChangedEvent
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,6 +19,6 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxList/1 Configuration/onSelectionChanging.md
View file
Open in desktop
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 called before selection changes.

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

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

##### 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 removed from selection.

---
<!-- Description goes here -->
2 changes: 1 addition & 1 deletion ...0 UI Components/dxList/9 Types/SelectionChangingEvent/SelectionChangingEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ generateTypeLink:
---
---
##### shortDescription
<!-- Description goes here -->
The type of the [selectionChanging]({basewidgetpath}/Events/#selectionChanging) event handler's argument.

---
<!-- Description goes here -->
4 changes: 2 additions & 2 deletions api-reference/10 UI Components/dxMenu/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A function that is executed when a collection item is selected or selection is c
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

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

This file was deleted.

4 changes: 2 additions & 2 deletions api-reference/10 UI Components/dxMultiView/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A function that is executed when a collection item is selected or selection is c
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
6 changes: 3 additions & 3 deletions api-reference/10 UI Components/dxTabPanel/1 Configuration/onSelectionChanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ type: function(e)
---
---
##### shortDescription
A function that is executed when a collection item is selected or selection is canceled.
A function that is called after selection changes.

##### param(e): ui/tab_panel:SelectionChangedEvent
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxTabPanel/1 Configuration/onSelectionChanging.md
View file
Open in desktop
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 called before selection changes.

##### 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 selected items.

##### 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 removed from selection.

---
<!-- Description goes here -->
2 changes: 1 addition & 1 deletion ... Components/dxTabPanel/9 Types/SelectionChangingEvent/SelectionChangingEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ generateTypeLink:
---
---
##### shortDescription
<!-- Description goes here -->
The type of the [selectionChanging]({basewidgetpath}/Events/#selectionChanging) event handler's argument.

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

##### param(e): ui/tabs:SelectionChangedEvent
Information about the event.

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

##### field(e.component): {WidgetName}
The UI component's instance.
Expand All @@ -19,7 +19,7 @@ The UI component's instance.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.removedItems): Array<any>
The data of the items whose selection has been canceled.
The data of the items removed from selection.

---
<!-- Description goes here -->
14 changes: 7 additions & 7 deletions api-reference/10 UI Components/dxTabs/1 Configuration/onSelectionChanging.md
View file
Open in desktop
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 called before selection changes.

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

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

##### 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 removed from selection.

---
<!-- Description goes here -->
2 changes: 1 addition & 1 deletion ...0 UI Components/dxTabs/9 Types/SelectionChangingEvent/SelectionChangingEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ generateTypeLink:
---
---
##### shortDescription
<!-- Description goes here -->
The type of the [selectionChanging]({basewidgetpath}/Events/#selectionChanging) event handler's argument.

---
<!-- Description goes here -->
Loading
Loading