Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Genevieve Warren <[email protected]>
  • Loading branch information
carlossanlop and gewarren authored Sep 16, 2022
commit ffb3f42d650169dd6431b6e8807a80a3afd827a8
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.ApplicationServices.ConsoleApplicationBase" /> class.</summary>
<remarks>We have to have a parameterless constructor because the platform specific Application object derives from this one and it doesn't define a constructor. The partial class generated by the designer defines the constructor in order to configure the application.</remarks>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/visual-basic/language-reference/objects/">Objects (Visual Basic)</related>
</Docs>
</Member>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase" /> class.</summary>
<remarks>We have to have a parameterless ctor because the platform specific Application object derives from this one and it doesn't define a ctor because the partial class generated by the designer does that to configure the application.</remarks>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/visual-basic/language-reference/objects/">Objects (Visual Basic)</related>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Windows.Forms/BindableComponent.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>Base class for components which provide properties which can be data bound with the WinForms Designer.</summary>
<summary>Base class for components that provide properties that can be data bound with the Windows Forms Designer.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Windows.Forms/ButtonBase.xml
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<ReturnType>System.Windows.Input.ICommand</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.Windows.Input.ICommand" /> whose <see cref="M:System.Windows.Input.ICommand.Execute(System.Object)" /> method will be called when the <see cref="E:System.Windows.Forms.Control.Click" /> event gets invoked.</summary>
<summary>Gets or sets the <see cref="T:System.Windows.Input.ICommand" /> whose <see cref="M:System.Windows.Input.ICommand.Execute(System.Object)" /> method will be called when the <see cref="E:System.Windows.Forms.Control.Click" /> event is invoked.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -311,7 +311,7 @@
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the <see cref="M:System.Windows.Input.ICommand.CanExecute(System.Object)" /> status of the <see cref="T:System.Windows.Input.ICommand" /> which is assigned to the <see cref="P:System.Windows.Forms.ButtonBase.Command" /> property has changed.</summary>
<summary>Occurs when the <see cref="M:System.Windows.Input.ICommand.CanExecute(System.Object)" /> status of the <see cref="T:System.Windows.Input.ICommand" /> that's assigned to the <see cref="P:System.Windows.Forms.ButtonBase.Command" /> property has changed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -383,7 +383,7 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the parameter that is passed to the <see cref="T:System.Windows.Input.ICommand" /> which is assigned to the <see cref="P:System.Windows.Forms.ButtonBase.Command" /> property.</summary>
<summary>Gets or sets the parameter that is passed to the <see cref="T:System.Windows.Input.ICommand" /> that's assigned to the <see cref="P:System.Windows.Forms.ButtonBase.Command" /> property.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Windows.Forms/ContainerControl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1195,11 +1195,11 @@
<Parameter Name="updateContainerSize" Type="System.Boolean" Index="2" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="xScaleFactor">The scale factor to be applied on width of the property being scaled.</param>
<param name="yScaleFactor">The scale factor to be applied on height of the property being scaled.</param>
<param name="xScaleFactor">The scale factor to be applied on the width of the property being scaled.</param>
<param name="yScaleFactor">The scale factor to be applied on the height of the property being scaled.</param>
<param name="updateContainerSize">
<see langword="true" /> to resize of the container control along with properties being scaled; otherwise, <see langword="false" />.</param>
<summary>Scales container's properties Min and Max size with the scale factor provided.</summary>
<see langword="true" /> to resize the container control along with properties being scaled; otherwise, <see langword="false" />.</param>
<summary>Scales the size of the container's <see langword="Min" /> and <see langword="Max" /> properties with the scale factor provided.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Windows.Forms/DragEventArgs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the drop description text such as "Move to %1".</summary>
<summary>Gets or sets the drop description text, such as "Move to %1".</summary>
<value>To be added.</value>
<remarks>
<para> UI coloring is applied to the text in <see cref="P:System.Windows.Forms.DragEventArgs.MessageReplacementToken" /> if used by specifying %1 in <see cref="P:System.Windows.Forms.DragEventArgs.Message" />.
Expand All @@ -464,7 +464,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the drop description text such as "Documents" when %1 is specified in <see cref="P:System.Windows.Forms.DragEventArgs.Message" />.</summary>
<summary>Gets or sets the drop description text, such as "Documents", when %1 is specified in <see cref="P:System.Windows.Forms.DragEventArgs.Message" />.</summary>
<value>To be added.</value>
<remarks>
<para> UI coloring is applied to the text in <see cref="P:System.Windows.Forms.DragEventArgs.MessageReplacementToken" /> if used by specifying %1 in <see cref="P:System.Windows.Forms.DragEventArgs.Message" />.
Expand Down
5 changes: 1 addition & 4 deletions xml/System.Windows.Forms/FileDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -943,10 +943,7 @@
<Docs>
<summary>Gets or sets a value indicating whether the OK button of the dialog box is disabled until the user navigates the view or edits the filename (if applicable).</summary>
<value>To be added.</value>
<remarks>
<para> Note: Disabling of the OK button does not prevent the dialog from being submitted by the Enter key.
</para>
</remarks>
<remarks>Note: Disabling of the OK button does not prevent the dialog from being submitted by the Enter key.</remarks>
</Docs>
</Member>
<Member MemberName="OnFileOk">
Expand Down
4 changes: 1 addition & 3 deletions xml/System.Windows.Forms/FolderBrowserDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,7 @@
<Docs>
<summary>Gets or sets a value indicating whether the OK button of the dialog box is disabled until the user navigates the view or edits the filename (if applicable).</summary>
<value>To be added.</value>
<remarks>
<para> Note: Disabling of the OK button does not prevent the dialog from being submitted by the Enter key.
</para>
<remarks>Note: Disabling of the OK button does not prevent the dialog from being submitted by the Enter key.
</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Windows.Forms/Form.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6389,11 +6389,11 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another
<Parameter Name="updateContainerSize" Type="System.Boolean" Index="2" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="xScaleFactor">The scale factor to be applied on width of the property being scaled.</param>
<param name="yScaleFactor">The scale factor to be applied on height of the property being scaled.</param>
<param name="xScaleFactor">The scale factor to be applied on the width of the property being scaled.</param>
<param name="yScaleFactor">The scale factor to be applied on the height of the property being scaled.</param>
<param name="updateContainerSize">
<see langword="true" /> to resize of the Form along with properties being scaled; otherwise, <see langword="false" />.</param>
<summary>Scales Form's properties Min and Max size with the scale factor provided.</summary>
<see langword="true" /> to resize the Form along with properties being scaled; otherwise, <see langword="false" />.</param>
<summary>Scales the size of the form's <see langword="Min" /> and <see langword="Max" />properties with the scale factor provided.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 3 additions & 5 deletions xml/System.Windows.Forms/GiveFeedbackEventArgs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -296,11 +296,9 @@
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether a layered window drag image is used.</summary>
<value>To be added.</value>
<remarks>
<para> Specify <see langword="true" /> for <see cref="P:System.Windows.Forms.GiveFeedbackEventArgs.UseDefaultDragImage" /> to use a layered window drag image with a size of 96x96; otherwise <see langword="false" />.
</para>
</remarks>
<value>
<see langword="true" /> for <see cref="P:System.Windows.Forms.GiveFeedbackEventArgs.UseDefaultDragImage" /> to use a layered window drag image with a size of 96x96; otherwise <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Windows.Forms/OpenFileDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ On a right-to-left operating system, setting the containing form's <xref:System.
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the dialog box allows to select read-only files.</summary>
<summary>Gets or sets a value indicating whether the dialog box allows selection of read-only files.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Windows.Forms/SaveFileDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the dialog box verifies if the creation of the specified file will be successful.
If this flag is not set, the calling application must handle errors, such as denial of access, discovered when the item is created.</summary>
If this flag is not set, the calling application must handle errors, such as denial of access, that are discovered when the item is created.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
11 changes: 6 additions & 5 deletions xml/System.Windows.Forms/ToolStripItem.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1197,7 +1197,7 @@
<ReturnType>System.Windows.Input.ICommand</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.Windows.Input.ICommand" /> whose <see cref="M:System.Windows.Input.ICommand.Execute(System.Object)" /> method will be called when the ToolStripItem's <see cref="E:System.Windows.Forms.ToolStripItem.Click" /> event gets invoked.</summary>
<summary>Gets or sets the <see cref="T:System.Windows.Input.ICommand" /> whose <see cref="M:System.Windows.Input.ICommand.Execute(System.Object)" /> method will be called when the ToolStripItem's <see cref="E:System.Windows.Forms.ToolStripItem.Click" /> event is invoked.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -1228,7 +1228,7 @@
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the <see cref="M:System.Windows.Input.ICommand.CanExecute(System.Object)" /> status of the <see cref="T:System.Windows.Input.ICommand" /> which is assigned to the <see cref="P:System.Windows.Forms.ToolStripItem.Command" /> property has changed.</summary>
<summary>Occurs when the <see cref="M:System.Windows.Input.ICommand.CanExecute(System.Object)" /> status of the <see cref="T:System.Windows.Input.ICommand" /> that's assigned to the <see cref="P:System.Windows.Forms.ToolStripItem.Command" /> property has changed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1300,7 +1300,7 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the parameter that is passed to the <see cref="T:System.Windows.Input.ICommand" /> which is assigned to the <see cref="P:System.Windows.Forms.ToolStripItem.Command" /> property.</summary>
<summary>Gets or sets the parameter that is passed to the <see cref="T:System.Windows.Input.ICommand" /> that's assigned to the <see cref="P:System.Windows.Forms.ToolStripItem.Command" /> property.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -1858,10 +1858,11 @@
<param name="dragImage">To be added.</param>
<param name="cursorOffset">To be added.</param>
<param name="useDefaultDragImage">To be added.</param>
<summary>Begins a drag operation. The <paramref name="allowedEffects" /> determine which drag operations can occur. If the drag operation needs to interop with applications in another process, <paramref name="data" /> should either be a base managed class (<see cref="T:System.String" />, <see cref="T:System.Drawing.Bitmap" />, or <see cref="T:System.Drawing.Imaging.Metafile" />) or some <see cref="T:System.Object" /> that implements <see cref="T:System.Runtime.Serialization.ISerializable" />. <paramref name="data" /> can also be any <see cref="T:System.Object" /> that implements <see cref="T:System.Windows.Forms.IDataObject" />. <paramref name="dragImage" /> is the bitmap that will be displayed during the drag operation and <paramref name="cursorOffset" /> specifies the location of the cursor within <paramref name="dragImage" />, which is an offset from the upper-left corner. Specify <see langword="true" /> for <paramref name="useDefaultDragImage" /> to use a layered window drag image with a size of 96x96; otherwise <see langword="false" />. Note the outer edges of <paramref name="dragImage" /> are blended out if the image width or height exceeds 300 pixels.</summary>
<summary>Begins a drag operation.</summary>
<returns>A value from the <see cref="T:System.Windows.Forms.DragDropEffects" /> enumeration that represents the final effect that was performed during the drag-and-drop operation.</returns>
<remarks>
<para> Because <see cref="M:System.Windows.Forms.ToolStripItem.DoDragDrop(System.Object,System.Windows.Forms.DragDropEffects,System.Drawing.Bitmap,System.Drawing.Point,System.Boolean)" /> always performs the RGB multiplication step in calculating the alpha value, you should always pass a <see cref="T:System.Drawing.Bitmap" /> without premultiplied alpha blending. Note that no error will result from passing a <see cref="T:System.Drawing.Bitmap" /> with premultiplied alpha blending, but this method will multiply it again, doubling the resulting alpha value.
<para>The <paramref name="allowedEffects" /> parameter determines which drag operations can occur. If the drag operation needs to interop with applications in another process, <paramref name="data" /> should either be a base managed class (<see cref="T:System.String" />, <see cref="T:System.Drawing.Bitmap" />, or <see cref="T:System.Drawing.Imaging.Metafile" />) or some <see cref="T:System.Object" /> that implements <see cref="T:System.Runtime.Serialization.ISerializable" />. <paramref name="data" /> can also be any <see cref="T:System.Object" /> that implements <see cref="T:System.Windows.Forms.IDataObject" />. <paramref name="dragImage" /> is the bitmap that will be displayed during the drag operation and <paramref name="cursorOffset" /> specifies the location of the cursor within <paramref name="dragImage" />, which is an offset from the upper-left corner. Specify <see langword="true" /> for <paramref name="useDefaultDragImage" /> to use a layered window drag image with a size of 96x96; otherwise <see langword="false" />. Note the outer edges of <paramref name="dragImage" /> are blended out if the image width or height exceeds 300 pixels.</para>
<para> Because <see cref="M:System.Windows.Forms.ToolStripItem.DoDragDrop(System.Object,System.Windows.Forms.DragDropEffects,System.Drawing.Bitmap,System.Drawing.Point,System.Boolean)" /> always performs the RGB multiplication step in calculating the alpha value, you should always pass a <see cref="T:System.Drawing.Bitmap" /> without premultiplied alpha blending. No error will result from passing a <see cref="T:System.Drawing.Bitmap" /> with premultiplied alpha blending, but this method will multiply it again, doubling the resulting alpha value.
</para>
</remarks>
</Docs>
Expand Down