|
18 | 18 | </Interface> |
19 | 19 | </Interfaces> |
20 | 20 | <Docs> |
21 | | - <summary>To be added.</summary> |
22 | | - <remarks>To be added.</remarks> |
| 21 | + <summary>A task dialog allows to display information and get simple input from the user. It is similar to a <see cref="T:System.Windows.Forms.MessageBox" /> (in that it is formatted by the operating system) but provides a lot more features.</summary> |
| 22 | + <remarks> |
| 23 | + <format type="text/markdown"> |
| 24 | + <. |
| 29 | +
|
| 30 | +> [!NOTE] |
| 31 | +> In order to use the dialog, you need ensure <xref:System.Windows.Forms.Application.EnableVisualStyles> has been called before showing the dialog, or the application needs to be compiled with a manifest that contains a dependency to Microsoft.Windows.Common-Controls (6.0.0.0). |
| 32 | +> Additionally, the current thread should use the single-threaded apartment (STA) model. |
| 33 | +
|
| 34 | + ]]></format> |
| 35 | + </remarks> |
23 | 36 | </Docs> |
24 | 37 | <Members> |
25 | 38 | <Member MemberName="Close"> |
|
39 | 52 | </ReturnValue> |
40 | 53 | <Parameters /> |
41 | 54 | <Docs> |
42 | | - <summary>To be added.</summary> |
43 | | - <remarks>To be added.</remarks> |
| 55 | + <summary>Closes the shown task dialog with <see cref="P:System.Windows.Forms.TaskDialogButton.Cancel" /> as resulting button.</summary> |
| 56 | + <remarks> |
| 57 | + <format type="text/markdown"><![CDATA[ |
| 58 | +
|
| 59 | +## Remarks |
| 60 | +
|
| 61 | + To close the dialog with a different result, call the <xref:System.Windows.Forms.TaskDialogButton.PerformClick> method of the <xref:System.Windows.Forms.TaskDialogButton> that you want to set as a result. |
| 62 | +
|
| 63 | + This method can be called while the dialog is waiting for navigation to complete, whereas <xref:System.Windows.Forms.TaskDialogButton.PerformClick> would throw in that case. When calling this method, the <xref:System.Windows.Forms.TaskDialogButton.Click> event won't be raised. |
| 64 | +
|
| 65 | + ]]></format> |
| 66 | + </remarks> |
44 | 67 | </Docs> |
45 | 68 | </Member> |
46 | 69 | <Member MemberName="Handle"> |
|
62 | 85 | <ReturnType>System.IntPtr</ReturnType> |
63 | 86 | </ReturnValue> |
64 | 87 | <Docs> |
65 | | - <summary>To be added.</summary> |
| 88 | + <summary>Gets the window handle of the task dialog window, or <see cref="F:System.IntPtr.Zero" /> if the dialog is currently not being shown.</summary> |
66 | 89 | <value>To be added.</value> |
67 | 90 | <remarks>To be added.</remarks> |
68 | 91 | </Docs> |
|
86 | 109 | <Parameter Name="startupLocation" Type="System.Windows.Forms.TaskDialogStartupLocation" /> |
87 | 110 | </Parameters> |
88 | 111 | <Docs> |
89 | | - <param name="page">To be added.</param> |
90 | | - <param name="startupLocation">To be added.</param> |
91 | | - <summary>To be added.</summary> |
92 | | - <returns>To be added.</returns> |
93 | | - <remarks>To be added.</remarks> |
| 112 | + <param name="page">The page instance that contains the contents which this task dialog will display.</param> |
| 113 | + <param name="startupLocation">Gets or sets the position of the task dialog when it is shown.</param> |
| 114 | + <summary>Shows the task dialog.</summary> |
| 115 | + <returns>The <see cref="T:System.Windows.Forms.TaskDialogButton" /> which was clicked by the user to close the dialog.</returns> |
| 116 | + <remarks> |
| 117 | + <format type="text/markdown"><![CDATA[ |
| 118 | +
|
| 119 | +## Remarks |
| 120 | +
|
| 121 | + Showing the dialog will bind the `page` and its controls until this method returns or the dialog is navigated to a different page. |
| 122 | +
|
| 123 | + ]]></format> |
| 124 | + </remarks> |
| 125 | + <exception cref="T:System.ArgumentNullException"> |
| 126 | + <paramref name="page" /> is <see langword="null" />.</exception> |
| 127 | + <exception cref="T:System.InvalidOperationException">The specified <paramref name="page" /> contains an invalid configuration.</exception> |
94 | 128 | </Docs> |
95 | 129 | </Member> |
96 | 130 | <Member MemberName="ShowDialog"> |
|
113 | 147 | <Parameter Name="startupLocation" Type="System.Windows.Forms.TaskDialogStartupLocation" /> |
114 | 148 | </Parameters> |
115 | 149 | <Docs> |
116 | | - <param name="hwndOwner">To be added.</param> |
117 | | - <param name="page">To be added.</param> |
118 | | - <param name="startupLocation">To be added.</param> |
119 | | - <summary>To be added.</summary> |
120 | | - <returns>To be added.</returns> |
121 | | - <remarks>To be added.</remarks> |
| 150 | + <param name="hwndOwner">The handle of the owner window, or <see cref="F:System.IntPtr.Zero" /> to show a modeless dialog.</param> |
| 151 | + <param name="page">The page instance that contains the contents which this task dialog will display.</param> |
| 152 | + <param name="startupLocation">Gets or sets the position of the task dialog when it is shown.</param> |
| 153 | + <summary>Shows the task dialog with the specified owner.</summary> |
| 154 | + <returns>The <see cref="T:System.Windows.Forms.TaskDialogButton" /> which was clicked by the user to close the dialog.</returns> |
| 155 | + <remarks> |
| 156 | + <format type="text/markdown"><![CDATA[ |
| 157 | +
|
| 158 | +## Remarks |
| 159 | +
|
| 160 | + Showing the dialog will bind the `page` and its controls until this method returns or the dialog is navigated to a different page. |
| 161 | +
|
| 162 | + ]]></format> |
| 163 | + </remarks> |
| 164 | + <exception cref="T:System.ArgumentNullException"> |
| 165 | + <paramref name="page" /> is <see langword="null" />.</exception> |
| 166 | + <exception cref="T:System.InvalidOperationException">The specified <paramref name="page" /> contains an invalid configuration.</exception> |
122 | 167 | </Docs> |
123 | 168 | </Member> |
124 | 169 | <Member MemberName="ShowDialog"> |
|
141 | 186 | <Parameter Name="startupLocation" Type="System.Windows.Forms.TaskDialogStartupLocation" /> |
142 | 187 | </Parameters> |
143 | 188 | <Docs> |
144 | | - <param name="owner">To be added.</param> |
145 | | - <param name="page">To be added.</param> |
146 | | - <param name="startupLocation">To be added.</param> |
147 | | - <summary>To be added.</summary> |
148 | | - <returns>To be added.</returns> |
149 | | - <remarks>To be added.</remarks> |
| 189 | + <param name="owner">The owner window, or <see langword="null" /> to show a modeless dialog.</param> |
| 190 | + <param name="page">The page instance that contains the contents which this task dialog will display.</param> |
| 191 | + <param name="startupLocation">Gets or sets the position of the task dialog when it is shown.</param> |
| 192 | + <summary>Shows the task dialog with the specified owner.</summary> |
| 193 | + <returns>The <see cref="T:System.Windows.Forms.TaskDialogButton" /> which was clicked by the user to close the dialog.</returns> |
| 194 | + <remarks> |
| 195 | + <format type="text/markdown"><![CDATA[ |
| 196 | +
|
| 197 | +## Remarks |
| 198 | +
|
| 199 | + Showing the dialog will bind the `page` and its controls until this method returns or the dialog is navigated to a different page. |
| 200 | +
|
| 201 | + ]]></format> |
| 202 | + </remarks> |
| 203 | + <exception cref="T:System.ArgumentNullException"> |
| 204 | + <paramref name="owner" /> is <see langword="null" /> - or - <paramref name="page" /> is <see langword="null" />.</exception> |
| 205 | + <exception cref="T:System.InvalidOperationException">The specified <paramref name="page" /> contains an invalid configuration.</exception> |
150 | 206 | </Docs> |
151 | 207 | </Member> |
152 | 208 | </Members> |
|
0 commit comments