Skip to content

Commit 71fee8d

Browse files
authored
Add IOEs for DataGridView apis (dotnet#4828)
1 parent 932c562 commit 71fee8d

5 files changed

+29
-8
lines changed

xml/System.Windows.Forms/DataGridViewButtonCell+DataGridViewButtonCellAccessibleObject.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
</ReturnValue>
131131
<Parameters />
132132
<Docs>
133-
<summary>Performs the default action of the <see cref="T:System.Windows.Forms.DataGridViewButtonCell.DataGridViewButtonCellAccessibleObject" /></summary>
133+
<summary>Performs the default action of the <see cref="T:System.Windows.Forms.DataGridViewButtonCell.DataGridViewButtonCellAccessibleObject" />.</summary>
134134
<remarks>
135135
<format type="text/markdown"><![CDATA[
136136
@@ -143,7 +143,11 @@
143143

144144
-or-
145145

146-
The <see cref="T:System.Windows.Forms.DataGridViewButtonCell" /> returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property belongs to a shared row.</exception>
146+
The <see cref="T:System.Windows.Forms.DataGridViewButtonCell" /> returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property belongs to a shared row.
147+
148+
-or-
149+
150+
In .NET 5.0 and later versions, the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
147151
<altmember cref="T:System.Windows.Forms.DataGridView" />
148152
<altmember cref="T:System.Windows.Forms.DataGridViewButtonCell" />
149153
</Docs>

xml/System.Windows.Forms/DataGridViewCheckBoxCell+DataGridViewCheckBoxCellAccessibleObject.xml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
101101
]]></format>
102102
</remarks>
103+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
103104
<altmember cref="T:System.Windows.Forms.DataGridView" />
104105
<altmember cref="T:System.Windows.Forms.DataGridViewCheckBoxCell" />
105106
<altmember cref="T:System.Windows.Forms.AccessibleObject" />
@@ -137,7 +138,11 @@
137138

138139
-or-
139140

140-
The <see cref="T:System.Windows.Forms.DataGridViewCheckBoxCell" /> returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property belongs to a shared row.</exception>
141+
The <see cref="T:System.Windows.Forms.DataGridViewCheckBoxCell" /> returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property belongs to a shared row.
142+
143+
-or-
144+
145+
.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
141146
<altmember cref="T:System.Windows.Forms.DataGridView" />
142147
<altmember cref="T:System.Windows.Forms.DataGridViewCheckBoxCell" />
143148
<altmember cref="T:System.Windows.Forms.AccessibleObject" />
@@ -190,6 +195,7 @@
190195
<summary>Gets the state of this <see cref="T:System.Windows.Forms.DataGridViewCheckBoxCell.DataGridViewCheckBoxCellAccessibleObject" />.</summary>
191196
<value>One of the <see cref="T:System.Windows.Forms.AccessibleStates" /> values.</value>
192197
<remarks>To be added.</remarks>
198+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
193199
</Docs>
194200
</Member>
195201
</Members>

xml/System.Windows.Forms/DataGridViewColumnHeaderCell+DataGridViewColumnHeaderCellAccessibleObject.xml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@
9797
</ReturnValue>
9898
<Docs>
9999
<summary>Gets the location and size of the accessible object.</summary>
100-
<value>A <see cref="T:System.Drawing.Rectangle" /> that represents the bounds of the accessible object.</value>
100+
<value>The bounds of the accessible object.</value>
101101
<remarks>To be added.</remarks>
102+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
102103
<altmember cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Bounds" />
103104
</Docs>
104105
</Member>
@@ -121,7 +122,7 @@
121122
</ReturnValue>
122123
<Docs>
123124
<summary>Gets a string that describes the default action of the <see cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject" />.</summary>
124-
<value>A string that describes the default action of the <see cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject" /></value>
125+
<value>The default action of the <see cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject" /></value>
125126
<remarks>
126127
<format type="text/markdown"><![CDATA[
127128
@@ -130,6 +131,7 @@
130131
131132
]]></format>
132133
</remarks>
134+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
133135
<altmember cref="T:System.Windows.Forms.DataGridView" />
134136
<altmember cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell" />
135137
</Docs>
@@ -162,6 +164,7 @@
162164
163165
]]></format>
164166
</remarks>
167+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
165168
<altmember cref="T:System.Windows.Forms.DataGridView" />
166169
<altmember cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell" />
167170
<altmember cref="P:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.DefaultAction" />
@@ -195,6 +198,7 @@
195198
196199
]]></format>
197200
</remarks>
201+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
198202
<altmember cref="T:System.Windows.Forms.DataGridView" />
199203
<altmember cref="T:System.Windows.Forms.DataGridViewColumnHeaderCell" />
200204
<altmember cref="T:System.Windows.Forms.DataGridViewColumn" />
@@ -224,7 +228,7 @@
224228
<Docs>
225229
<param name="navigationDirection">One of the <see cref="T:System.Windows.Forms.AccessibleNavigation" /> values.</param>
226230
<summary>Navigates to another accessible object.</summary>
227-
<returns>An <see cref="T:System.Windows.Forms.AccessibleObject" /> that represents an object in the specified direction.</returns>
231+
<returns>An object that's in the specified direction.</returns>
228232
<remarks>
229233
<format type="text/markdown"><![CDATA[
230234
@@ -241,10 +245,11 @@
241245
|<xref:System.Windows.Forms.AccessibleNavigation.LastChild>|The last <xref:System.Windows.Forms.DataGridViewColumnHeaderCell>.|
242246
243247
> [!NOTE]
244-
> The direction that the <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> method moves when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Previous> depends on whether the <xref:System.Windows.Forms.DataGridView> has right-to-left support enabled. For example, if right-to-left support is enabled, <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> will return the same accessible object when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Left>. If right-to-left support is not enabled, <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> will return the same object when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Right>.
248+
> The direction that the <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> method moves when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Previous> depends on whether the <xref:System.Windows.Forms.DataGridView> has right-to-left support enabled. For example, if right-to-left support is enabled, <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> will return the same accessible object when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Left>. If right-to-left support is not enabled, <xref:System.Windows.Forms.DataGridViewColumnHeaderCell.DataGridViewColumnHeaderCellAccessibleObject.Navigate%2A> will return the same object when you specify <xref:System.Windows.Forms.AccessibleNavigation.Next> or <xref:System.Windows.Forms.AccessibleNavigation.Right>.
245249
246250
]]></format>
247251
</remarks>
252+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
248253
<altmember cref="T:System.Windows.Forms.AccessibleNavigation" />
249254
<altmember cref="T:System.Windows.Forms.DataGridView" />
250255
<altmember cref="T:System.Windows.Forms.DataGridViewCell" />
@@ -280,6 +285,7 @@
280285
<summary>Gets the parent of the <see cref="T:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject" />.</summary>
281286
<value>The parent of the <see cref="T:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject" />.</value>
282287
<remarks>To be added.</remarks>
288+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
283289
<altmember cref="T:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject" />
284290
</Docs>
285291
</Member>

xml/System.Windows.Forms/DataGridViewImageCell+DataGridViewImageCellAccessibleObject.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@
169169
170170
]]></format>
171171
</remarks>
172+
<exception cref="T:System.InvalidOperationException">.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
172173
<altmember cref="T:System.Windows.Forms.DataGridView" />
173174
<altmember cref="T:System.Windows.Forms.DataGridViewImageCell" />
174175
</Docs>

xml/System.Windows.Forms/DataGridViewLinkCell+DataGridViewLinkCellAccessibleObject.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,11 @@
132132
133133
]]></format>
134134
</remarks>
135-
<exception cref="T:System.InvalidOperationException">The cell returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property has a <see cref="P:System.Windows.Forms.DataGridViewElement.DataGridView" /> property value that is not <see langword="null" /> and a <see cref="P:System.Windows.Forms.DataGridViewCell.RowIndex" /> property value of -1, indicating that the cell is in a shared row.</exception>
135+
<exception cref="T:System.InvalidOperationException">The cell returned by the <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property has a <see cref="P:System.Windows.Forms.DataGridViewElement.DataGridView" /> property value that is not <see langword="null" /> and a <see cref="P:System.Windows.Forms.DataGridViewCell.RowIndex" /> property value of -1, indicating that the cell is in a shared row.
136+
137+
-or-
138+
139+
.NET 5.0 and later versions: The <see cref="P:System.Windows.Forms.DataGridViewCell.DataGridViewCellAccessibleObject.Owner" /> property is <see langword="null" />.</exception>
136140
<altmember cref="T:System.Windows.Forms.DataGridView" />
137141
<altmember cref="T:System.Windows.Forms.DataGridViewLinkCell" />
138142
</Docs>

0 commit comments

Comments
 (0)