You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/dockmanager/events.md
+29-12Lines changed: 29 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ This article explains the events available in the Telerik DockManager for Blazor
16
16
*[OnUndock](#ondock)
17
17
*[VisibleChanged](#visiblechanged)
18
18
*[SizeChanged](#sizechanged)
19
+
*[UnpinnedChanged](#unpinnedchanged)
19
20
*[UnpinnedSizeChanged](#unpinnedsizechanged)
20
21
*[OnPaneResize](#onpaneresize)
21
22
*[State Events](#state-events)
@@ -24,7 +25,7 @@ This article explains the events available in the Telerik DockManager for Blazor
24
25
25
26
## OnDock
26
27
27
-
The `OnDock` event is fired when any pane is docked.
28
+
The `OnDock` event fires when any pane is docked.
28
29
29
30
The event handler receives as an argument an `DockManagerDockEventArgs` object that contains:
30
31
@@ -37,7 +38,7 @@ The event handler receives as an argument an `DockManagerDockEventArgs` object t
37
38
38
39
## OnUndock
39
40
40
-
The `OnUndock` event is fired when any pane is undocked.
41
+
The `OnUndock` event fires when any pane is undocked.
41
42
42
43
The event handler receives as an argument an `DockManagerUndockEventArgs` object that contains:
43
44
@@ -48,19 +49,23 @@ The event handler receives as an argument an `DockManagerUndockEventArgs` object
48
49
49
50
## VisibleChanged
50
51
51
-
The `VisibleChanged` event is fired when the user tries to hide a given pane. You can effectively cancel the event by not propagating the new visibility state to the variable the `Visible` property is bound to. This is the way to cancel the event and keep the pane visible.
52
+
The `VisibleChanged` event fires when the user tries to hide a given pane. You can effectively cancel the event by not propagating the new visibility state to the variable the `Visible` property is bound to. This is the way to cancel the event and keep the pane visible.
52
53
53
54
## SizeChanged
54
55
55
-
The `SizeChanged` event is triggered when the `Size` parameter of the corresponding pane is changed.
56
+
The `SizeChanged` event fireswhen the `Size` parameter of the corresponding pane changes.
57
+
58
+
## UnpinnedChanged
59
+
60
+
The `UnpinnedChanged` event fireswhen the `Unpinned` parameter of the corresponding pane changes.
56
61
57
62
## UnpinnedSizeChanged
58
63
59
-
The `UnpinnedSizeChanged` event is triggered when the `UnpinnedSize` parameter of the corresponding pane is changed.
64
+
The `UnpinnedSizeChanged` event fires when the `UnpinnedSize` parameter of the corresponding pane changes.
60
65
61
66
## OnPaneResize
62
67
63
-
The `OnPaneResize` event is fired when a pane is resized, except unpinned panes. It lets you respond to that change if needed - for example, call the `.Refresh()` method of a chart or otherwise repaint a child component in the content. You can also use it to, for example, update the saved [state](slug:dockmanager-state) for your users.
68
+
The `OnPaneResize` event fires when a pane is resized, except unpinned panes. It lets you respond to that change if needed - for example, call the `.Refresh()` method of a chart or otherwise repaint a child component in the content. You can also use it to, for example, update the saved [state](slug:dockmanager-state) for your users.
64
69
65
70
The event handler receives as an argument an `DockManagerPaneResizeEventArgs` object that contains:
66
71
@@ -81,7 +86,7 @@ Review the [DockManager state](slug:dockmanager-state) article for more details
81
86
82
87
## OnPin
83
88
84
-
The `OnPin` event is fired when any pane is pinned.
89
+
The `OnPin` event fires when any pane is pinned.
85
90
86
91
The event handler receives as an argument an `DockManagerPinEventArgs` object that contains:
87
92
@@ -92,7 +97,7 @@ The event handler receives as an argument an `DockManagerPinEventArgs` object th
92
97
93
98
## OnUnpin
94
99
95
-
The `OnUnpin` event is fired when any pane is unpinned.
100
+
The `OnUnpin` event fires when any pane is unpinned.
96
101
97
102
The event handler receives as an argument an `DockManagerUnpinEventArgs` object that contains:
98
103
@@ -124,13 +129,17 @@ The event handler receives as an argument an `DockManagerUnpinEventArgs` object
124
129
<DockManagerContentPane HeaderText="Pane 1"
125
130
Id="Pane1"
126
131
Size="50%"
132
+
Unpinned="@Pane1Unpinned"
133
+
UnpinnedChanged="@Pane1UnpinnedChanged"
127
134
UnpinnedSize="@Pane1UnpinnedSize"
128
135
UnpinnedSizeChanged="@Pane1UnpinnedSizeChanged"
129
136
Closeable="false">
130
137
<Content>
131
138
Pane 1. Undocking is allowed. Docking over it is cancelled.
132
-
<code>UnpinnedSizeChanged</code> is handled.
133
-
Current <code>UnpinnedSize</code>: <strong>@Pane1UnpinnedSize</strong>
139
+
<code>UnpinnedChanged</code> and <code>UnpinnedSizeChanged</code> are handled.
140
+
Current
141
+
<code>UnpinnedSize</code>:
142
+
<strong>@Pane1UnpinnedSize</strong>
134
143
</Content>
135
144
</DockManagerContentPane>
136
145
@@ -206,6 +215,7 @@ The event handler receives as an argument an `DockManagerUnpinEventArgs` object
Copy file name to clipboardExpand all lines: components/dockmanager/overview.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,49 +119,49 @@ The following table lists the Dock Manager parameters. Also check the [DockManag
119
119
120
120
| Parameter | Type and Default Value | Description |
121
121
| --- | --- | --- |
122
-
|`AllowFloat`|`bool`<br /> (`false`) | Determines whether the pane can be dragged from the dock manager layout to create a new floating pane. |
122
+
|`AllowFloat`|`bool`| Determines whether the pane can be dragged from the dock manager layout to create a new floating pane. |
123
123
|`Class`|`string`| The custom CSS class of the `<div class="k-pane-scrollable">` element. Use it to [override theme styles](slug:themes-override). |
124
-
|`Closeable`|`bool`<br /> (`false`) | Determines whether the pane can be closed. |
125
-
|`Dockable`|`bool`<br /> (`false`) | Specifies whether the pane allows other panes to be docked to or over it. This determines if the end user can drop other panes over it or next to it, creating a DockManagerSplitPane (Splitter) or a DockManagerTabGroupPane (TabStrip). |
124
+
|`Closeable`|`bool`| Determines whether the pane can be closed. |
125
+
|`Dockable`|`bool`| Specifies whether the pane allows other panes to be docked to or over it. This determines if the end user can drop other panes over it or next to it, creating a DockManagerSplitPane (Splitter) or a DockManagerTabGroupPane (TabStrip). |
126
126
|`HeaderText`|`string`| The pane title, displayed in the pane header and as the button text in the DockManager toolbar when the pane is unpinned. |
127
127
|`Id`|`string` <br /> (`Guid`) | The id of the pane. |
128
-
|`Maximizable`|`bool`<br /> (`false`) | Determines whether the pane can be maximized. |
129
-
|`Size`|`string`| Determines the size of the splitter pane. |
130
-
|`Unpinnable`|`bool`<br /> (`false`) | Determines whether the pane can be unpinned. |
131
-
|`Unpinned`|`bool`<br /> (`true`) | Determines whether the pane is unpinned. |
132
-
|`UnpinnedSize`|`string`| Determines the size of the splitter pane when it is unpinned. |
133
-
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. |
128
+
|`Maximizable`|`bool`| Determines whether the pane can be maximized. |
129
+
|`Size`|`string`| Determines the size of the splitter pane. Supports two-way binding. |
130
+
|`Unpinnable`|`bool`| Determines whether the pane can be unpinned. |
131
+
|`Unpinned`|`bool`| Determines whether the pane is unpinned. Supports two-way binding. |
132
+
|`UnpinnedSize`|`string`| Determines the size of the splitter pane when it is unpinned. Supports two-way binding. |
133
+
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. Supports two-way binding. |
134
134
135
135
### DockManagerSplitPane Parameters
136
136
137
137
| Parameter | Type and Default Value | Description |
138
138
| --- | --- | --- |
139
-
|`AllowEmpty`|`bool`<br /> (`false`) | Determines whether a splitter pane is shown as empty when a child pane is removed (dragged out, closed, etc.). If set to false, the splitter is re-rendered without the removed child pane. |
139
+
|`AllowEmpty`|`bool`| Determines whether a splitter pane is shown as empty when a child pane is removed (dragged out, closed, etc.). If set to false, the splitter is re-rendered without the removed child pane. |
140
140
|`Class`|`string`| The custom CSS class of the `<div class="k-dock-manager-splitter">` element. Use it to [override theme styles](slug:themes-override). |
141
141
|`Id`|`string` <br /> (`Guid`) | The id of the pane. |
142
142
|`Orientation`|`DockManagerPaneOrientation` enum <br /> (`Vertical`) | Determines the orientation of the rendered splitter. |
143
-
|`Size`|`string`| Determines the size of the splitter pane. |
144
-
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. |
143
+
|`Size`|`string`| Determines the size of the splitter pane. Supports two-way binding. |
144
+
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. Supports two-way binding. |
145
145
146
146
#### DockManagerSplitPane Parameters (only when defined as a floating pane)
147
147
148
148
| Parameter | Type and Default Value | Description |
149
149
| --- | --- | --- |
150
-
|`FloatingHeight`|`string`| The height of the rendered window. |
151
-
|`FloatingLeft`|`string`| The CSS `left` value of the rendered window, relative to the dock manager element (`k-dockmanager`) |
150
+
|`FloatingHeight`|`string`| The height of the rendered window. Supports two-way binding. |
151
+
|`FloatingLeft`|`string`| The CSS `left` value of the rendered window, relative to the dock manager element (`k-dockmanager`). Supports two-way binding.|
152
152
|`FloatingResizable`|`bool` <br /> (`true`) | Determines whether the rendered window is resizable. |
153
-
|`FloatingTop`|`string`| The CSS `top` value of the rendered window, relative to the dock manager element (`k-dockmanager`) |
154
-
|`FloatingWidth`|`string`| The width of the rendered window. |
153
+
|`FloatingTop`|`string`| The CSS `top` value of the rendered window, relative to the dock manager element (`k-dockmanager`). Supports two-way binding.|
154
+
|`FloatingWidth`|`string`| The width of the rendered window. Supports two-way binding. |
155
155
156
156
### DockManagerTabGroupPane Parameters
157
157
158
158
| Parameter | Type and Default Value | Description |
159
159
| --- | --- | --- |
160
-
|`AllowEmpty`|`bool`<br /> (`false`) | Determines whether an empty space is left when all tabs are removed (unpinned, closed, etc.), allowing you to drop content panes and create a new tab. |
160
+
|`AllowEmpty`|`bool`| Determines whether an empty space is left when all tabs are removed (unpinned, closed, etc.), allowing you to drop content panes and create a new tab. |
161
161
|`Id`|`string` <br /> (`Guid`) | The id of the pane. |
162
162
|`SelectedPaneId`|`int`| The `id` of the initially selected tab pane. |
163
-
|`Size`|`string`| Determines the size of the splitter pane. |
164
-
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. |
163
+
|`Size`|`string`| Determines the size of the splitter pane. Supports two-way binding. |
164
+
|`Visible`|`bool` <br /> (`true`) | Determines whether the tab/pane is rendered. Supports two-way binding. |
0 commit comments