Skip to content

Port docs from WinForms #8394

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

Merged
carlossanlop merged 4 commits into from
Sep 16, 2022
Merged

Port docs from WinForms #8394

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9e6523
WinForms only
carlossanlop Sep 15, 2022
ffb3f42
Apply suggestions from code review
carlossanlop Sep 16, 2022
4948185
Apply suggestions to Control.xml
carlossanlop Sep 16, 2022
5866fd7
Remove seealso for api not found
carlossanlop Sep 16, 2022
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
2 changes: 1 addition & 1 deletion xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml
View file
Open in desktop
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>To be added.</remarks>
<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>
<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/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml
View file
Open in desktop
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>To be added.</remarks>
<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>
<related type="Article" href="/dotnet/visual-basic/language-reference/objects/">Objects (Visual Basic)</related>
</Docs>
</Member>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/BinaryEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
<summary>Gets the editor style used by the <see cref="M:System.ComponentModel.Design.BinaryEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>An <see langword="enum" /> value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/CollectionEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,7 @@
<summary>Gets the edit style used by the <see cref="M:System.ComponentModel.Design.CollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> enumeration value indicating the provided editing style. If the method is not supported in the specified context, this method will return the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" /> identifier.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetItems">
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/DateTimeEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@
<summary>Retrieves the editing style of the <see cref="Overload:System.ComponentModel.Design.DateTimeEditor.EditValue" /> method. If the method is not supported, this will return None.</summary>
<returns>An <see langword="enum" /> value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/MultilineStringEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@
<summary>Edits the specified object value using the edit style provided by <see cref="M:System.Drawing.Design.ImageEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</summary>
<returns>The new value of the object. If the value of the object has not changed, this method should return the same object passed to it.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetEditStyle">
Expand Down
2 changes: 2 additions & 0 deletions xml/System.ComponentModel.Design/ObjectSelectorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="EqualsToValue">
Expand Down Expand Up @@ -421,6 +422,7 @@
<param name="value">The specified value.</param>
<summary>Sets the current <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" /> to the specified value.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="SubObjectSelector">
Expand Down
3 changes: 3 additions & 0 deletions xml/System.Drawing.Design/ColorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
<summary>Gets the editing style of the Edit method. If the method is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</summary>
<returns>An enum value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetPaintValueSupported">
Expand Down Expand Up @@ -201,6 +202,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.ColorEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PaintValue">
Expand Down Expand Up @@ -244,6 +246,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/ContentAlignmentEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@
<summary>Gets the editing style of the <see cref="Overload:System.Drawing.Design.ContentAlignmentEditor.EditValue" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> value indicating the provided editing style. If the method to retrieve the edit style is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/CursorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@
<summary>Retrieves the editing style of the <see cref="Overload:System.Drawing.Design.CursorEditor.EditValue" /> method.</summary>
<returns>An enum value indicating the provided editing style. If the method is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="IsDropDownResizable">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/FontEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@
<summary>Gets the editor style used by the <see cref="M:System.Drawing.Design.FontEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> value that indicates the style of editor used by <see cref="M:System.Drawing.Design.FontEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Drawing.Design/FontNameEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.FontNameEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PaintValue">
Expand Down Expand Up @@ -152,6 +153,7 @@
<param name="e">What to paint and where to paint it.</param>
<summary>Paints a representative value of the given object to the provided canvas. Painting should be done within the boundaries of the provided rectangle.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Drawing.Design/IconEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.UITypeEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="LoadFromStream">
Expand Down Expand Up @@ -443,6 +444,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
3 changes: 3 additions & 0 deletions xml/System.Drawing.Design/ImageEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetExtensions">
Expand Down Expand Up @@ -419,6 +420,7 @@
<returns>
<see langword="true" /> if <see cref="M:System.Drawing.Design.ImageEditor.PaintValue(System.Drawing.Design.PaintValueEventArgs)" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="LoadFromStream">
Expand Down Expand Up @@ -499,6 +501,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/AnchorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<summary>Gets the editor style used by the <see cref="M:System.Windows.Forms.Design.AnchorEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>One of the <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> values indicating the provided editing style. If the method is not supported, this method will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Windows.Forms.Design/BorderSidesEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
<summary>Edits the given object value using the editor style provided by <see cref="M:System.Windows.Forms.Design.BorderSidesEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</summary>
<returns>The edited object.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetEditStyle">
Expand Down Expand Up @@ -152,6 +153,7 @@
<summary>Retrieves the editing style of the <see langword="EditValue" /> method.</summary>
<returns>One of the <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> values. If the method is not supported, this method returns <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/DockEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@
<summary>Retrieves the editing style of the EditValue method. If the method is not supported, this will return None.</summary>
<returns>An enum value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/EventsTab.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@
<summary>Gets all the properties of the event tab that match the specified attributes and context.</summary>
<returns>A <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> that contains the properties. This will be an empty <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> if the component does not implement an event service.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="HelpKeyword">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/FileNameEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditorEditStyle" />
<inheritdoc />
</Docs>
</Member>
<Member MemberName="InitializeDialog">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/FolderNameEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditorEditStyle" />
<inheritdoc />
</Docs>
</Member>
<Member MemberName="InitializeDialog">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms.Design/ShortcutKeysEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Windows.Forms/BindableComponent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Base class for components which provide properties which can be data bound with the WinForms Designer.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -111,7 +111,7 @@
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Occurs when the binding context has changed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -179,7 +179,7 @@
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<summary>Raises the <see cref="E:System.Windows.Forms.BindableComponent.BindingContextChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
26 changes: 13 additions & 13 deletions xml/System.Windows.Forms/ButtonBase.xml
View file
Open in desktop
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>To be added.</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 gets 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>To be added.</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" /> which is 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 @@ -341,7 +341,7 @@
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Occurs when the assigned <see cref="T:System.Windows.Input.ICommand" /> of 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>To be added.</summary>
<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>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -414,7 +414,7 @@
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Occurs when the value of the <see cref="P:System.Windows.Forms.ButtonBase.CommandParameter" /> property has changed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1216,8 +1216,8 @@ If you set the <xref:System.Windows.Forms.ButtonBase.ImageKey%2A> property, the
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">An empty <see cref="T:System.EventArgs" /> instance.</param>
<summary>Raises the <see cref="E:System.Windows.Forms.ButtonBase.CommandCanExecuteChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1250,8 +1250,8 @@ If you set the <xref:System.Windows.Forms.ButtonBase.ImageKey%2A> property, the
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">An empty <see cref="T:System.EventArgs" /> instance.</param>
<summary>Raises the <see cref="E:System.Windows.Forms.ButtonBase.CommandChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1284,8 +1284,8 @@ If you set the <xref:System.Windows.Forms.ButtonBase.ImageKey%2A> property, the
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">An empty <see cref="T:System.EventArgs" /> instance.</param>
<summary>Raises the <see cref="E:System.Windows.Forms.ButtonBase.CommandParameterChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1804,8 +1804,8 @@ If you set the <xref:System.Windows.Forms.ButtonBase.ImageKey%2A> property, the
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<param name="e">An empty <see cref="T:System.EventArgs" /> instance.</param>
<summary>Called in the context of <see cref="M:System.Windows.Forms.ButtonBase.OnClick(System.EventArgs)" /> to invoke <see cref="M:System.Windows.Input.ICommand.Execute(System.Object)" /> if the context allows.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Windows.Forms/ContainerControl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1195,10 +1195,11 @@
<Parameter Name="updateContainerSize" Type="System.Boolean" Index="2" FrameworkAlternate="windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="xScaleFactor">To be added.</param>
<param name="yScaleFactor">To be added.</param>
<param name="updateContainerSize">To be added.</param>
<summary>To be added.</summary>
<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="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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading