From 74d6f08ea0814aa96e47e4c0bbd2683de1eecb35 Mon Sep 17 00:00:00 2001 From: Igor Velikorossov Date: Tue, 6 Aug 2019 16:11:01 +0300 Subject: [PATCH 1/2] chore: Fix and add xml-doc --- .../Windows/Forms/Design/AnchorEditor.cs | 7 +- .../System/Windows/Forms/Design/DockEditor.cs | 2 +- .../Windows/Forms/Design/FileNameEditor.cs | 4 +- .../Windows/Forms/Design/FolderNameEditor.cs | 4 +- .../System/Windows/Forms/AccessibleEvents.cs | 308 ++++++++++++------ 5 files changed, 218 insertions(+), 107 deletions(-) diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs index a7adf8253ab..e8d5ebb31ae 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs @@ -3,13 +3,12 @@ // See the LICENSE file in the project root for more information. using System.ComponentModel; -using System.Diagnostics.CodeAnalysis; using System.Drawing; using System.Drawing.Design; namespace System.Windows.Forms.Design { - /// > + /// /// Provides a design-time editor for specifying the /// property. /// @@ -18,7 +17,7 @@ public sealed class AnchorEditor : UITypeEditor { private AnchorUI _anchorUI; - /// > + /// /// Edits the given object value using the editor style provided by GetEditorStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) @@ -45,7 +44,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide return value; } - /// > + /// /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs index d4753cd774d..a71676b1e61 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { - /// > + /// /// Implements the design time editor for specifying the /// property. /// diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs index a8faf1907b6..485f6f4d5ca 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms.Design { - /// > + /// /// Provides an editor for filenames. /// [CLSCompliant(false)] @@ -47,7 +47,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide return value; } - /// > + /// /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs index 2c067453446..73ce9a60280 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { - /// > + /// /// Provides an editor for choosing a folder from the filesystem. /// [CLSCompliant(false)] @@ -73,7 +73,7 @@ protected sealed class FolderBrowser : Component /// public FolderBrowserFolder StartLocation { get; set; } = FolderBrowserFolder.Desktop; - /// > + /// /// Gets or sets a description to show above the folders. Here you can provide instructions for /// selecting a folder. /// diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs index 5b50beb90a2..a68598dd5e1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs @@ -5,119 +5,188 @@ namespace System.Windows.Forms { /// - /// Specifies events that are reported by accessible applications. + /// Specifies events that are reported by accessible applications. /// public enum AccessibleEvents { - /// > - /// EVENT_SYSTEM_SOUND - /// Sent when a sound is played. Currently nothing is generating this, we - /// are going to be cleaning up the SOUNDSENTRY feature in the control panel - /// and will use this at that time. Applications implementing WinEvents - /// are perfectly welcome to use it. Clients of IAccessible* will simply - /// turn around and get back a non-visual object that describes the sound. + /// + /// EVENT_SYSTEM_SOUND + /// Sent when a sound is played. Currently nothing is generating this, we + /// are going to be cleaning up the SOUNDSENTRY feature in the control panel + /// and will use this at that time. Applications implementing WinEvents + /// are perfectly welcome to use it. Clients of IAccessible* will simply + /// turn around and get back a non-visual object that describes the sound. /// SystemSound = 0x0001, - /// > - /// EVENT_SYSTEM_ALERT - /// Sent when an alert needs to be given to the user. MessageBoxes generate - /// alerts for example. + /// + /// EVENT_SYSTEM_ALERT + /// Sent when an alert needs to be given to the user. MessageBoxes generate + /// alerts for example. /// SystemAlert = 0x0002, - /// > - /// EVENT_SYSTEM_FOREGROUND - /// Sent when the foreground (active) window changes, even if it is changing - /// to another window in the same thread as the previous one. + /// + /// EVENT_SYSTEM_FOREGROUND + /// Sent when the foreground (active) window changes, even if it is changing + /// to another window in the same thread as the previous one. /// SystemForeground = 0x0003, - /// > - /// EVENT_SYSTEM_MENUSTART - /// EVENT_SYSTEM_MENUEND - /// Sent when entering into and leaving from menu mode (system, app bar, and - /// track popups). + /// + /// EVENT_SYSTEM_MENUSTART + /// Sent when entering into menu mode (system, app bar, and track popups). /// + /// . SystemMenuStart = 0x0004, + + /// + /// EVENT_SYSTEM_MENUEND + /// Sent when leaving from menu mode (system, app bar, and track popups). + /// + /// . SystemMenuEnd = 0x0005, - /// > - /// EVENT_SYSTEM_MENUPOPUPSTART - /// EVENT_SYSTEM_MENUPOPUPEND - /// Sent when a menu popup comes up and just before it is taken down. Note - /// that for a call to TrackPopupMenu(), a client will see EVENT_SYSTEM_MENUSTART - /// followed almost immediately by EVENT_SYSTEM_MENUPOPUPSTART for the popup - /// being shown. + /// + /// EVENT_SYSTEM_MENUPOPUPSTART + /// Sent when a menu popup comes up. /// + /// + /// Note that for a call to TrackPopupMenu(), a client will see EVENT_SYSTEM_MENUSTART + /// followed almost immediately by EVENT_SYSTEM_MENUPOPUPSTART for the popup being shown. + /// + /// . SystemMenuPopupStart = 0x0006, + + /// + /// EVENT_SYSTEM_MENUPOPUPEND + /// Sent when a menu popup just before it is taken down. + /// + /// + /// Note that for a call to TrackPopupMenu(), a client will see EVENT_SYSTEM_MENUSTART + /// followed almost immediately by EVENT_SYSTEM_MENUPOPUPSTART for the popup being shown. + /// + /// . SystemMenuPopupEnd = 0x0007, - /// > - /// EVENT_SYSTEM_CAPTURESTART - /// EVENT_SYSTEM_CAPTUREEND - /// Sent when a window takes the capture and releases the capture. + /// + /// EVENT_SYSTEM_CAPTURESTART + /// Sent when a window takes the capture. /// + /// . SystemCaptureStart = 0x0008, + + /// + /// EVENT_SYSTEM_CAPTUREEND + /// Sent when a window releases the capture. + /// + /// . SystemCaptureEnd = 0x0009, + /// + /// EVENT_SYSTEM_MOVESIZESTART + /// Sent when a window enters move-size dragging mode. /// - /// EVENT_SYSTEM_MOVESIZESTART - /// EVENT_SYSTEM_MOVESIZEEND - /// Sent when a window enters and leaves move-size dragging mode. - /// + /// . SystemMoveSizeStart = 0x000A, + + /// + /// EVENT_SYSTEM_MOVESIZEEND + /// Sent when a window leaves move-size dragging mode. + /// + /// . SystemMoveSizeEnd = 0x000B, - /// > - /// EVENT_SYSTEM_CONTEXTHELPSTART - /// EVENT_SYSTEM_CONTEXTHELPEND - /// Sent when a window enters and leaves context sensitive help mode. + /// + /// EVENT_SYSTEM_CONTEXTHELPSTART + /// Sent when a window enters context sensitive help mode. /// + /// . SystemContextHelpStart = 0x000C, + + /// + /// EVENT_SYSTEM_CONTEXTHELPEND + /// Sent when a window leaves context sensitive help mode. + /// + /// . SystemContextHelpEnd = 0x000D, - /// > - /// EVENT_SYSTEM_DRAGDROPSTART - /// EVENT_SYSTEM_DRAGDROPEND - /// Sent when a window enters and leaves drag drop mode. Note that it is up - /// to apps and OLE to generate this, since the system doesn't know. Like - /// EVENT_SYSTEM_SOUND, it will be a while before this is prevalent. + /// + /// EVENT_SYSTEM_DRAGDROPSTART + /// Sent when a window enters drag drop mode. /// + /// + /// Note that it is up to apps and OLE to generate this, since the system doesn't know. + /// Like EVENT_SYSTEM_SOUND, it will be a while before this is prevalent. + /// + /// . SystemDragDropStart = 0x000E, + + /// + /// EVENT_SYSTEM_DRAGDROPEND + /// Sent when a window leaves drag drop mode. + /// + /// + /// Note that it is up to apps and OLE to generate this, since the system doesn't know. + /// Like EVENT_SYSTEM_SOUND, it will be a while before this is prevalent. + /// + /// . SystemDragDropEnd = 0x000F, - /// > - /// EVENT_SYSTEM_DIALOGSTART - /// EVENT_SYSTEM_DIALOGEND - /// Sent when a dialog comes up and just before it goes away. + /// + /// EVENT_SYSTEM_DIALOGSTART + /// Sent when a dialog comes up. /// + /// . SystemDialogStart = 0x0010, + + /// + /// EVENT_SYSTEM_DIALOGEND + /// Sent when a dialog just before it goes away. + /// + /// . SystemDialogEnd = 0x0011, - /// > - /// EVENT_SYSTEM_SCROLLINGSTART - /// EVENT_SYSTEM_SCROLLINGEND - /// Sent when beginning and ending the tracking of a scrollbar in a window, - /// and also for scrollbar controls. + /// + /// EVENT_SYSTEM_SCROLLINGSTART + /// Sent when beginning the tracking of a scrollbar in a window, and also for scrollbar controls. /// + /// . SystemScrollingStart = 0x0012, + + /// + /// EVENT_SYSTEM_SCROLLINGEND + /// Sent when ending the tracking of a scrollbar in a window, and also for scrollbar controls. + /// + /// . SystemScrollingEnd = 0x0013, - /// > - /// EVENT_SYSTEM_SWITCHSTART - /// EVENT_SYSTEM_SWITCHEND - /// Sent when beginning and ending alt-tab mode with the switch window. + /// + /// EVENT_SYSTEM_SWITCHSTART + /// Sent when beginning alt-tab mode with the switch window. /// + /// . SystemSwitchStart = 0x0014, + + /// + /// EVENT_SYSTEM_SWITCHEND + /// Sent when ending alt-tab mode with the switch window. + /// + /// . SystemSwitchEnd = 0x0015, - /// > - /// EVENT_SYSTEM_MINIMIZESTART - /// EVENT_SYSTEM_MINIMIZEEND - /// Sent when a window minimizes and just before it restores. + /// + /// EVENT_SYSTEM_MINIMIZESTART + /// Sent when a window minimizes and just before it restores. /// + /// . SystemMinimizeStart = 0x0016, + + /// + /// EVENT_SYSTEM_MINIMIZEEND + /// Sent when a window minimizes and just before it restores. + /// + /// . SystemMinimizeEnd = 0x0017, // Object events @@ -143,52 +212,95 @@ public enum AccessibleEvents // of the child identified by the VARIANT. In other words, the // child in this case is accessible but not a full object. // Like a button on a titlebar which is 'small' and has no children. - Create = 0x8000, // hwnd + ID + idChild is created item - Destroy = 0x8001, // hwnd + ID + idChild is destroyed item - Show = 0x8002, // hwnd + ID + idChild is shown item - Hide = 0x8003, // hwnd + ID + idChild is hidden item - Reorder = 0x8004, // hwnd + ID + idChild is parent of zordering children - - /// - /// Minimize the number of notifications! - /// When you are hiding a parent object, obviously all child objects are no - /// longer visible on screen. They still have the same "visible" status, - /// but are not truly visible. Hence do not send HIDE notifications for the - /// children also. One implies all. The same goes for SHOW. - /// - Focus = 0x8005, // hwnd + ID + idChild is focused item - Selection = 0x8006, // hwnd + ID + idChild is selected item (if only one), or idChild is OBJID_WINDOW if complex - SelectionAdd = 0x8007, // hwnd + ID + idChild is item added - SelectionRemove = 0x8008, // hwnd + ID + idChild is item removed - SelectionWithin = 0x8009, // hwnd + ID + idChild is parent of changed selected items - - /// - /// There is only one "focused" child item in a parent. This is the place - /// keystrokes are going at a given moment. Hence only send a notification - /// about where the NEW focus is going. A NEW item getting the focus already - /// implies that the OLD item is losing it. - /// - /// SELECTION however can be multiple. Hence the different SELECTION - /// notifications. Here's when to use each: - /// - /// (1) Send a SELECTION notification in the simple single selection + + /// + /// EVENT_OBJECT_CREATE + /// Sent when an object has been created. + /// The system sends this event for the following user interface elements: + /// caret, header control, list-view control, tab control, toolbar control, tree view control, + /// and window object. Server applications send this event for their accessible objects. + /// + Create = 0x8000, // hwnd + ID + idChild is created item + + /// + /// EVENT_OBJECT_DESTROY + /// Sent when an object has been destroyed. + /// The system sends this event for the following user interface elements: + /// caret, header control, list-view control, tab control, toolbar control, tree view control, + /// and window object. Server applications send this event for their accessible objects. + /// + Destroy = 0x8001, // hwnd + ID + idChild is destroyed item + + /// + /// EVENT_OBJECT_SHOW + /// Sent when a hidden object is shown. + /// The system sends this event for the following user interface elements: + /// caret, cursor, and window object. Server applications send this event for their accessible objects. + /// Clients assume that when this event is sent by a parent object, all child objects are already displayed. + /// Therefore, server applications do not send this event for the child objects. + /// + Show = 0x8002, // hwnd + ID + idChild is shown item + + /// + /// EVENT_OBJECT_HIDE + /// Sent when an object is hidden. + /// The system sends this event for the following user interface elements: caret and cursor. + /// Server applications send this event for their accessible objects. + /// When this event is generated for a parent object, all child objects are already hidden. + /// Server applications do not send this event for the child objects. + /// + Hide = 0x8003, // hwnd + ID + idChild is hidden item + + /// + /// EVENT_OBJECT_REORDER + /// Sent when a container object has added, removed, or reordered its children. + /// The system sends this event for the following user interface elements: + /// header control, list-view control, toolbar control, and window object. + /// Server applications send this event as appropriate for their accessible objects. + /// + Reorder = 0x8004, // hwnd + ID + idChild is parent of zordering children + + /// + /// Minimize the number of notifications! + /// When you are hiding a parent object, obviously all child objects are no + /// longer visible on screen. They still have the same "visible" status, + /// but are not truly visible. Hence do not send HIDE notifications for the + /// children also. One implies all. The same goes for SHOW. + /// + Focus = 0x8005, // hwnd + ID + idChild is focused item + + Selection = 0x8006, // hwnd + ID + idChild is selected item (if only one), or idChild is OBJID_WINDOW if complex + SelectionAdd = 0x8007, // hwnd + ID + idChild is item added + SelectionRemove = 0x8008, // hwnd + ID + idChild is item removed + SelectionWithin = 0x8009, // hwnd + ID + idChild is parent of changed selected items + + /// + /// There is only one "focused" child item in a parent. This is the place + /// keystrokes are going at a given moment. Hence only send a notification + /// about where the NEW focus is going. A NEW item getting the focus already + /// implies that the OLD item is losing it. + /// + /// SELECTION however can be multiple. Hence the different SELECTION + /// notifications. Here's when to use each: + /// + /// (1) Send a SELECTION notification in the simple single selection /// case (like the focus) when the item with the selection is /// merely moving to a different item within a container. hwnd + ID /// is the container control, idChildItem is the new child with the /// selection. - /// - /// (2) Send a SELECTIONADD notification when a new item has simply been added + /// + /// (2) Send a SELECTIONADD notification when a new item has simply been added /// to the selection within a container. This is appropriate when the /// number of newly selected items is very small. hwnd + ID is the /// container control, idChildItem is the new child added to the selection. - /// - /// (3) Send a SELECTIONREMOVE notification when a new item has simply been + /// + /// (3) Send a SELECTIONREMOVE notification when a new item has simply been /// removed from the selection within a container. This is appropriate /// when the number of newly selected items is very small, just like /// SELECTIONADD. hwnd + ID is the container control, idChildItem is the /// new child removed from the selection. - /// - /// (4) Send a SELECTIONWITHIN notification when the selected items within a + /// + /// (4) Send a SELECTIONWITHIN notification when the selected items within a /// control have changed substantially. Rather than propagate a large /// number of changes to reflect removal for some items, addition of /// others, just tell somebody who cares that a lot happened. It will From 7886b62f9808a749b7225b800e4a06315f540bb8 Mon Sep 17 00:00:00 2001 From: Igor Velikorossov Date: Thu, 8 Aug 2019 15:12:32 +0300 Subject: [PATCH 2/2] chore: fix xml-doc whitespacing Purely cosmetic change that increases xml-doc spacing to 2 after `///`. The increased spacing makes it slightly easier to read the comments in the code. The change is done in VS using regex `///\s([^< ])` -> `/// $1` --- .../Form1.Designer.cs | 8 +- .../WinFormsApplication-CSharp/Program.cs | 2 +- src/Common/src/ClientUtils.cs | 24 +- src/Common/src/CommonUnsafeNativeMethods.cs | 8 +- .../src/DpiHelper.DpiAwarenessContext.cs | 14 +- src/Common/src/DpiHelper.cs | 44 +- src/Common/src/FileDialog_Vista_Interop.cs | 14 +- src/Common/src/Interop/Interop.BOOL.cs | 10 +- .../src/Interop/Interop.EditMessages.cs | 4 +- .../src/Interop/Interop.RichEditMessages.cs | 4 +- .../Kernel32/Interop.GetProcAddress.cs | 2 +- .../src/Interop/Ole32/Interop.IStream.cs | 6 +- .../src/Interop/Ole32/Interop.STATFLAG.cs | 6 +- .../src/Interop/Ole32/Interop.STATSTG.cs | 22 +- src/Common/src/Interop/Ole32/Interop.STGM.cs | 8 +- src/Common/src/Interop/Ole32/Interop.STGTY.cs | 2 +- src/Common/src/NativeMethods.cs | 36 +- src/Common/src/OsVersion.cs | 6 +- src/Common/src/SpanHelpers.cs | 10 +- src/Common/src/UnsafeNativeMethods.cs | 188 ++++---- src/Common/tests/CommonMemberDataAttribute.cs | 8 +- .../src/AdminHelpers.cs | 2 +- .../src/AssertExtensions.cs | 22 +- .../src/TheoryExtensions.cs | 2 +- .../src/Misc/CommonUnsafeNativeMethods.cs | 6 +- .../src/Misc/ConfigurationOptions.cs | 6 +- .../src/Misc/ConfigurationStringConstants.cs | 4 +- .../src/Misc/DpiHelper.cs | 28 +- .../ComponentModel/Design/ArrayEditor.cs | 12 +- .../ComponentModel/Design/CollectionEditor.cs | 244 +++++----- .../Design/MultilineStringEditor.cs | 8 +- .../Design/ObjectSelectorEditor.cs | 34 +- .../src/System/Drawing/Design/BitmapEditor.cs | 4 +- .../src/System/Drawing/Design/ColorEditor.cs | 34 +- .../src/System/Drawing/Design/CursorEditor.cs | 12 +- .../src/System/Drawing/Design/FontEditor.cs | 8 +- .../System/Drawing/Design/FontNameEditor.cs | 4 +- .../src/System/Drawing/Design/ImageEditor.cs | 22 +- .../System/Drawing/Design/MetafileEditor.cs | 4 +- .../Windows/Forms/Design/AnchorEditor.cs | 10 +- .../Windows/Forms/Design/BorderSidesEditor.cs | 40 +- .../System/Windows/Forms/Design/DockEditor.cs | 12 +- .../Windows/Forms/Design/FileNameEditor.cs | 14 +- .../Windows/Forms/Design/FolderNameEditor.cs | 26 +- .../Forms/Design/ImageCollectionEditor.cs | 2 +- .../Forms/Design/ShortcutKeysEditor.cs | 28 +- .../ComponentModel/Design/CodeMarkers.cs | 68 +-- .../Design/ComponentDesigner.cs | 106 ++--- .../ComponentModel/Design/DesignSurface.cs | 94 ++-- .../Design/DesignSurfaceServiceContainer.cs | 10 +- .../Design/DesignerActionItem.cs | 6 +- .../Design/DesignerActionList.cs | 6 +- .../DesignerActionListsChangedEventArgs.cs | 10 +- .../DesignerActionListsChangedEventHandler.cs | 2 +- .../Design/DesignerActionListsChangedType.cs | 6 +- .../Design/DesignerActionPanel.cs | 22 +- .../Design/DesignerActionUIService.cs | 8 +- .../DesignerActionUIStateChangeEventArgs.cs | 8 +- .../ComponentModel/Design/DesignerHost.cs | 182 ++++---- .../Design/ExtenderProviderService.cs | 12 +- .../Design/HostDesigntimeLicenseContext.cs | 4 +- .../Design/IMultitargetHelperService.cs | 4 +- .../Design/InheritedPropertyDescriptor.cs | 22 +- .../ComponentModel/Design/LoadedEventArgs.cs | 8 +- .../Design/LoadedEventHandler.cs | 2 +- .../ComponentModel/Design/ReferenceService.cs | 42 +- .../ComponentModel/Design/SelectionService.cs | 40 +- .../CodeDomComponentSerializationService.cs | 106 ++--- .../Serialization/CodeDomSerializerBase.cs | 4 +- .../CodeDomSerializerException.cs | 4 +- .../Design/Serialization/CodeMethodMap.cs | 2 +- .../CollectionCodeDomSerializer.cs | 22 +- .../Design/Serialization/ComponentCache.cs | 6 +- .../DesignerSerializationManager.cs | 80 ++-- .../Design/Serialization/ExpressionContext.cs | 60 +-- .../Design/Serialization/ExpressionTable.cs | 2 +- .../Serialization/MemberCodeDomSerializer.cs | 4 +- .../ResourceCodeDomSerializer.cs | 96 ++-- .../Design/Serialization/RootContext.cs | 16 +- .../Serialization/SerializeAbsoluteContext.cs | 30 +- .../Design/Serialization/StatementContext.cs | 42 +- .../Serialization/TypeCodeDomSerializer.cs | 32 +- .../Design/SiteNestedContainer.cs | 12 +- .../ComponentModel/Design/StatusCommandUI.cs | 12 +- .../Design/TypeDescriptorFilterService.cs | 12 +- .../System/Drawing/Design/IToolboxService.cs | 72 +-- .../src/System/Drawing/Design/IToolboxUser.cs | 6 +- .../ToolboxComponentsCreatedEventArgs.cs | 8 +- .../ToolboxComponentsCreatedEventHandler.cs | 2 +- .../ToolboxComponentsCreatingEventArgs.cs | 10 +- .../ToolboxComponentsCreatingEventHandler.cs | 2 +- .../src/System/Drawing/Design/ToolboxItem.cs | 124 +++--- .../Drawing/Design/ToolboxItemCollection.cs | 16 +- .../Design/ToolboxItemCreatorCallback.cs | 2 +- .../Windows/Forms/Design/AdornmentType.cs | 8 +- .../System/Windows/Forms/Design/AxImporter.cs | 40 +- .../Forms/Design/BaseContextMenuStrip.cs | 2 +- .../Behavior/BehaviorDragDropEventArgs.cs | 6 +- .../Forms/Design/Behavior/BehaviorService.cs | 42 +- .../Behavior/ContainerSelectorBehavior.cs | 16 +- .../Design/Behavior/ContainerSelectorGlyph.cs | 10 +- .../Design/Behavior/DesignerActionBehavior.cs | 16 +- .../Design/Behavior/DesignerActionGlyph.cs | 20 +- .../Design/Behavior/DragAssistanceManager.cs | 60 +-- .../Design/Behavior/DropSourceBehavior.cs | 26 +- .../Forms/Design/Behavior/GrabHandleGlyph.cs | 6 +- .../Design/Behavior/GrabHandleGlyphType.cs | 2 +- .../Design/Behavior/LockedBorderGlyph.cs | 8 +- .../Design/Behavior/LockedHandleGlyph.cs | 6 +- .../Design/Behavior/MiniLockedBorderGlyph.cs | 8 +- .../Design/Behavior/NoResizeHandleGlyph.cs | 6 +- .../Behavior/NoResizeSelectionBorderGlyph.cs | 8 +- .../Forms/Design/Behavior/ResizeBehavior.cs | 20 +- .../Design/Behavior/SelectionBorderGlyph.cs | 8 +- .../Behavior/SelectionBorderGlyphType.cs | 2 +- .../Design/Behavior/SelectionGlyphBase.cs | 14 +- .../Forms/Design/Behavior/SelectionManager.cs | 34 +- .../Forms/Design/ChangeToolStripParentVerb.cs | 4 +- .../Forms/Design/CollectionEditVerbManager.cs | 26 +- .../System/Windows/Forms/Design/CommandSet.cs | 134 +++--- .../Windows/Forms/Design/ComponentTray.cs | 188 ++++---- .../ContainerSelectorActiveEventArgs.cs | 6 +- .../ContainerSelectorActiveEventArgsType.cs | 6 +- .../ContainerSelectorActiveEventHandler.cs | 2 +- .../Windows/Forms/Design/ControlDesigner.cs | 116 ++--- .../Forms/Design/CustomMenuItemCollection.cs | 10 +- .../DesignerActionListsChangedEventArgs.cs | 10 +- .../Design/DesignerActionListsChangedType.cs | 6 +- .../Forms/Design/DesignerActionService.cs | 26 +- .../Windows/Forms/Design/DesignerActionUI.cs | 22 +- .../Forms/Design/DesignerActionUIService.cs | 8 +- .../Windows/Forms/Design/DesignerFrame.cs | 62 +-- .../Windows/Forms/Design/DesignerOptions.cs | 18 +- .../Design/DesignerToolStripControlHost.cs | 4 +- .../Windows/Forms/Design/DesignerUtils.cs | 70 +-- .../Design/DesignerVerbToolStripMenuItem.cs | 2 +- .../Forms/Design/EditorServiceContext.cs | 12 +- .../Forms/Design/EventHandlerService.cs | 6 +- .../Forms/Design/FormDocumentDesigner.cs | 50 +-- .../Design/IContainsThemedScrollbarWindows.cs | 2 +- .../Forms/Design/IMenuStatusHandler.cs | 6 +- .../Windows/Forms/Design/IMouseHandler.cs | 12 +- .../Windows/Forms/Design/IOverlayService.cs | 12 +- .../Forms/Design/ISelectionUIService.cs | 36 +- .../Forms/Design/ISplitWindowService.cs | 6 +- .../Forms/Design/ISupportInSituService.cs | 10 +- .../Forms/Design/InheritanceService.cs | 14 +- .../Windows/Forms/Design/InheritanceUI.cs | 10 +- .../Forms/Design/ItemTypeToolStripMenuItem.cs | 2 +- .../Windows/Forms/Design/MenuCommands.cs | 18 +- .../Windows/Forms/Design/SelectionManager.cs | 34 +- .../Windows/Forms/Design/SelectionRules.cs | 20 +- .../Windows/Forms/Design/SelectionStyles.cs | 8 +- .../Forms/Design/SelectionUIService.cs | 124 +++--- .../StandardCommandToolStripMenuItem.cs | 4 +- .../Forms/Design/StandardMenuStripVerb.cs | 14 +- .../Windows/Forms/Design/StatusCommandUI.cs | 12 +- .../TemplateNodeCustomMenuItemCollection.cs | 6 +- .../Forms/Design/ThemedScrollbarMode.cs | 6 +- .../Forms/Design/ToolStripActionList.cs | 6 +- .../Design/ToolStripAdornerWindowService.cs | 44 +- .../Windows/Forms/Design/ToolStripDesigner.cs | 148 +++---- .../Forms/Design/ToolStripDesignerUtils.cs | 16 +- .../Forms/Design/ToolStripDropDownDesigner.cs | 36 +- .../Design/ToolStripDropDownItemDesigner.cs | 6 +- .../Forms/Design/ToolStripEditorManager.cs | 8 +- .../Forms/Design/ToolStripInSituService.cs | 12 +- .../Forms/Design/ToolStripItemBehavior.cs | 22 +- .../ToolStripItemCustomMenuItemCollection.cs | 20 +- .../Forms/Design/ToolStripItemDesigner.cs | 42 +- .../Forms/Design/ToolStripItemGlyph.cs | 6 +- .../ToolStripKeyboardHandlingService.cs | 32 +- .../Forms/Design/ToolStripMenuItemDesigner.cs | 130 +++--- .../Forms/Design/ToolStripTemplateNode.cs | 124 +++--- .../System/Windows/Forms/Design/UndoEngine.cs | 162 +++---- .../WindowsFormsDesignerOptionService.cs | 6 +- .../Drawing/Design/IPropertyValueUIService.cs | 8 +- .../Drawing/Design/PaintValueEventArgs.cs | 6 +- .../Drawing/Design/PropertyValueUIItem.cs | 2 +- .../PropertyValueUIItemInvokeHandler.cs | 2 +- .../src/System/Drawing/Design/UITypeEditor.cs | 20 +- .../Drawing/Design/UITypeEditorEditStyle.cs | 2 +- .../src/System/Resources/IAliasResolver.cs | 2 +- .../src/System/Resources/ResXDataNode.cs | 2 +- .../System/Windows/Forms/AccessibleEvents.cs | 10 +- .../Windows/Forms/AccessibleNavigation.cs | 26 +- .../System/Windows/Forms/AccessibleObject.cs | 418 +++++++++--------- .../System/Windows/Forms/AccessibleRoles.cs | 292 ++++++------ .../Windows/Forms/AccessibleSelection.cs | 16 +- .../System/Windows/Forms/AccessibleStates.cs | 144 +++--- .../System/Windows/Forms/AmbientProperties.cs | 14 +- .../src/System/Windows/Forms/AnchorStyles.cs | 12 +- .../src/System/Windows/Forms/Appearance.cs | 6 +- .../src/System/Windows/Forms/Application.cs | 55 ++- .../Windows/Forms/ApplicationContext.cs | 48 +- .../System/Windows/Forms/ArrangeDirection.cs | 10 +- .../Windows/Forms/ArrangeStartingPosition.cs | 16 +- .../System/Windows/Forms/AutoCompleteMode.cs | 14 +- .../Windows/Forms/AutoCompleteSource.cs | 26 +- .../Forms/AutoCompleteStringCollection.cs | 14 +- .../src/System/Windows/Forms/AutoScaleMode.cs | 12 +- .../src/System/Windows/Forms/AutoSizeMode.cs | 18 +- .../src/System/Windows/Forms/AutoValidate.cs | 20 +- .../Forms/Automation/AutomationLiveSetting.cs | 16 +- .../Automation/AutomationNotificationKind.cs | 12 +- .../AutomationNotificationProcessing.cs | 36 +- .../Forms/Automation/IAutomationLiveRegion.cs | 2 +- .../src/System/Windows/Forms/AxHost.cs | 56 +-- .../System/Windows/Forms/BaseCollection.cs | 6 +- .../src/System/Windows/Forms/Binding.cs | 66 +-- .../Windows/Forms/BindingCompleteContext.cs | 6 +- .../Windows/Forms/BindingCompleteEventArgs.cs | 10 +- .../Forms/BindingCompleteEventHandler.cs | 2 +- .../Windows/Forms/BindingCompleteState.cs | 8 +- .../System/Windows/Forms/BindingContext.cs | 92 ++-- .../Windows/Forms/BindingManagerBase.cs | 16 +- .../src/System/Windows/Forms/BindingSource.cs | 114 ++--- .../Windows/Forms/BindingsCollection.cs | 20 +- .../src/System/Windows/Forms/BootMode.cs | 10 +- .../src/System/Windows/Forms/Border3DSide.cs | 18 +- .../src/System/Windows/Forms/Border3DStyle.cs | 24 +- .../src/System/Windows/Forms/BorderStyle.cs | 8 +- .../System/Windows/Forms/BoundsSpecified.cs | 26 +- .../src/System/Windows/Forms/Button.cs | 8 +- .../System/Windows/Forms/ButtonBorderStyle.cs | 14 +- .../Forms/ButtonInternal/ButtonBaseAdapter.cs | 6 +- .../System/Windows/Forms/ButtonRenderer.cs | 4 +- .../src/System/Windows/Forms/ButtonState.cs | 16 +- .../Forms/CacheVirtualItemsEventHandler.cs | 2 +- .../src/System/Windows/Forms/CaptionButton.cs | 12 +- .../System/Windows/Forms/CharacterCasing.cs | 8 +- .../src/System/Windows/Forms/CheckBox.cs | 22 +- .../System/Windows/Forms/CheckBoxRenderer.cs | 2 +- .../src/System/Windows/Forms/CheckState.cs | 12 +- .../System/Windows/Forms/CheckedListBox.cs | 2 +- .../src/System/Windows/Forms/Clipboard.cs | 6 +- .../src/System/Windows/Forms/CloseReason.cs | 18 +- .../Windows/Forms/ColumnClickEventArgs.cs | 2 +- .../Windows/Forms/ColumnClickEventHandler.cs | 4 +- .../Forms/ColumnHeaderAutoResizeStyle.cs | 14 +- .../System/Windows/Forms/ColumnHeaderStyle.cs | 10 +- .../Forms/ColumnWidthChangingEventArgs.cs | 4 +- .../src/System/Windows/Forms/ComboBox.cs | 188 ++++---- .../System/Windows/Forms/ComboBoxRenderer.cs | 2 +- .../src/System/Windows/Forms/ComboBoxStyle.cs | 12 +- .../src/System/Windows/Forms/CommonDialog.cs | 34 +- .../COM2Interop/COM2ColorConverter.cs | 2 +- .../COM2DataTypeToManagedDataTypeConverter.cs | 2 +- .../ComponentModel/COM2Interop/COM2Enum.cs | 40 +- .../COM2ExtendedBrowsingHandler.cs | 30 +- .../COM2Interop/COM2ExtendedTypeConverter.cs | 4 +- .../COM2Interop/COM2FontConverter.cs | 2 +- .../COM2IManagedPerPropertyBrowsingHandler.cs | 4 +- .../COM2IPerPropertyBrowsingHandler.cs | 8 +- .../COM2IProvidePropertyBuilderHandler.cs | 4 +- .../COM2IVsPerPropertyBrowsingHandler.cs | 34 +- .../COM2Interop/COM2PictureConverter.cs | 2 +- .../COM2Interop/COM2Properties.cs | 66 +-- .../COM2Interop/COM2PropertyDescriptor.cs | 60 +-- .../COM2Interop/COM2TypeInfoProcessor.cs | 36 +- .../COM2Interop/ComNativeDescriptor.cs | 30 +- .../IComponentEditorPageSite.cs | 6 +- .../System/Windows/Forms/ContainerControl.cs | 230 +++++----- .../Windows/Forms/ContentsResizedEventArgs.cs | 8 +- .../Forms/ContentsResizedEventHandler.cs | 4 +- .../System/Windows/Forms/ContextMenuStrip.cs | 2 +- .../Forms/Control.ControlAccessibleObject.cs | 6 +- .../Forms/Control.ControlCollection.cs | 8 +- .../src/System/Windows/Forms/Control.Ime.cs | 18 +- .../src/System/Windows/Forms/Control.cs | 270 +++++------ .../Forms/ControlBindingsCollection.cs | 50 +-- .../System/Windows/Forms/ControlEventArgs.cs | 6 +- .../Windows/Forms/ControlEventHandler.cs | 4 +- .../src/System/Windows/Forms/ControlPaint.cs | 2 +- .../src/System/Windows/Forms/ControlStyles.cs | 112 ++--- .../System/Windows/Forms/ControlUpdateMode.cs | 16 +- .../src/System/Windows/Forms/CreateParams.cs | 36 +- .../System/Windows/Forms/CurrencyManager.cs | 8 +- .../src/System/Windows/Forms/Cursor.cs | 4 +- .../src/System/Windows/Forms/DataFormats.cs | 120 ++--- .../src/System/Windows/Forms/DataGrid.cs | 58 +-- .../Windows/Forms/DataGridBoolColumn.cs | 18 +- .../src/System/Windows/Forms/DataGridCell.cs | 16 +- .../Windows/Forms/DataGridColumnCollection.cs | 38 +- .../Windows/Forms/DataGridColumnStyle.cs | 120 ++--- .../System/Windows/Forms/DataGridLineStyle.cs | 6 +- .../Windows/Forms/DataGridParentRowsLabel.cs | 14 +- .../src/System/Windows/Forms/DataGridRow.cs | 16 +- .../Windows/Forms/DataGridTableCollection.cs | 8 +- .../Windows/Forms/DataGridTableStyle.cs | 8 +- .../System/Windows/Forms/DataGridTextBox.cs | 4 +- .../Windows/Forms/DataGridTextBoxColumn.cs | 28 +- .../Windows/Forms/DataGridView.HitTestInfo.cs | 6 +- .../Windows/Forms/DataGridView.Methods.cs | 1 - .../src/System/Windows/Forms/DataGridView.cs | 8 +- .../System/Windows/Forms/DataGridViewBand.cs | 6 +- .../System/Windows/Forms/DataGridViewCell.cs | 6 +- .../Forms/DataGridViewCellCollection.cs | 6 +- .../Forms/DataGridViewCellLinkedList.cs | 6 +- .../Windows/Forms/DataGridViewColumn.cs | 2 +- .../Forms/DataGridViewColumnCollection.cs | 10 +- .../Windows/Forms/DataGridViewComboBoxCell.cs | 6 +- .../DataGridViewComboBoxEditingControl.cs | 6 +- .../Forms/DataGridViewContentAlignment.cs | 36 +- .../Windows/Forms/DataGridViewElement.cs | 4 +- .../Windows/Forms/DataGridViewHitTestType.cs | 4 +- .../Forms/DataGridViewIntLinkedList.cs | 6 +- .../System/Windows/Forms/DataGridViewRow.cs | 8 +- .../Forms/DataGridViewRowCollection.cs | 10 +- .../DataGridViewSelectedCellCollection.cs | 8 +- .../DataGridViewSelectedColumnCollection.cs | 2 +- .../DataGridViewSelectedRowCollection.cs | 6 +- .../Windows/Forms/DataGridViewTextBoxCell.cs | 6 +- .../DataGridViewTextBoxEditingControl.cs | 6 +- .../src/System/Windows/Forms/DataObject.cs | 22 +- .../Windows/Forms/DataSourceUpdateMode.cs | 28 +- .../Windows/Forms/DataStreamFromComStream.cs | 8 +- .../System/Windows/Forms/DateBoldEventArgs.cs | 4 +- .../Windows/Forms/DateRangeEventArgs.cs | 4 +- .../System/Windows/Forms/DateTimePicker.cs | 40 +- .../Windows/Forms/DateTimePickerFormats.cs | 12 +- .../src/System/Windows/Forms/Day.cs | 18 +- .../Forms/Design/ComponentEditorForm.cs | 2 +- .../Forms/Design/ComponentEditorPage.cs | 60 +-- .../System/Windows/Forms/Design/EventsTab.cs | 16 +- .../System/Windows/Forms/Design/IUIService.cs | 32 +- .../Design/IWindowsFormsEditorService.cs | 8 +- .../Windows/Forms/Design/PropertyTab.cs | 24 +- ...lStripItemDesignerAvailabilityAttribute.cs | 4 +- .../Design/WindowsFormsComponentEditor.cs | 14 +- .../src/System/Windows/Forms/DialogResult.cs | 32 +- .../src/System/Windows/Forms/DockStyle.cs | 10 +- .../System/Windows/Forms/DockingAttribute.cs | 12 +- .../System/Windows/Forms/DockingBehavior.cs | 10 +- .../src/System/Windows/Forms/DomainUpDown.cs | 14 +- .../Windows/Forms/DpiChangedEventArgs.cs | 4 +- .../Windows/Forms/DpiChangedEventHandler.cs | 4 +- .../Windows/Forms/DpiHelper.WinForms.cs | 8 +- .../src/System/Windows/Forms/DragAction.cs | 8 +- .../System/Windows/Forms/DragDropEffects.cs | 14 +- .../src/System/Windows/Forms/DragEventArgs.cs | 22 +- .../System/Windows/Forms/DragEventHandler.cs | 4 +- .../System/Windows/Forms/DrawItemEventArgs.cs | 42 +- .../src/System/Windows/Forms/DrawItemState.cs | 26 +- .../DrawListViewColumnHeaderEventArgs.cs | 30 +- .../DrawListViewColumnHeaderEventHandler.cs | 2 +- .../Forms/DrawListViewItemEventArgs.cs | 26 +- .../Forms/DrawListViewItemEventHandler.cs | 2 +- .../Forms/DrawListViewSubItemEventArgs.cs | 30 +- .../Forms/DrawListViewSubItemEventHandler.cs | 2 +- .../src/System/Windows/Forms/DrawMode.cs | 14 +- .../Windows/Forms/DrawToolTipEventArgs.cs | 22 +- .../Windows/Forms/DrawToolTipEventHandler.cs | 2 +- .../Windows/Forms/DrawTreeNodeEventArgs.cs | 16 +- .../Windows/Forms/DrawTreeNodeEventHandler.cs | 2 +- .../System/Windows/Forms/ErrorBlinkStyle.cs | 18 +- .../Windows/Forms/ErrorIconAlignment.cs | 28 +- .../src/System/Windows/Forms/ErrorProvider.cs | 202 ++++----- .../System/Windows/Forms/FeatureSupport.cs | 24 +- .../src/System/Windows/Forms/FileDialog.cs | 112 ++--- .../Windows/Forms/FileDialogCustomPlace.cs | 16 +- .../System/Windows/Forms/FileDialog_Vista.cs | 2 +- .../src/System/Windows/Forms/FixedPanel.cs | 8 +- .../src/System/Windows/Forms/FlatStyle.cs | 12 +- .../Windows/Forms/FolderBrowserDialog.cs | 36 +- .../src/System/Windows/Forms/Form.cs | 109 +++-- .../System/Windows/Forms/FormBorderStyle.cs | 16 +- .../Windows/Forms/FormClosedEventArgs.cs | 4 +- .../Windows/Forms/FormClosedEventHandler.cs | 2 +- .../Windows/Forms/FormClosingEventArgs.cs | 4 +- .../Windows/Forms/FormClosingEventHandler.cs | 2 +- .../System/Windows/Forms/FormStartPosition.cs | 18 +- .../System/Windows/Forms/FormWindowState.cs | 8 +- .../src/System/Windows/Forms/Formatter.cs | 62 +-- .../src/System/Windows/Forms/FrameStyle.cs | 6 +- .../System/Windows/Forms/GDI/TextRenderer.cs | 2 +- .../Windows/Forms/GiveFeedbackEventArgs.cs | 8 +- .../Windows/Forms/GiveFeedbackEventHandler.cs | 4 +- .../src/System/Windows/Forms/GridItem.cs | 42 +- .../Windows/Forms/GridItemCollection.cs | 8 +- .../System/Windows/Forms/GridTablesFactory.cs | 4 +- .../System/Windows/Forms/GroupBoxRenderer.cs | 2 +- .../src/System/Windows/Forms/HScrollBar.cs | 2 +- .../System/Windows/Forms/HScrollProperties.cs | 2 +- .../Windows/Forms/HandledMouseEventArgs.cs | 2 +- .../src/System/Windows/Forms/HelpEventArgs.cs | 8 +- .../System/Windows/Forms/HelpEventHandler.cs | 2 +- .../src/System/Windows/Forms/HelpNavigator.cs | 22 +- .../src/System/Windows/Forms/HelpProvider.cs | 38 +- .../src/System/Windows/Forms/HighDpiMode.cs | 12 +- .../Windows/Forms/HorizontalAlignment.cs | 10 +- .../src/System/Windows/Forms/HtmlDocument.cs | 6 +- .../src/System/Windows/Forms/HtmlElement.cs | 6 +- .../Forms/HtmlElementErrorEventArgs.cs | 12 +- .../Forms/HtmlElementErrorEventHandler.cs | 2 +- .../Windows/Forms/HtmlElementEventArgs.cs | 12 +- .../src/System/Windows/Forms/HtmlHistory.cs | 8 +- .../src/System/Windows/Forms/HtmlShim.cs | 26 +- .../System/Windows/Forms/HtmlShimManager.cs | 4 +- .../src/System/Windows/Forms/HtmlWindow.cs | 32 +- .../System/Windows/Forms/IButtonControl.cs | 12 +- .../System/Windows/Forms/IContainerControl.cs | 6 +- .../Windows/Forms/ICurrencyManagerProvider.cs | 8 +- .../Windows/Forms/IDataGridEditingService.cs | 2 +- .../src/System/Windows/Forms/IDataObject.cs | 48 +- .../System/Windows/Forms/IFeatureSupport.cs | 12 +- .../System/Windows/Forms/IKeyboardToolTip.cs | 32 +- .../src/System/Windows/Forms/IMEMode.cs | 60 +-- .../System/Windows/Forms/IMessageFilter.cs | 4 +- .../src/System/Windows/Forms/IWin32window.cs | 2 +- .../src/System/Windows/Forms/IWindowTarget.cs | 10 +- .../Windows/Forms/ImageIndexConverter.cs | 8 +- .../System/Windows/Forms/ImageKeyConverter.cs | 52 +-- .../src/System/Windows/Forms/ImageLayout.cs | 12 +- .../src/System/Windows/Forms/ImageList.cs | 8 +- .../src/System/Windows/Forms/InputLanguage.cs | 36 +- .../Forms/InputLanguageChangedEventArgs.cs | 16 +- .../Forms/InputLanguageChangedEventHandler.cs | 4 +- .../Forms/InputLanguageChangingEventArgs.cs | 18 +- .../InputLanguageChangingEventHandler.cs | 2 +- .../Windows/Forms/InputLanguageCollection.cs | 6 +- .../src/System/Windows/Forms/InsertKeyMode.cs | 8 +- .../Windows/Forms/InvalidateEventArgs.cs | 10 +- .../Windows/Forms/InvalidateEventHandler.cs | 4 +- .../System/Windows/Forms/ItemActivation.cs | 14 +- .../System/Windows/Forms/ItemBoundsPortion.cs | 10 +- .../Windows/Forms/ItemCheckEventArgs.cs | 8 +- .../Windows/Forms/ItemCheckEventHandler.cs | 4 +- .../Windows/Forms/ItemCheckedEventArgs.cs | 4 +- .../Windows/Forms/ItemCheckedEventHandler.cs | 4 +- .../System/Windows/Forms/ItemDragEventArgs.cs | 2 +- .../Windows/Forms/ItemDragEventHandler.cs | 4 +- .../src/System/Windows/Forms/KeyEventArgs.cs | 22 +- .../System/Windows/Forms/KeyEventHandler.cs | 4 +- .../System/Windows/Forms/KeyPressEventArgs.cs | 12 +- .../Windows/Forms/KeyPressEventHandler.cs | 4 +- .../src/System/Windows/Forms/Keys.cs | 390 ++++++++-------- .../src/System/Windows/Forms/KeysConverter.cs | 2 +- .../src/System/Windows/Forms/Label.cs | 13 +- .../Windows/Forms/LabelEditEventArgs.cs | 22 +- .../Windows/Forms/LabelEditEventHandler.cs | 4 +- .../Forms/Layout/ArrangedElementCollection.cs | 2 +- .../Windows/Forms/Layout/CommonProperties.cs | 77 ++-- .../Forms/Layout/DockAndAnchorLayout.cs | 26 +- .../System/Windows/Forms/Layout/FlowLayout.cs | 98 ++-- .../Windows/Forms/Layout/IArrangedElement.cs | 40 +- .../Windows/Forms/Layout/LayoutUtils.cs | 32 +- .../Windows/Forms/Layout/TableLayout.cs | 86 ++-- .../Windows/Forms/LeftRightAlignment.cs | 10 +- .../src/System/Windows/Forms/LinkArea.cs | 42 +- .../Windows/Forms/LinkClickedEventArgs.cs | 6 +- .../Windows/Forms/LinkClickedEventHandler.cs | 4 +- .../src/System/Windows/Forms/LinkConverter.cs | 22 +- .../src/System/Windows/Forms/LinkLabel.cs | 22 +- .../Forms/LinkLabelLinkClickedEventArgs.cs | 8 +- .../Forms/LinkLabelLinkClickedEventHandler.cs | 2 +- .../src/System/Windows/Forms/LinkUtilities.cs | 2 +- .../System/Windows/Forms/ListBindingHelper.cs | 18 +- .../Windows/Forms/ListBox.AccessibleObject.cs | 14 +- .../Forms/ListBox.ItemAccessibleObject.cs | 22 +- .../src/System/Windows/Forms/ListBox.cs | 30 +- .../src/System/Windows/Forms/ListControl.cs | 28 +- .../Forms/ListControlConvertEventHandler.cs | 2 +- .../System/Windows/Forms/ListItemConverter.cs | 20 +- .../Forms/ListManagerBindingsCollection.cs | 6 +- .../src/System/Windows/Forms/ListView.cs | 44 +- .../System/Windows/Forms/ListViewAlignment.cs | 12 +- .../src/System/Windows/Forms/ListViewGroup.cs | 18 +- .../Windows/Forms/ListViewGroupCollection.cs | 2 +- .../Windows/Forms/ListViewGroupConverter.cs | 42 +- .../src/System/Windows/Forms/ListViewItem.cs | 90 ++-- .../Forms/ListViewItemMouseHoverEventArgs.cs | 2 +- .../ListViewItemMouseHoverEventHandler.cs | 4 +- .../ListViewItemSelectionChangedEventArgs.cs | 10 +- ...istViewItemSelectionChangedEventHandler.cs | 4 +- .../System/Windows/Forms/ListViewItemState.cs | 2 +- ...tualItemsSelectionRangeChangedEventArgs.cs | 10 +- ...lItemsSelectionRangeChangedEventHandler.cs | 4 +- .../System/Windows/Forms/MDIControlStrip.cs | 2 +- .../src/System/Windows/Forms/MDILayout.cs | 22 +- .../src/System/Windows/Forms/MainMenu.cs | 2 +- .../src/System/Windows/Forms/MaskFormat.cs | 2 +- .../Forms/MaskInputRejectedEventArgs.cs | 6 +- .../Forms/MaskInputRejectedEventHandler.cs | 4 +- .../src/System/Windows/Forms/MaskedTextBox.cs | 13 +- .../Windows/Forms/MeasureItemEventArgs.cs | 16 +- .../src/System/Windows/Forms/Menu.cs | 14 +- .../src/System/Windows/Forms/MenuGlyph.cs | 8 +- .../src/System/Windows/Forms/MenuItem.cs | 186 ++++---- .../src/System/Windows/Forms/MenuMerge.cs | 24 +- .../src/System/Windows/Forms/MenuStrip.cs | 4 +- .../src/System/Windows/Forms/Message.cs | 10 +- .../src/System/Windows/Forms/MessageBox.cs | 2 - .../System/Windows/Forms/MessageBoxButtons.cs | 28 +- .../Windows/Forms/MessageBoxDefaultButton.cs | 12 +- .../System/Windows/Forms/MessageBoxIcon.cs | 20 +- .../System/Windows/Forms/MessageBoxOptions.cs | 8 +- .../System/Windows/Forms/MessageDecoder.cs | 8 +- .../src/System/Windows/Forms/MonthCalendar.cs | 74 ++-- .../src/System/Windows/Forms/MouseButtons.cs | 10 +- .../System/Windows/Forms/MouseEventArgs.cs | 16 +- .../System/Windows/Forms/MouseEventHandler.cs | 4 +- .../src/System/Windows/Forms/NativeWindow.cs | 12 +- .../Windows/Forms/NodeLabelEditEventArgs.cs | 4 +- .../Forms/NodeLabelEditEventHandler.cs | 6 +- .../src/System/Windows/Forms/NumericUpDown.cs | 15 +- .../NumericUpDownAccelerationCollection.cs | 6 +- .../src/System/Windows/Forms/OSFeature.cs | 18 +- .../System/Windows/Forms/OpacityConverter.cs | 20 +- .../src/System/Windows/Forms/Orientation.cs | 6 +- .../Windows/Forms/OwnerDrawPropertyBag.cs | 6 +- .../src/System/Windows/Forms/Padding.cs | 8 +- .../System/Windows/Forms/PaddingConverter.cs | 6 +- .../System/Windows/Forms/PaintEventArgs.cs | 44 +- .../System/Windows/Forms/PaintEventHandler.cs | 2 +- .../src/System/Windows/Forms/Panel.cs | 30 +- .../Windows/Forms/PictureBoxSizeMode.cs | 24 +- .../System/Windows/Forms/PopupEventArgs.cs | 12 +- .../System/Windows/Forms/PopupEventHandler.cs | 2 +- .../Windows/Forms/PreProcessControlState.cs | 8 +- .../Windows/Forms/PreviewKeyDownEventArgs.cs | 24 +- .../Forms/PreviewKeyDownEventHandler.cs | 2 +- .../Windows/Forms/Printing/PageSetupDialog.cs | 6 +- .../Windows/Forms/Printing/PrintDialog.cs | 10 +- .../Forms/Printing/PrintPreviewControl.cs | 10 +- .../Forms/Printing/PrintPreviewDialog.cs | 10 +- .../Windows/Forms/ProfessionalColorTable.cs | 6 +- .../src/System/Windows/Forms/ProgressBar.cs | 6 +- .../System/Windows/Forms/ProgressBarStyle.cs | 10 +- .../src/System/Windows/Forms/PropertyGrid.cs | 168 +++---- .../ArrayElementGridEntry.cs | 14 +- .../PropertyGridInternal/CategoryGridEntry.cs | 14 +- .../Forms/PropertyGridInternal/DocComment.cs | 18 +- .../PropertyGridInternal/DropDownButton.cs | 30 +- .../Forms/PropertyGridInternal/GridEntry.cs | 236 +++++----- .../Forms/PropertyGridInternal/HotCommands.cs | 14 +- .../MergePropertyDescriptor.cs | 4 +- .../MultiPropertyDescriptorGridEntry.cs | 2 +- .../MultiSelectRootGridEntry.cs | 6 +- .../PropertyDescriptorGridEntry.cs | 26 +- .../PropertyGridInternal/PropertyGridView.cs | 154 +++---- .../SingleSelectRootGridEntry.cs | 10 +- .../System/Windows/Forms/PropertyManager.cs | 2 +- .../src/System/Windows/Forms/PropertySort.cs | 16 +- .../src/System/Windows/Forms/PropertyStore.cs | 116 ++--- .../Forms/PropertyValueChangedEventArgs.cs | 2 +- .../Forms/PropertyValueChangedEventHandler.cs | 4 +- .../Forms/QueryAccessibilityHelpEventArgs.cs | 4 +- .../Forms/QueryContinueDragEventArgs.cs | 10 +- .../Forms/QueryContinueDragEventHandler.cs | 4 +- .../Windows/Forms/QuestionEventHandler.cs | 4 +- .../src/System/Windows/Forms/RadioButton.cs | 16 +- .../Windows/Forms/RadioButtonRenderer.cs | 2 +- .../Windows/Forms/RelatedCurrencyManager.cs | 4 +- .../Forms/RetrieveVirtualItemEventHandler.cs | 4 +- .../src/System/Windows/Forms/RichTextBox.cs | 2 +- .../System/Windows/Forms/RichTextBoxFinds.cs | 14 +- .../Forms/RichTextBoxLanguageOptions.cs | 44 +- .../Windows/Forms/RichTextBoxScrollBars.cs | 16 +- .../Forms/RichTextBoxSelectionAttribute.cs | 10 +- .../Forms/RichTextBoxSelectionTypes.cs | 16 +- .../Windows/Forms/RichTextBoxStreamType.cs | 16 +- .../Forms/RichTextBoxWordPunctuations.cs | 12 +- .../src/System/Windows/Forms/RightToLeft.cs | 10 +- .../src/System/Windows/Forms/Screen.cs | 10 +- .../System/Windows/Forms/ScreenOrientation.cs | 10 +- .../src/System/Windows/Forms/ScrollBar.cs | 62 +-- .../src/System/Windows/Forms/ScrollBars.cs | 10 +- .../src/System/Windows/Forms/ScrollButton.cs | 10 +- .../System/Windows/Forms/ScrollEventArgs.cs | 16 +- .../Windows/Forms/ScrollEventHandler.cs | 6 +- .../System/Windows/Forms/ScrollEventType.cs | 40 +- .../System/Windows/Forms/ScrollOrientation.cs | 8 +- .../System/Windows/Forms/ScrollProperties.cs | 22 +- .../System/Windows/Forms/ScrollableControl.cs | 148 +++---- .../Forms/SearchForVirtualItemEventHandler.cs | 2 +- .../Forms/SelectedGridItemChangedEventArgs.cs | 8 +- .../src/System/Windows/Forms/SelectionMode.cs | 12 +- .../src/System/Windows/Forms/Shortcut.cs | 308 ++++++------- .../src/System/Windows/Forms/SizeGripStyle.cs | 8 +- .../src/System/Windows/Forms/SortOrder.cs | 8 +- .../Forms/SpecialFolderEnumConverter.cs | 4 +- .../System/Windows/Forms/SplitContainer.cs | 52 +-- .../Windows/Forms/SplitterCancelEventArgs.cs | 14 +- .../Forms/SplitterCancelEventHandler.cs | 2 +- .../System/Windows/Forms/SplitterEventArgs.cs | 14 +- .../Windows/Forms/SplitterEventHandler.cs | 2 +- .../src/System/Windows/Forms/SplitterPanel.cs | 4 +- .../Forms/StatusBarDrawItemEventArgs.cs | 14 +- .../Forms/StatusBarDrawItemEventHandler.cs | 4 +- .../Windows/Forms/StatusBarPanelAutoSize.cs | 12 +- .../Forms/StatusBarPanelBorderStyle.cs | 6 +- .../Forms/StatusBarPanelClickEventArgs.cs | 10 +- .../Windows/Forms/StatusBarPanelStyle.cs | 6 +- .../src/System/Windows/Forms/StatusStrip.cs | 6 +- .../System/Windows/Forms/SystemParameter.cs | 22 +- .../src/System/Windows/Forms/TabAlignment.cs | 10 +- .../src/System/Windows/Forms/TabAppearance.cs | 16 +- .../src/System/Windows/Forms/TabControl.cs | 6 +- .../System/Windows/Forms/TabControlAction.cs | 2 +- .../Forms/TabControlCancelEventArgs.cs | 8 +- .../Forms/TabControlCancelEventHandler.cs | 2 +- .../Windows/Forms/TabControlEventArgs.cs | 12 +- .../Windows/Forms/TabControlEventHandler.cs | 2 +- .../src/System/Windows/Forms/TabDrawMode.cs | 12 +- .../src/System/Windows/Forms/TabSizeMode.cs | 16 +- .../Forms/TableLayoutCellPaintEventArgs.cs | 6 +- .../System/Windows/Forms/TableLayoutPanel.cs | 22 +- .../Forms/TableLayoutPanelGrowStyle.cs | 16 +- .../Windows/Forms/TableLayoutSettings.cs | 34 +- .../src/System/Windows/Forms/TextBox.cs | 10 +- .../src/System/Windows/Forms/TextBoxBase.cs | 4 +- .../System/Windows/Forms/TextDataFormat.cs | 4 +- .../System/Windows/Forms/TextImageRelation.cs | 6 +- .../Windows/Forms/ThreadExceptionDialog.cs | 2 +- .../src/System/Windows/Forms/TickStyle.cs | 16 +- .../src/System/Windows/Forms/Timer.cs | 30 +- .../src/System/Windows/Forms/ToolBar.cs | 32 +- .../System/Windows/Forms/ToolBarAppearance.cs | 8 +- .../src/System/Windows/Forms/ToolBarButton.cs | 2 +- .../Forms/ToolBarButtonClickEventArgs.cs | 12 +- .../Forms/ToolBarButtonClickEventHandler.cs | 4 +- .../Windows/Forms/ToolBarButtonStyle.cs | 16 +- .../System/Windows/Forms/ToolBarTextAlign.cs | 6 +- .../src/System/Windows/Forms/ToolStrip.cs | 219 +++++---- .../System/Windows/Forms/ToolStripButton.cs | 38 +- .../System/Windows/Forms/ToolStripComboBox.cs | 6 +- .../Windows/Forms/ToolStripContainer.cs | 2 +- .../ToolStripContentPanelRenderEventArgs.cs | 6 +- ...ToolStripContentPanelRenderEventHandler.cs | 2 +- .../Windows/Forms/ToolStripControlHost.cs | 79 ++-- .../System/Windows/Forms/ToolStripDropDown.cs | 54 +-- .../Windows/Forms/ToolStripDropDownButton.cs | 16 +- .../Windows/Forms/ToolStripDropDownItem.cs | 32 +- .../Windows/Forms/ToolStripDropDownMenu.cs | 12 +- .../Forms/ToolStripDropTargetManager.cs | 30 +- .../src/System/Windows/Forms/ToolStripGrip.cs | 4 +- .../Forms/ToolStripGripRenderEventArgs.cs | 8 +- .../Forms/ToolStripGripRenderEventHandler.cs | 2 +- .../src/System/Windows/Forms/ToolStripItem.cs | 321 +++++++------- .../Windows/Forms/ToolStripItemAlignment.cs | 2 +- .../Forms/ToolStripItemClickedEventArgs.cs | 4 +- .../Forms/ToolStripItemClickedEventHandler.cs | 4 +- .../Windows/Forms/ToolStripItemCollection.cs | 22 +- .../Forms/ToolStripItemDisplayStyle.cs | 2 +- .../Windows/Forms/ToolStripItemEventType.cs | 6 +- .../ToolStripItemImageRenderEventArgs.cs | 10 +- .../ToolStripItemImageRenderEventHandler.cs | 2 +- .../Windows/Forms/ToolStripItemOverflow.cs | 2 +- .../Windows/Forms/ToolStripItemPlacement.cs | 2 +- .../Forms/ToolStripItemRenderEventArgs.cs | 8 +- .../Forms/ToolStripItemRenderEventHandler.cs | 2 +- .../Forms/ToolStripItemTextRenderEventArgs.cs | 18 +- .../ToolStripItemTextRenderEventHandler.cs | 2 +- .../System/Windows/Forms/ToolStripLabel.cs | 10 +- .../Forms/ToolStripLocationCancelEventArgs.cs | 6 +- .../ToolStripLocationCancelEventHandler.cs | 4 +- .../System/Windows/Forms/ToolStripManager.cs | 52 +-- .../System/Windows/Forms/ToolStripMenuItem.cs | 58 +-- .../System/Windows/Forms/ToolStripOverflow.cs | 2 +- .../Windows/Forms/ToolStripOverflowButton.cs | 2 +- .../System/Windows/Forms/ToolStripPanel.cs | 10 +- .../Windows/Forms/ToolStripPanelCell.cs | 10 +- .../Forms/ToolStripPanelRenderEventArgs.cs | 4 +- .../Forms/ToolStripPanelRenderEventHandler.cs | 2 +- .../System/Windows/Forms/ToolStripPanelRow.cs | 46 +- .../Windows/Forms/ToolStripProgressBar.cs | 30 +- .../Windows/Forms/ToolStripRenderEventArgs.cs | 10 +- .../Forms/ToolStripRenderEventHandler.cs | 2 +- .../System/Windows/Forms/ToolStripRenderer.cs | 100 ++--- .../Windows/Forms/ToolStripScrollButton.cs | 6 +- .../Windows/Forms/ToolStripSeparator.cs | 2 +- .../ToolStripSeparatorRenderEventArgs.cs | 4 +- .../ToolStripSeparatorRenderEventHandler.cs | 2 +- .../Windows/Forms/ToolStripSplitButton.cs | 66 +-- .../Forms/ToolStripSplitStackLayout.cs | 12 +- .../Windows/Forms/ToolStripStatusLabel.cs | 24 +- .../Windows/Forms/ToolStripSystemRenderer.cs | 26 +- .../System/Windows/Forms/ToolStripTextBox.cs | 4 +- .../src/System/Windows/Forms/ToolTip.cs | 162 +++---- .../src/System/Windows/Forms/ToolTipIcon.cs | 8 +- .../Forms/ToolstripProfessionalRenderer.cs | 2 +- .../src/System/Windows/Forms/TrackBar.cs | 2 +- .../src/System/Windows/Forms/TreeNode.cs | 4 +- .../Windows/Forms/TreeNodeClickEventArgs.cs | 4 +- .../Forms/TreeNodeClickEventHandler.cs | 4 +- .../Windows/Forms/TreeNodeCollection.cs | 6 +- .../Forms/TreeNodeMouseHoverEventArgs.cs | 2 +- .../Forms/TreeNodeMouseHoverEventHandler.cs | 4 +- .../src/System/Windows/Forms/TreeNodeState.cs | 2 +- .../src/System/Windows/Forms/TreeView.cs | 12 +- .../System/Windows/Forms/TreeViewAction.cs | 12 +- .../Forms/TreeViewCancelEventHandler.cs | 4 +- .../System/Windows/Forms/TreeViewDrawMode.cs | 8 +- .../Windows/Forms/TreeViewEventHandler.cs | 4 +- .../Windows/Forms/TreeViewHitTestLocation.cs | 22 +- .../Forms/TreeViewImageKeyConverter.cs | 14 +- .../Windows/Forms/TypeValidationEventArgs.cs | 14 +- .../Forms/TypeValidationEventHandler.cs | 2 +- .../src/System/Windows/Forms/UICues.cs | 10 +- .../System/Windows/Forms/UICuesEventArgs.cs | 10 +- .../Windows/Forms/UICuesEventHandler.cs | 2 +- .../Windows/Forms/UnhandledExceptionMode.cs | 6 +- .../src/System/Windows/Forms/UpDownBase.cs | 36 +- .../System/Windows/Forms/UpDownEventArgs.cs | 2 +- .../Windows/Forms/UpDownEventHandler.cs | 2 +- .../src/System/Windows/Forms/VScrollBar.cs | 2 +- .../System/Windows/Forms/VScrollProperties.cs | 2 +- .../Windows/Forms/ValidationConstraints.cs | 28 +- .../src/System/Windows/Forms/View.cs | 26 +- .../VisualStyles/VisualStyleInformation.cs | 8 +- .../Forms/VisualStyles/VisualStyleRenderer.cs | 2 +- .../Forms/VisualStyles/VisualStyleState.cs | 8 +- .../src/System/Windows/Forms/WebBrowser.cs | 324 +++++++------- .../System/Windows/Forms/WebBrowserBase.cs | 48 +- .../WebBrowserDocumentCompletedEventArgs.cs | 6 +- ...WebBrowserDocumentCompletedEventHandler.cs | 2 +- .../Forms/WebBrowserEncryptionLevel.cs | 4 +- .../System/Windows/Forms/WebBrowserHelper.cs | 6 +- .../Forms/WebBrowserNavigatedEventArgs.cs | 6 +- .../Forms/WebBrowserNavigatedEventHandler.cs | 2 +- .../Forms/WebBrowserNavigatingEventArgs.cs | 8 +- .../Forms/WebBrowserNavigatingEventHandler.cs | 2 +- .../WebBrowserProgressChangedEventArgs.cs | 10 +- .../WebBrowserProgressChangedEventHandler.cs | 2 +- .../Windows/Forms/WebBrowserReadyState.cs | 4 +- .../Windows/Forms/WebBrowserRefreshOption.cs | 2 +- .../Windows/Forms/WebBrowserSiteBase.cs | 22 +- .../src/System/Windows/Forms/WinFormsUtils.cs | 86 ++-- src/System.Windows.Forms/src/misc/DbgUtil.cs | 2 +- .../src/misc/GDI/DeviceContext.cs | 3 +- .../src/misc/GDI/DeviceContext2.cs | 12 +- .../src/misc/GDI/DeviceContexts.cs | 6 +- .../src/misc/GDI/MeasurementDCInfo.cs | 26 +- .../src/misc/GDI/UnsafeNativeMethods.cs | 10 +- .../src/misc/GDI/WindowsFontQuality.cs | 38 +- .../src/misc/GDI/WindowsGraphics2.cs | 5 +- .../CommonControls1.Designer.cs | 8 +- .../CommonControls2.Designer.cs | 8 +- .../ContainersTesting.Designer.cs | 8 +- .../DataControls.Designer.cs | 8 +- .../DialogsTesting.Designer.cs | 8 +- .../tests/AccessibilityTests/Main.Designer.cs | 8 +- .../AccessibilityTests/MenuForm.Designer.cs | 8 +- .../PrintingTesting.Designer.cs | 8 +- .../tests/AccessibilityTests/Program.cs | 2 +- .../RemainingControls.Designer.cs | 8 +- .../StripControls.Designer.cs | 8 +- .../ToolStripContainer.Designer.cs | 8 +- .../TestHelpers.cs | 48 +- .../MauiDataAttribute.cs | 22 +- .../MauiTestHelper.cs | 12 +- .../MauiTestRunner.cs | 10 +- .../WinformsMauiButtonTests.cs | 20 +- .../WinformsMauiComboBoxTests.cs | 20 +- .../Mocks/CollectionEditor.cs | 2 +- .../WinFormsControlsClassicTests/Program.cs | 2 +- .../WinformsControlsTest/Buttons.Designer.cs | 8 +- .../WinformsControlsTest/Calendar.Designer.cs | 8 +- .../ComboBoxes.Designer.cs | 8 +- .../DataGridViewHeaders.Designer.cs | 8 +- .../DateTimePicker.Designer.cs | 8 +- .../DesignTimeAligned.Designer.cs | 8 +- .../ListViewTest.Designer.cs | 8 +- .../MDIParent.Designer.cs | 8 +- .../WinformsControlsTest/MainForm.Designer.cs | 8 +- .../WinformsControlsTest/MdiChild.Designer.cs | 8 +- .../MenuStripAndCheckedListBox.Designer.cs | 8 +- .../MultipleControls.Designer.cs | 8 +- .../WinformsControlsTest/Panels.Designer.cs | 8 +- .../WinformsControlsTest/Program.cs | 2 +- .../PropertyGrid.Designer.cs | 8 +- .../ScalingBeforeChanges.Designer.cs | 8 +- .../WinformsControlsTest/Splitter.Designer.cs | 8 +- .../TreeViewTest.Designer.cs | 8 +- .../tests/UnitTests/ButtonTests.cs | 10 +- .../tests/UnitTests/CheckBoxTests.cs | 16 +- .../tests/UnitTests/CheckedListBoxTests.cs | 14 +- .../CommonUnsafeNativeMethodsTests.cs | 4 +- .../tests/UnitTests/DpiHelperTests.cs | 2 +- .../System/Windows/Forms/ControlTests.cs | 36 +- 781 files changed, 8980 insertions(+), 9026 deletions(-) diff --git a/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Form1.Designer.cs b/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Form1.Designer.cs index 5ee8d7b46e1..7bba2aa658a 100644 --- a/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Form1.Designer.cs +++ b/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Form1.Designer.cs @@ -3,12 +3,12 @@ partial class Form1 { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Program.cs b/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Program.cs index 0b950cc7851..8115906c2e8 100644 --- a/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Program.cs +++ b/pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Program.cs @@ -9,7 +9,7 @@ namespace Company.WinFormsApplication1 static class Program { /// - /// The main entry point for the application. + /// The main entry point for the application. /// [STAThread] static void Main() diff --git a/src/Common/src/ClientUtils.cs b/src/Common/src/ClientUtils.cs index 2a28d03860d..bbf90b935a4 100644 --- a/src/Common/src/ClientUtils.cs +++ b/src/Common/src/ClientUtils.cs @@ -303,10 +303,10 @@ public WeakRefCollection(int size) public ArrayList InnerList { get; } /// - /// Indicates the value where the collection should check its items to remove dead weakref left over. - /// Note: When GC collects weak refs from this collection the WeakRefObject identity changes since its - /// Target becomes null. This makes the item unrecognizable by the collection and cannot be - /// removed - Remove(item) and Contains(item) will not find it anymore. + /// Indicates the value where the collection should check its items to remove dead weakref left over. + /// Note: When GC collects weak refs from this collection the WeakRefObject identity changes since its + /// Target becomes null. This makes the item unrecognizable by the collection and cannot be + /// removed - Remove(item) and Contains(item) will not find it anymore. /// public int RefCheckThreshold { get; set; } = int.MaxValue; // this means this is disabled by default. @@ -416,10 +416,10 @@ private static void Copy(WeakRefCollection sourceList, int sourceIndex, WeakRefC } /// - /// Removes the value using its hash code as its identity. This is needed because the - /// underlying item in the collection may have already been collected changing the - /// identity of the WeakRefObject making it impossible for the collection to identify - /// it. See WeakRefObject for more info. + /// Removes the value using its hash code as its identity. This is needed because the + /// underlying item in the collection may have already been collected changing the + /// identity of the WeakRefObject making it impossible for the collection to identify + /// it. See WeakRefObject for more info. /// public void RemoveByHashCode(object value) { @@ -476,10 +476,10 @@ public int Add(object value) public IEnumerator GetEnumerator() => InnerList.GetEnumerator(); /// - /// Wraps a weak ref object. WARNING: Use this class carefully! - /// When the weak ref is collected, this object looses its identity. This is bad when the object - /// has been added to a collection since Contains(WeakRef(item)) and Remove(WeakRef(item)) would - /// not be able to identify the item. + /// Wraps a weak ref object. WARNING: Use this class carefully! + /// When the weak ref is collected, this object looses its identity. This is bad when the object + /// has been added to a collection since Contains(WeakRef(item)) and Remove(WeakRef(item)) would + /// not be able to identify the item. /// internal class WeakRefObject { diff --git a/src/Common/src/CommonUnsafeNativeMethods.cs b/src/Common/src/CommonUnsafeNativeMethods.cs index a2f7ee8bb29..40303e533d1 100644 --- a/src/Common/src/CommonUnsafeNativeMethods.cs +++ b/src/Common/src/CommonUnsafeNativeMethods.cs @@ -27,8 +27,8 @@ internal class CommonUnsafeNativeMethods internal static extern bool AreDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB); /// - /// Tries to compare two DPIawareness context values. Return true if they were equal. - /// Return false when they are not equal or underlying OS does not support this API. + /// Tries to compare two DPIawareness context values. Return true if they were equal. + /// Return false when they are not equal or underlying OS does not support this API. /// /// true/false public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB) @@ -47,7 +47,7 @@ public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiConte } /// - /// Tries to get thread dpi awareness context + /// Tries to get thread dpi awareness context /// /// returns thread dpi awareness context if API is available in this version of OS. otherwise, return IntPtr.Zero. public static DpiAwarenessContext TryGetThreadDpiAwarenessContext() @@ -64,7 +64,7 @@ public static DpiAwarenessContext TryGetThreadDpiAwarenessContext() } /// - /// Tries to set thread dpi awareness context + /// Tries to set thread dpi awareness context /// /// returns old thread dpi awareness context if API is available in this version of OS. otherwise, return IntPtr.Zero. public static DpiAwarenessContext TrySetThreadDpiAwarenessContext(DpiAwarenessContext dpiContext) diff --git a/src/Common/src/DpiHelper.DpiAwarenessContext.cs b/src/Common/src/DpiHelper.DpiAwarenessContext.cs index 77130cf4ee0..74368a092cc 100644 --- a/src/Common/src/DpiHelper.DpiAwarenessContext.cs +++ b/src/Common/src/DpiHelper.DpiAwarenessContext.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Partial DpiHelper class, with methods specific to thread DpiAwarenessContext + /// Partial DpiHelper class, with methods specific to thread DpiAwarenessContext /// internal static partial class DpiHelper { /// - /// Enters a scope during which the current thread's DPI awareness context is set to + /// Enters a scope during which the current thread's DPI awareness context is set to /// /// /// The new DPI awareness for the current thread /// An object that, when disposed, will reset the current thread's - /// DPI awareness to the value it had when the object was created. + /// DPI awareness to the value it had when the object was created. public static IDisposable EnterDpiAwarenessScope(DpiAwarenessContext awareness) { return new DpiAwarenessScope(awareness); @@ -39,7 +39,7 @@ public static T CreateInstanceInSystemAwareContext(Func createInstance) #region Scoping DpiAwareness context helper class /// - /// Class that help setting Dpi awareness context scope + /// Class that help setting Dpi awareness context scope /// private class DpiAwarenessScope : IDisposable { @@ -47,7 +47,7 @@ private class DpiAwarenessScope : IDisposable private readonly DpiAwarenessContext originalAwareness = DpiAwarenessContext.DPI_AWARENESS_CONTEXT_UNSPECIFIED; /// - /// Enters given Dpi awareness scope + /// Enters given Dpi awareness scope /// public DpiAwarenessScope(DpiAwarenessContext awareness) { @@ -73,7 +73,7 @@ public DpiAwarenessScope(DpiAwarenessContext awareness) } /// - /// Dispose object and resources + /// Dispose object and resources /// public void Dispose() { @@ -81,7 +81,7 @@ public void Dispose() } /// - /// resetting dpiawareness of the thread. + /// resetting dpiawareness of the thread. /// private void ResetDpiAwarenessContextChanges() { diff --git a/src/Common/src/DpiHelper.cs b/src/Common/src/DpiHelper.cs index 02ea26ed319..6250e777661 100644 --- a/src/Common/src/DpiHelper.cs +++ b/src/Common/src/DpiHelper.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen. + /// Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen. /// internal static partial class DpiHelper { @@ -20,7 +20,7 @@ internal static partial class DpiHelper private static bool s_isInitializeDpiHelperForWinforms = false; /// - /// The primary screen's (device) current DPI + /// The primary screen's (device) current DPI /// private static double s_deviceDpi = LogicalDpi; private static double s_logicalToDeviceUnitsScalingFactor = 0.0; @@ -79,7 +79,7 @@ internal static bool DoesCurrentContextRequireScaling => true; /// - /// Returns a boolean to specify if we should enable processing of WM_DPICHANGED and related messages + /// Returns a boolean to specify if we should enable processing of WM_DPICHANGED and related messages /// internal static bool IsPerMonitorV2Awareness { @@ -101,7 +101,7 @@ internal static bool IsPerMonitorV2Awareness } /// - /// Indicates, if rescaling becomes necessary, either because we are not 96 DPI or we're PerMonitorV2Aware. + /// Indicates, if rescaling becomes necessary, either because we are not 96 DPI or we're PerMonitorV2Aware. /// internal static bool IsScalingRequirementMet { @@ -197,8 +197,8 @@ private static Bitmap CreateScaledBitmap(Bitmap logicalImage, int deviceDpi = 0) } /// - /// Returns whether scaling is required when converting between logical-device units, - /// if the application opted in the automatic scaling in the .config file. + /// Returns whether scaling is required when converting between logical-device units, + /// if the application opted in the automatic scaling in the .config file. /// public static bool IsScalingRequired { @@ -210,8 +210,8 @@ public static bool IsScalingRequired } /// - /// Transforms a horizontal or vertical integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a horizontal or vertical integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// value in logical units /// value in device units @@ -226,8 +226,8 @@ public static int LogicalToDeviceUnits(int value, int devicePixels = 0) } /// - /// Transforms a horizontal integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a horizontal integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// The horizontal value in logical units /// The horizontal value in device units @@ -237,8 +237,8 @@ public static int LogicalToDeviceUnitsX(int value) } /// - /// Transforms a vertical integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a vertical integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// The vertical value in logical units /// The vertical value in device units @@ -248,8 +248,8 @@ public static int LogicalToDeviceUnitsY(int value) } /// - /// Returns a new Size with the input's - /// dimensions converted from logical units to device units. + /// Returns a new Size with the input's + /// dimensions converted from logical units to device units. /// /// Size in logical units /// Size in device units @@ -260,7 +260,7 @@ public static Size LogicalToDeviceUnits(Size logicalSize, int deviceDpi = 0) } /// - /// Create and return a new bitmap scaled to the specified size. + /// Create and return a new bitmap scaled to the specified size. /// /// The image to scale from logical units to device units /// The size to scale image to @@ -275,7 +275,7 @@ public static Bitmap CreateResizedBitmap(Bitmap logicalImage, Size targetImageSi } /// - /// Creating bitmap from Icon resource + /// Creating bitmap from Icon resource /// public static Bitmap GetBitmapFromIcon(Type t, string name) { @@ -286,8 +286,8 @@ public static Bitmap GetBitmapFromIcon(Type t, string name) } /// - /// Create a new bitmap scaled for the device units. - /// When displayed on the device, the scaled image will have same size as the original image would have when displayed at 96dpi. + /// Create a new bitmap scaled for the device units. + /// When displayed on the device, the scaled image will have same size as the original image would have when displayed at 96dpi. /// /// The image to scale from logical units to device units public static void ScaleBitmapLogicalToDevice(ref Bitmap logicalBitmap, int deviceDpi = 0) @@ -305,13 +305,13 @@ public static void ScaleBitmapLogicalToDevice(ref Bitmap logicalBitmap, int devi } /// - /// Set, when the first (Parking)Window has been created. From that moment on, - /// we will not be able nor allow to change the Process' DpiMode. + /// Set, when the first (Parking)Window has been created. From that moment on, + /// we will not be able nor allow to change the Process' DpiMode. /// internal static bool FirstParkingWindowCreated { get; set; } /// - /// Gets the DPI awareness. + /// Gets the DPI awareness. /// /// The thread's/process' current HighDpi mode internal static HighDpiMode GetWinformsApplicationDpiAwareness() @@ -372,7 +372,7 @@ internal static HighDpiMode GetWinformsApplicationDpiAwareness() } /// - /// Sets the DPI awareness. If not available on the current OS, it falls back to the next possible. + /// Sets the DPI awareness. If not available on the current OS, it falls back to the next possible. /// /// true/false - If the process DPI awareness is successfully set, returns true. Otherwise false. internal static bool SetWinformsApplicationDpiAwareness(HighDpiMode highDpiMode) diff --git a/src/Common/src/FileDialog_Vista_Interop.cs b/src/Common/src/FileDialog_Vista_Interop.cs index 69e93b476e9..605d3d220aa 100644 --- a/src/Common/src/FileDialog_Vista_Interop.cs +++ b/src/Common/src/FileDialog_Vista_Interop.cs @@ -39,7 +39,7 @@ public class FileSaveDialogRCW } /// - /// IID GUID strings for relevant COM interfaces + /// IID GUID strings for relevant COM interfaces /// public static class IIDGuid { @@ -71,17 +71,17 @@ public interface IModalWindow public enum SIATTRIBFLAGS { /// - /// Multiple items and the attributes together. + /// Multiple items and the attributes together. /// SIATTRIBFLAGS_AND = 0x00000001, /// - /// Multiple items or the attributes together. + /// Multiple items or the attributes together. /// SIATTRIBFLAGS_OR = 0x00000002, /// - /// Call GetAttributes directly on the ShellFolder for multiple attributes + /// Call GetAttributes directly on the ShellFolder for multiple attributes /// SIATTRIBFLAGS_APPCOMPAT = 0x00000003 } @@ -297,9 +297,9 @@ public interface IFileSaveDialog : IFileDialog #pragma warning restore 108 /// - /// Some of these callbacks are cancelable - returning S_FALSE means that the dialog should - /// not proceed (e.g. with closing, changing folder); to support this, we need to use the - /// PreserveSig attribute to enable us to return the proper HRESULT + /// Some of these callbacks are cancelable - returning S_FALSE means that the dialog should + /// not proceed (e.g. with closing, changing folder); to support this, we need to use the + /// PreserveSig attribute to enable us to return the proper HRESULT /// [ComImport] [Guid(IIDGuid.IFileDialogEvents)] diff --git a/src/Common/src/Interop/Interop.BOOL.cs b/src/Common/src/Interop/Interop.BOOL.cs index 9f4dab8935d..4d52a488521 100644 --- a/src/Common/src/Interop/Interop.BOOL.cs +++ b/src/Common/src/Interop/Interop.BOOL.cs @@ -5,13 +5,13 @@ internal partial class Interop { /// - /// Blittable version of Windows BOOL type. It is convenient in situations where - /// manual marshalling is required, or to avoid overhead of regular bool marshalling. + /// Blittable version of Windows BOOL type. It is convenient in situations where + /// manual marshalling is required, or to avoid overhead of regular bool marshalling. /// /// - /// Some Windows APIs return arbitrary integer values although the return type is defined - /// as BOOL. It is best to never compare BOOL to TRUE. Always use bResult != BOOL.FALSE - /// or bResult == BOOL.FALSE . + /// Some Windows APIs return arbitrary integer values although the return type is defined + /// as BOOL. It is best to never compare BOOL to TRUE. Always use bResult != BOOL.FALSE + /// or bResult == BOOL.FALSE . /// internal enum BOOL : int { diff --git a/src/Common/src/Interop/Interop.EditMessages.cs b/src/Common/src/Interop/Interop.EditMessages.cs index c645fd58ea2..25db830252d 100644 --- a/src/Common/src/Interop/Interop.EditMessages.cs +++ b/src/Common/src/Interop/Interop.EditMessages.cs @@ -5,8 +5,8 @@ internal static partial class Interop { /// - /// Edit Control Messages. - /// Copied form winuser.h + /// Edit Control Messages. + /// Copied form winuser.h /// public static class EditMessages { diff --git a/src/Common/src/Interop/Interop.RichEditMessages.cs b/src/Common/src/Interop/Interop.RichEditMessages.cs index 6ccbc7b9c5b..34130f80654 100644 --- a/src/Common/src/Interop/Interop.RichEditMessages.cs +++ b/src/Common/src/Interop/Interop.RichEditMessages.cs @@ -5,8 +5,8 @@ internal static partial class Interop { /// - /// RichTextBox Control Messages. Note that some messages have the same name but different value compared to normal Edit Control Messages. - /// Copied form richedit.h + /// RichTextBox Control Messages. Note that some messages have the same name but different value compared to normal Edit Control Messages. + /// Copied form richedit.h /// public static class RichEditMessages { diff --git a/src/Common/src/Interop/Kernel32/Interop.GetProcAddress.cs b/src/Common/src/Interop/Kernel32/Interop.GetProcAddress.cs index 13f539a9c11..787269f344d 100644 --- a/src/Common/src/Interop/Kernel32/Interop.GetProcAddress.cs +++ b/src/Common/src/Interop/Kernel32/Interop.GetProcAddress.cs @@ -10,7 +10,7 @@ internal partial class Interop internal partial class Kernel32 { /// - /// There isn't a unicode version of this API so pass in an ANSI string. + /// There isn't a unicode version of this API so pass in an ANSI string. /// [DllImport(Libraries.Kernel32, CharSet = CharSet.Ansi, BestFitMapping = false, ExactSpelling = true)] public static extern IntPtr GetProcAddress(IntPtr hModule, string lpProcName); diff --git a/src/Common/src/Interop/Ole32/Interop.IStream.cs b/src/Common/src/Interop/Ole32/Interop.IStream.cs index ffb6920ea90..ef1ba6379cb 100644 --- a/src/Common/src/Interop/Ole32/Interop.IStream.cs +++ b/src/Common/src/Interop/Ole32/Interop.IStream.cs @@ -10,11 +10,11 @@ internal static partial class Interop internal static partial class Ole32 { /// - /// COM IStream interface. + /// COM IStream interface. /// /// - /// The definition in does not lend - /// itself to efficiently accessing / implementing IStream. + /// The definition in does not lend + /// itself to efficiently accessing / implementing IStream. /// [ComImport] [Guid("0000000C-0000-0000-C000-000000000046")] diff --git a/src/Common/src/Interop/Ole32/Interop.STATFLAG.cs b/src/Common/src/Interop/Ole32/Interop.STATFLAG.cs index 9b7322e3bf0..0d8a14a6740 100644 --- a/src/Common/src/Interop/Ole32/Interop.STATFLAG.cs +++ b/src/Common/src/Interop/Ole32/Interop.STATFLAG.cs @@ -11,18 +11,18 @@ internal static partial class Interop internal static partial class Ole32 { /// - /// Stat flags for . + /// Stat flags for . /// /// public enum STATFLAG : uint { /// - /// Stat includes the name. + /// Stat includes the name. /// STATFLAG_DEFAULT = 0, /// - /// Stat doesn't include the name. + /// Stat doesn't include the name. /// STATFLAG_NONAME = 1 } diff --git a/src/Common/src/Interop/Ole32/Interop.STATSTG.cs b/src/Common/src/Interop/Ole32/Interop.STATSTG.cs index 3877d3f5f54..705df8d4a53 100644 --- a/src/Common/src/Interop/Ole32/Interop.STATSTG.cs +++ b/src/Common/src/Interop/Ole32/Interop.STATSTG.cs @@ -11,23 +11,23 @@ internal static partial class Interop internal static partial class Ole32 { /// - /// Statistics for . + /// Statistics for . /// /// /// - /// The definition in isn't blittable. + /// The definition in isn't blittable. /// [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)] public struct STATSTG { /// - /// Pointer to the name. + /// Pointer to the name. /// private IntPtr pwcsName; public STGTY type; /// - /// Size of the stream in bytes. + /// Size of the stream in bytes. /// public ulong cbSize; @@ -36,26 +36,26 @@ public struct STATSTG public FILETIME atime; /// - /// The stream mode. + /// The stream mode. /// public STGM grfMode; /// - /// Supported locking modes. + /// Supported locking modes. /// /// /// - /// '0' means does not support lock modes. + /// '0' means does not support lock modes. /// public uint grfLocksSupported; /// - /// Only for IStorage objects + /// Only for IStorage objects /// public Guid clsid; /// - /// Only valid for IStorage objects. + /// Only valid for IStorage objects. /// public uint grfStateBits; public uint reserved; @@ -63,7 +63,7 @@ public struct STATSTG public string GetName() => Marshal.PtrToStringUni(pwcsName); /// - /// Caller is responsible for freeing the name memory. + /// Caller is responsible for freeing the name memory. /// public void FreeName() { @@ -74,7 +74,7 @@ public void FreeName() } /// - /// Callee is repsonsible for allocating the name memory. + /// Callee is repsonsible for allocating the name memory. /// public void AllocName(string name) { diff --git a/src/Common/src/Interop/Ole32/Interop.STGM.cs b/src/Common/src/Interop/Ole32/Interop.STGM.cs index 61918bbeb4a..2c92bfe0672 100644 --- a/src/Common/src/Interop/Ole32/Interop.STGM.cs +++ b/src/Common/src/Interop/Ole32/Interop.STGM.cs @@ -9,16 +9,16 @@ internal static partial class Interop internal static partial class Ole32 { /// - /// Stream / storage modes. + /// Stream / storage modes. /// /// [Flags] public enum STGM : uint { /// - /// Read only, and each change to a storage or stream element is written as it occurs. - /// Fails if the given storage object already exists. - /// [STGM_DIRECT] [STGM_READ] [STGM_FAILIFTHERE] [STGM_SHARE_DENY_WRITE] + /// Read only, and each change to a storage or stream element is written as it occurs. + /// Fails if the given storage object already exists. + /// [STGM_DIRECT] [STGM_READ] [STGM_FAILIFTHERE] [STGM_SHARE_DENY_WRITE] /// Default = 0x00000000, STGM_READ = 0x00000000, diff --git a/src/Common/src/Interop/Ole32/Interop.STGTY.cs b/src/Common/src/Interop/Ole32/Interop.STGTY.cs index 2c15d777d72..6af99d31d65 100644 --- a/src/Common/src/Interop/Ole32/Interop.STGTY.cs +++ b/src/Common/src/Interop/Ole32/Interop.STGTY.cs @@ -11,7 +11,7 @@ internal static partial class Interop internal static partial class Ole32 { /// - /// Type of the storage element. Used with . + /// Type of the storage element. Used with . /// /// public enum STGTY : uint diff --git a/src/Common/src/NativeMethods.cs b/src/Common/src/NativeMethods.cs index 4ac1b47bd2d..4d3b5ad927a 100644 --- a/src/Common/src/NativeMethods.cs +++ b/src/Common/src/NativeMethods.cs @@ -1894,24 +1894,24 @@ public struct DEVMODE public interface IVsPerPropertyBrowsing { /// - /// Hides the property at the given dispid from the properties window - /// implmentors should can return E_NOTIMPL to show all properties that - /// are otherwise browsable. + /// Hides the property at the given dispid from the properties window + /// implmentors should can return E_NOTIMPL to show all properties that + /// are otherwise browsable. /// [PreserveSig] int HideProperty(int dispid, ref bool pfHide); /// - /// Will have the "+" expandable glyph next to them and can be expanded or collapsed by the user - /// Returning a non-S_OK return code or false for pfDisplay will suppress this feature + /// Will have the "+" expandable glyph next to them and can be expanded or collapsed by the user + /// Returning a non-S_OK return code or false for pfDisplay will suppress this feature /// [PreserveSig] int DisplayChildProperties(int dispid, ref bool pfDisplay); /// - /// Retrieves the localized name and description for a property. - /// returning a non-S_OK return code will display the default values + /// Retrieves the localized name and description for a property. + /// returning a non-S_OK return code will display the default values /// [PreserveSig] int GetLocalizedPropertyInfo(int dispid, int localeID, @@ -1921,38 +1921,38 @@ int GetLocalizedPropertyInfo(int dispid, int localeID, string[] pbstrLocalizeDescription); /// - /// Determines if the given (usually current) value for a property is the default. If it is not default, - /// the property will be shown as bold in the browser to indcate that it has been modified from the default. + /// Determines if the given (usually current) value for a property is the default. If it is not default, + /// the property will be shown as bold in the browser to indcate that it has been modified from the default. /// [PreserveSig] int HasDefaultValue(int dispid, ref bool fDefault); /// - /// Determines if a property should be made read only. This only applies to properties that are writeable, + /// Determines if a property should be made read only. This only applies to properties that are writeable, /// [PreserveSig] int IsPropertyReadOnly(int dispid, ref bool fReadOnly); /// - /// Returns the classname for this object. The class name is the non-bolded text - /// that appears in the properties window selection combo. If this method returns - /// a non-S_OK return code, the default will be used. The default is the name - /// string from a call to ITypeInfo::GetDocumentation(MEMID_NIL, ...); + /// Returns the classname for this object. The class name is the non-bolded text + /// that appears in the properties window selection combo. If this method returns + /// a non-S_OK return code, the default will be used. The default is the name + /// string from a call to ITypeInfo::GetDocumentation(MEMID_NIL, ...); [PreserveSig] int GetClassName([In, Out]ref string pbstrClassName); /// - /// Checks whether the given property can be reset to some default value. - /// If return value is non-S_OK or *pfCanReset is + /// Checks whether the given property can be reset to some default value. + /// If return value is non-S_OK or *pfCanReset is /// [PreserveSig] int CanResetPropertyValue(int dispid, [In, Out]ref bool pfCanReset); /// - /// If the return value is S_OK, the property's value will then be refreshed to the - /// new default values. + /// If the return value is S_OK, the property's value will then be refreshed to the + /// new default values. /// [PreserveSig] int ResetPropertyValue(int dispid); diff --git a/src/Common/src/OsVersion.cs b/src/Common/src/OsVersion.cs index 119949cba40..f190adb93c1 100644 --- a/src/Common/src/OsVersion.cs +++ b/src/Common/src/OsVersion.cs @@ -19,19 +19,19 @@ private static Interop.NtDll.RTL_OSVERSIONINFOEX InitVersion() } /// - /// Is Windows 10 Anniversary Update or later. (Redstone 1, build 14393, version 1607) + /// Is Windows 10 Anniversary Update or later. (Redstone 1, build 14393, version 1607) /// public static bool IsWindows10_1607OrGreater => s_versionInfo.dwMajorVersion >= 10 && s_versionInfo.dwBuildNumber >= 14393; /// - /// Is Windows 10 Creators Update or later. (Redstone 2, build 15063, version 1703) + /// Is Windows 10 Creators Update or later. (Redstone 2, build 15063, version 1703) /// public static bool IsWindows10_1703OrGreater => s_versionInfo.dwMajorVersion >= 10 && s_versionInfo.dwBuildNumber >= 15063; /// - /// Is Windows 8.1 or later. + /// Is Windows 8.1 or later. /// public static bool IsWindows8_1OrGreater => s_versionInfo.dwMajorVersion >= 10 diff --git a/src/Common/src/SpanHelpers.cs b/src/Common/src/SpanHelpers.cs index 9d447ad5a40..5dcd82a6cbb 100644 --- a/src/Common/src/SpanHelpers.cs +++ b/src/Common/src/SpanHelpers.cs @@ -9,9 +9,9 @@ namespace System.Windows.Forms internal static class SpanHelpers { /// - /// Copies the to the , - /// terminating with null and truncating to fit if - /// necessary. + /// Copies the to the , + /// terminating with null and truncating to fit if + /// necessary. /// public static void CopyAndTerminate(ReadOnlySpan source, Span destination) { @@ -28,7 +28,7 @@ public static void CopyAndTerminate(ReadOnlySpan source, Span destin } /// - /// Slices the given at the first null found (if any). + /// Slices the given at the first null found (if any). /// public static ReadOnlySpan SliceAtFirstNull(this ReadOnlySpan span) { @@ -39,7 +39,7 @@ public static ReadOnlySpan SliceAtFirstNull(this ReadOnlySpan span) } /// - /// Slices the given at the first null found (if any). + /// Slices the given at the first null found (if any). /// public static Span SliceAtFirstNull(this Span span) { diff --git a/src/Common/src/UnsafeNativeMethods.cs b/src/Common/src/UnsafeNativeMethods.cs index 583d57625ac..74f4a56f75b 100644 --- a/src/Common/src/UnsafeNativeMethods.cs +++ b/src/Common/src/UnsafeNativeMethods.cs @@ -748,7 +748,7 @@ public static extern bool SystemParametersInfoForDpi( uint dpi); /// - /// Tries to get system parameter info for the dpi. dpi is ignored if "SystemParametersInfoForDpi()" API is not available on the OS that this application is running. + /// Tries to get system parameter info for the dpi. dpi is ignored if "SystemParametersInfoForDpi()" API is not available on the OS that this application is running. /// public unsafe static bool TrySystemParametersInfoForDpi(ref NativeMethods.NONCLIENTMETRICSW metrics, uint dpi) { @@ -4008,7 +4008,7 @@ void Render( } /// - /// This class provides static methods to create, activate and deactivate the theming scope. + /// This class provides static methods to create, activate and deactivate the theming scope. /// internal class ThemingScope { @@ -4017,8 +4017,8 @@ internal class ThemingScope private static bool contextCreationSucceeded; /// - /// We now use explicitactivate everywhere and use this method to determine if we - /// really need to activate the activationcontext. This should be pretty fast. + /// We now use explicitactivate everywhere and use this method to determine if we + /// really need to activate the activationcontext. This should be pretty fast. /// private static bool IsContextActive() { @@ -4157,7 +4157,7 @@ internal static extern int UiaRaiseNotificationEvent( // obtained from UIAutomation source code /// - /// Logical structure change flags + /// Logical structure change flags /// [ComVisible(true)] [Guid("e4cfef41-071d-472c-a65c-c14f59ea81eb")] @@ -4204,25 +4204,25 @@ public enum ProviderOptions OverrideProvider = 0x0008, /// Indicates that this provider handles its own focus, and does not want - /// UIA to set focus to the nearest HWND on its behalf when AutomationElement.SetFocus - /// is used. This option is typically used by providers for HWNDs that appear to take - /// focus without actually receiving actual Win32 focus, such as menus and dropdowns + /// UIA to set focus to the nearest HWND on its behalf when AutomationElement.SetFocus + /// is used. This option is typically used by providers for HWNDs that appear to take + /// focus without actually receiving actual Win32 focus, such as menus and dropdowns ProviderOwnsSetFocus = 0x0010, /// Indicates that this provider expects to be called according to COM threading rules: - /// if the provider is in a Single-Threaded Apartment, it will be called only on the apartment - /// thread. Only Server-side providers can use this option. + /// if the provider is in a Single-Threaded Apartment, it will be called only on the apartment + /// thread. Only Server-side providers can use this option. UseComThreading = 0x0020 } public static readonly Guid guid_IAccessibleEx = new Guid("{F8B80ADA-2C44-48D0-89BE-5FF23C9CD875}"); /// - /// The interface representing containers that manage selection. + /// The interface representing containers that manage selection. /// /// - /// Client code uses this public interface; server implementers implent the - /// ISelectionProvider public interface instead. + /// Client code uses this public interface; server implementers implent the + /// ISelectionProvider public interface instead. /// [ComImport()] [ComVisible(true)] @@ -4231,7 +4231,7 @@ public enum ProviderOptions public interface ISelectionProvider { /// - /// Get the currently selected elements + /// Get the currently selected elements /// /// An AutomationElement array containing the currently selected elements [return: MarshalAs(UnmanagedType.SafeArray, SafeArraySubType = VarEnum.VT_UNKNOWN)] @@ -4239,7 +4239,7 @@ public interface ISelectionProvider object[] GetSelection(); /// - /// Indicates whether the control allows more than one element to be selected + /// Indicates whether the control allows more than one element to be selected /// /// Boolean indicating whether the control allows more than one element to be selected /// If this is false, then the control is a single-select ccntrol @@ -4250,7 +4250,7 @@ bool CanSelectMultiple } /// - /// Indicates whether the control requires at least one element to be selected + /// Indicates whether the control requires at least one element to be selected /// /// Boolean indicating whether the control requires at least one element to be selected /// If this is false, then the control allows all elements to be unselected @@ -4262,9 +4262,9 @@ bool IsSelectionRequired } /// - /// Define a Selectable Item (only supported on logical elements that are a - /// child of an Element that supports SelectionPattern and is itself selectable). - /// This allows for manipulation of Selection from the element itself. + /// Define a Selectable Item (only supported on logical elements that are a + /// child of an Element that supports SelectionPattern and is itself selectable). + /// This allows for manipulation of Selection from the element itself. /// [ComImport()] [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] @@ -4273,37 +4273,37 @@ bool IsSelectionRequired public interface ISelectionItemProvider { /// - /// Sets the current element as the selection - /// This clears the selection from other elements in the container. + /// Sets the current element as the selection + /// This clears the selection from other elements in the container. /// void Select(); /// - /// Adds current element to selection. + /// Adds current element to selection. /// void AddToSelection(); /// - /// Removes current element from selection. + /// Removes current element from selection. /// void RemoveFromSelection(); /// - /// Check whether an element is selected. + /// Check whether an element is selected. /// /// Returns true if the element is selected. bool IsSelected { [return: MarshalAs(UnmanagedType.Bool)] get; } /// - /// The logical element that supports the SelectionPattern for this Item. + /// The logical element that supports the SelectionPattern for this Item. /// /// Returns a IRawElementProviderSimple. IRawElementProviderSimple SelectionContainer { [return: MarshalAs(UnmanagedType.Interface)] get; } } /// - /// Implemented by providers which want to provide information about or want to - /// reposition contained HWND-based elements. + /// Implemented by providers which want to provide information about or want to + /// reposition contained HWND-based elements. /// [ComVisible(true)] [Guid("1d5df27c-8947-4425-b8d9-79787bb460b8")] @@ -4311,8 +4311,8 @@ public interface ISelectionItemProvider public interface IRawElementProviderHwndOverride : IRawElementProviderSimple { /// - /// Request a provider for the specified component. The returned provider can supply additional - /// properties or override properties of the specified component. + /// Request a provider for the specified component. The returned provider can supply additional + /// properties or override properties of the specified component. /// /// The window handle of the component. /// Return the provider for the specified component, or null if the component is not being overridden. @@ -4389,12 +4389,12 @@ int ConvertReturnedElement( public interface IExpandCollapseProvider { /// - /// Blocking method that returns after the element has been expanded. + /// Blocking method that returns after the element has been expanded. /// void Expand(); /// - /// Blocking method that returns after the element has been collapsed. + /// Blocking method that returns after the element has been collapsed. /// void Collapse(); @@ -4412,7 +4412,7 @@ ExpandCollapseState ExpandCollapseState public interface IValueProvider { /// - /// Request to set the value that this UI element is representing + /// Request to set the value that this UI element is representing /// /// Value to set the UI to void SetValue([MarshalAs(UnmanagedType.LPWStr)] string value); @@ -4460,16 +4460,16 @@ public interface IRangeValueProvider public interface IRawElementProviderSimple { /// - /// Indicates the type of provider this is, for example, whether it is a client-side - /// or server-side provider. + /// Indicates the type of provider this is, for example, whether it is a client-side + /// or server-side provider. /// /// - /// Providers must specify at least either one of ProviderOptions.ClientSideProvider - /// or ProviderOptions.ServerSideProvider. + /// Providers must specify at least either one of ProviderOptions.ClientSideProvider + /// or ProviderOptions.ServerSideProvider. /// - /// UIAutomation treats different types of providers - /// differently - for example, events from server-side provider are broadcast to all listening - /// clients, whereas events from client-side providers remain in that client. + /// UIAutomation treats different types of providers + /// differently - for example, events from server-side provider are broadcast to all listening + /// clients, whereas events from client-side providers remain in that client. /// ProviderOptions ProviderOptions { @@ -4477,7 +4477,7 @@ ProviderOptions ProviderOptions } /// - /// Get a pattern interface from this object + /// Get a pattern interface from this object /// /// Identifier indicating the interface to return /// Returns the interface as an object, if supported; otherwise returns null/ @@ -4485,7 +4485,7 @@ ProviderOptions ProviderOptions object GetPatternProvider(int patternId); /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. @@ -4497,10 +4497,10 @@ ProviderOptions ProviderOptions // also need to implement this so we can determine the HWND. Still only // lives on a root, however. /// - /// Returns a base provider for this element. + /// Returns a base provider for this element. /// - /// Typically only used by elements that correspond directly to a Win32 Window Handle, - /// in which case the implementation returns AutomationInteropProvider.BaseElementFromHandle( hwnd ). + /// Typically only used by elements that correspond directly to a Win32 Window Handle, + /// in which case the implementation returns AutomationInteropProvider.BaseElementFromHandle( hwnd ). /// IRawElementProviderSimple HostRawElementProvider { @@ -4509,7 +4509,7 @@ IRawElementProviderSimple HostRawElementProvider } /// - /// Directions for navigation the UIAutomation tree + /// Directions for navigation the UIAutomation tree /// [ComVisible(true)] [Guid("670c3006-bf4c-428b-8534-e1848f645122")] @@ -4528,13 +4528,13 @@ public enum NavigateDirection } /// - /// Implemented by providers to expose elements that are part of - /// a structure more than one level deep. For simple one-level - /// structures which have no children, IRawElementProviderSimple - /// can be used instead. + /// Implemented by providers to expose elements that are part of + /// a structure more than one level deep. For simple one-level + /// structures which have no children, IRawElementProviderSimple + /// can be used instead. /// - /// The root node of the fragment must support the IRawElementProviderFragmentRoot - /// interface, which is derived from this, and has some additional methods. + /// The root node of the fragment must support the IRawElementProviderFragmentRoot + /// interface, which is derived from this, and has some additional methods. /// [ComVisible(true)] [Guid("f7063da8-8359-439c-9297-bbc5299a7d87")] @@ -4543,7 +4543,7 @@ public enum NavigateDirection public interface IRawElementProviderFragment : IRawElementProviderSimple { /// - /// Request to return the element in the specified direction + /// Request to return the element in the specified direction /// /// Indicates the direction in which to navigate /// Returns the element in the specified direction @@ -4551,19 +4551,19 @@ public interface IRawElementProviderFragment : IRawElementProviderSimple object /*IRawElementProviderFragment*/ Navigate(NavigateDirection direction); /// - /// Gets the runtime ID of an elemenent. This should be unique - /// among elements on a desktop. + /// Gets the runtime ID of an elemenent. This should be unique + /// among elements on a desktop. /// /// - /// Proxy implementations should return null for the top-level proxy which - /// correpsonds to the HWND; and should return an array which starts - /// with AutomationInteropProvider.AppendRuntimeId, followed by values - /// which are then unique within that proxy's HWNDs. + /// Proxy implementations should return null for the top-level proxy which + /// correpsonds to the HWND; and should return an array which starts + /// with AutomationInteropProvider.AppendRuntimeId, followed by values + /// which are then unique within that proxy's HWNDs. /// int[] GetRuntimeId(); /// - /// Return a bounding rectangle of this element + /// Return a bounding rectangle of this element /// NativeMethods.UiaRect BoundingRectangle { @@ -4571,25 +4571,25 @@ NativeMethods.UiaRect BoundingRectangle } /// - /// If this UI is capable of hosting other UI that also supports UIAutomation, and - /// the subtree rooted at this element contains such hosted UI fragments, this should return - /// an array of those fragments. + /// If this UI is capable of hosting other UI that also supports UIAutomation, and + /// the subtree rooted at this element contains such hosted UI fragments, this should return + /// an array of those fragments. /// - /// If this UI does not host other UI, it may return null. + /// If this UI does not host other UI, it may return null. /// [return: MarshalAs(UnmanagedType.SafeArray, SafeArraySubType = VarEnum.VT_UNKNOWN)] object[] /*IRawElementProviderSimple[]*/ GetEmbeddedFragmentRoots(); /// - /// Request that focus is set to this item. - /// The UIAutomation framework will ensure that the UI hosting this fragment is already - /// focused before calling this method, so this method should only update its internal - /// focus state; it should not attempt to give its own HWND the focus, for example. + /// Request that focus is set to this item. + /// The UIAutomation framework will ensure that the UI hosting this fragment is already + /// focused before calling this method, so this method should only update its internal + /// focus state; it should not attempt to give its own HWND the focus, for example. /// void SetFocus(); /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// IRawElementProviderFragmentRoot FragmentRoot { @@ -4599,9 +4599,9 @@ IRawElementProviderFragmentRoot FragmentRoot } /// - /// The root element in a fragment of UI must support this interface. Other - /// elements in the same fragment need to support the IRawElementProviderFragment - /// interface. + /// The root element in a fragment of UI must support this interface. Other + /// elements in the same fragment need to support the IRawElementProviderFragment + /// interface. /// [ComVisible(true)] [Guid("620ce2a5-ab8f-40a9-86cb-de3c75599b58")] @@ -4610,24 +4610,24 @@ IRawElementProviderFragmentRoot FragmentRoot public interface IRawElementProviderFragmentRoot : IRawElementProviderFragment { /// - /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// Return the child element at the specified point, if one exists, + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// /// x coordinate of point to check /// y coordinate of point to check /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// [return: MarshalAs(UnmanagedType.IUnknown)] object /*IRawElementProviderFragment*/ ElementProviderFromPoint(double x, double y); /// - /// Return the element in this fragment which has the keyboard focus, + /// Return the element in this fragment which has the keyboard focus, /// /// Return the element in this fragment which has the keyboard focus, - /// if any; otherwise return null. + /// if any; otherwise return null. [return: MarshalAs(UnmanagedType.IUnknown)] object /*IRawElementProviderFragment*/ GetFocus(); } @@ -4758,14 +4758,14 @@ IRawElementProviderSimple ContainingGrid } /// - /// Implemented by objects that have a single, unambiguous, action associated with them. - /// These objects are usually stateless, and invoking them does not change their own state, - /// but causes something to happen in the larger context of the app the control is in. + /// Implemented by objects that have a single, unambiguous, action associated with them. + /// These objects are usually stateless, and invoking them does not change their own state, + /// but causes something to happen in the larger context of the app the control is in. /// - /// Examples of UI that implments this includes: - /// Push buttons - /// Hyperlinks - /// Menu items + /// Examples of UI that implments this includes: + /// Push buttons + /// Hyperlinks + /// Menu items /// [ComImport()] [ComVisible(true)] @@ -4774,17 +4774,17 @@ IRawElementProviderSimple ContainingGrid public interface IInvokeProvider { /// - /// Request that the control initiate its action. - /// Should return immediately without blocking. - /// There is no way to determine what happened, when it happend, or whether - /// anything happened at all. + /// Request that the control initiate its action. + /// Should return immediately without blocking. + /// There is no way to determine what happened, when it happend, or whether + /// anything happened at all. /// void Invoke(); } /// - /// Implemented by objects in a known Scrollable context, such as ListItems, ListViewItems, TreeViewItems, and Tabs. - /// This allows them to be scrolled into view using known API's based on the control in question. + /// Implemented by objects in a known Scrollable context, such as ListItems, ListViewItems, TreeViewItems, and Tabs. + /// This allows them to be scrolled into view using known API's based on the control in question. /// [ComImport()] [ComVisible(true)] @@ -4793,9 +4793,9 @@ public interface IInvokeProvider public interface IScrollItemProvider { /// - /// Scrolls the windows containing this automation element to make this element visible. - /// InvalidOperationException should be thrown if item becomes unable to be scrolled. Makes - /// no guarantees about where the item will be in the scrolled window. + /// Scrolls the windows containing this automation element to make this element visible. + /// InvalidOperationException should be thrown if item becomes unable to be scrolled. Makes + /// no guarantees about where the item will be in the scrolled window. /// void ScrollIntoView(); } diff --git a/src/Common/tests/CommonMemberDataAttribute.cs b/src/Common/tests/CommonMemberDataAttribute.cs index 5065cba6a36..907d8aa8406 100644 --- a/src/Common/tests/CommonMemberDataAttribute.cs +++ b/src/Common/tests/CommonMemberDataAttribute.cs @@ -9,10 +9,10 @@ namespace WinForms.Common.Tests { /// - /// A custom MemberData attribute that is specialized for the CommonTestHelper type. - /// Useful to remove the need to suffix all attributes with "MemberType = ..." - /// We cannot inherit from MemberDataAttribute as it is sealed, so we have to reimplement - /// ConvertDataItem inheriting from MemberDataAttributeBase. + /// A custom MemberData attribute that is specialized for the CommonTestHelper type. + /// Useful to remove the need to suffix all attributes with "MemberType = ..." + /// We cannot inherit from MemberDataAttribute as it is sealed, so we have to reimplement + /// ConvertDataItem inheriting from MemberDataAttributeBase. /// public sealed class CommonMemberDataAttribute : MemberDataAttributeBase { diff --git a/src/Common/tests/InternalUtilitiesForTests/src/AdminHelpers.cs b/src/Common/tests/InternalUtilitiesForTests/src/AdminHelpers.cs index 526e6bd5002..9550a348939 100644 --- a/src/Common/tests/InternalUtilitiesForTests/src/AdminHelpers.cs +++ b/src/Common/tests/InternalUtilitiesForTests/src/AdminHelpers.cs @@ -10,7 +10,7 @@ namespace System public static partial class AdminHelpers { /// - /// Runs the given command as sudo (for Unix). + /// Runs the given command as sudo (for Unix). /// /// The command line to run as sudo /// Returns the process exit code (0 typically means it is successful) diff --git a/src/Common/tests/InternalUtilitiesForTests/src/AssertExtensions.cs b/src/Common/tests/InternalUtilitiesForTests/src/AssertExtensions.cs index 900e85bf842..dfc459a704b 100644 --- a/src/Common/tests/InternalUtilitiesForTests/src/AssertExtensions.cs +++ b/src/Common/tests/InternalUtilitiesForTests/src/AssertExtensions.cs @@ -215,15 +215,15 @@ private static string AddOptionalUserMessage(string message, string userMessage) } /// - /// Tests whether the specified string contains the specified substring - /// and throws an exception if the substring does not occur within the - /// test string or if either string or substring is null. + /// Tests whether the specified string contains the specified substring + /// and throws an exception if the substring does not occur within the + /// test string or if either string or substring is null. /// /// - /// The string that is expected to contain . + /// The string that is expected to contain . /// /// - /// The string expected to occur within . + /// The string expected to occur within . /// public static void Contains(string value, string substring) { @@ -233,7 +233,7 @@ public static void Contains(string value, string substring) } /// - /// Validate that a given value is greater than another value. + /// Validate that a given value is greater than another value. /// /// The value that should be greater than . /// The value that should be greater than. @@ -254,7 +254,7 @@ public static void GreaterThan(T actual, T greaterThan, string userMessage = } /// - /// Validate that a given value is less than another value. + /// Validate that a given value is less than another value. /// /// The value that should be less than . /// The value that should be less than. @@ -280,7 +280,7 @@ public static void LessThan(T actual, T lessThan, string userMessage = null) } /// - /// Validate that a given value is less than or equal to another value. + /// Validate that a given value is less than or equal to another value. /// /// The value that should be less than or equal to /// The value that should be less than or equal to. @@ -299,7 +299,7 @@ public static void LessThanOrEqualTo(T actual, T lessThanOrEqualTo, string us } /// - /// Validate that a given value is greater than or equal to another value. + /// Validate that a given value is greater than or equal to another value. /// /// The value that should be greater than or equal to /// The value that should be greater than or equal to. @@ -327,8 +327,8 @@ public static void GreaterThanOrEqualTo(T actual, T greaterThanOrEqualTo, str } /// - /// Validates that the actual byte array is equal to the expected byte array. XUnit only displays the first 5 values - /// of each collection if the test fails. This doesn't display at what point or how the equality assertion failed. + /// Validates that the actual byte array is equal to the expected byte array. XUnit only displays the first 5 values + /// of each collection if the test fails. This doesn't display at what point or how the equality assertion failed. /// /// The byte array that should be equal to. /// diff --git a/src/Common/tests/InternalUtilitiesForTests/src/TheoryExtensions.cs b/src/Common/tests/InternalUtilitiesForTests/src/TheoryExtensions.cs index 079ed7fca2a..aac94a8f03a 100644 --- a/src/Common/tests/InternalUtilitiesForTests/src/TheoryExtensions.cs +++ b/src/Common/tests/InternalUtilitiesForTests/src/TheoryExtensions.cs @@ -13,7 +13,7 @@ namespace System public static class TheoryExtensions { /// - /// Converts an IEnumerable into an Xunit theory compatible enumerable. + /// Converts an IEnumerable into an Xunit theory compatible enumerable. /// public static TheoryData ToTheoryData(this IEnumerable data) { diff --git a/src/System.Windows.Forms.Design.Editors/src/Misc/CommonUnsafeNativeMethods.cs b/src/System.Windows.Forms.Design.Editors/src/Misc/CommonUnsafeNativeMethods.cs index 5bed5704139..fb85889be8c 100644 --- a/src/System.Windows.Forms.Design.Editors/src/Misc/CommonUnsafeNativeMethods.cs +++ b/src/System.Windows.Forms.Design.Editors/src/Misc/CommonUnsafeNativeMethods.cs @@ -21,8 +21,8 @@ internal class CommonUnsafeNativeMethods internal static extern bool AreDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB); /// - /// Tries to compare two DPIawareness context values. Return true if they were equal. - /// Return false when they are not equal or underlying OS does not support this API. + /// Tries to compare two DPIawareness context values. Return true if they were equal. + /// Return false when they are not equal or underlying OS does not support this API. /// /// true/false public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB) @@ -36,7 +36,7 @@ public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiConte } /// - /// Tries to set thread dpi awareness context + /// Tries to set thread dpi awareness context /// /// returns old thread dpi awareness context if API is available in this version of OS. otherwise, return IntPtr.Zero. public static DpiAwarenessContext TrySetThreadDpiAwarenessContext(DpiAwarenessContext dpiCOntext) diff --git a/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationOptions.cs b/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationOptions.cs index 07c634875e1..4d7b651ae5a 100644 --- a/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationOptions.cs +++ b/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationOptions.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Winforms application configuration options + /// Winforms application configuration options /// internal static class ConfigurationOptions { @@ -43,7 +43,7 @@ private static void PopulateWinformsSection() } /// - /// Extract current targeted framework version + /// Extract current targeted framework version /// public static Version NetFrameworkVersion { @@ -77,7 +77,7 @@ public static Version NetFrameworkVersion } /// - /// Extract value of the key specified from collection read from app.config file's winforms section + /// Extract value of the key specified from collection read from app.config file's winforms section /// /// setting key name /// value of key diff --git a/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationStringConstants.cs b/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationStringConstants.cs index 9bd6429b391..826ec8bfebe 100644 --- a/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationStringConstants.cs +++ b/src/System.Windows.Forms.Design.Editors/src/Misc/ConfigurationStringConstants.cs @@ -5,8 +5,8 @@ namespace System.Configuration { /// - /// These configuration file values are added in .NET FX 4.7 and above frameworks only. - /// Sample usage: + /// These configuration file values are added in .NET FX 4.7 and above frameworks only. + /// Sample usage: /// /// /// diff --git a/src/System.Windows.Forms.Design.Editors/src/Misc/DpiHelper.cs b/src/System.Windows.Forms.Design.Editors/src/Misc/DpiHelper.cs index c223875ada8..79d4a524b56 100644 --- a/src/System.Windows.Forms.Design.Editors/src/Misc/DpiHelper.cs +++ b/src/System.Windows.Forms.Design.Editors/src/Misc/DpiHelper.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen. + /// Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen. /// internal static partial class DpiHelper { @@ -19,7 +19,7 @@ internal static partial class DpiHelper private static bool isInitialized = false; /// - /// The primary screen's (device) current DPI + /// The primary screen's (device) current DPI /// private static double deviceDpi = LogicalDpi; private static double logicalToDeviceUnitsScalingFactor = 0.0; @@ -113,8 +113,8 @@ private static Bitmap CreateScaledBitmap(Bitmap logicalImage, int deviceDpi = 0) } /// - /// Returns whether scaling is required when converting between logical-device units, - /// if the application opted in the automatic scaling in the .config file. + /// Returns whether scaling is required when converting between logical-device units, + /// if the application opted in the automatic scaling in the .config file. /// public static bool IsScalingRequired { @@ -126,8 +126,8 @@ public static bool IsScalingRequired } /// - /// Transforms a horizontal or vertical integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a horizontal or vertical integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// value in logical units /// value in device units @@ -142,8 +142,8 @@ public static int LogicalToDeviceUnits(int value, int devicePixels = 0) } /// - /// Transforms a horizontal integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a horizontal integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// The horizontal value in logical units /// The horizontal value in device units @@ -153,8 +153,8 @@ public static int LogicalToDeviceUnitsX(int value) } /// - /// Transforms a vertical integer coordinate from logical to device units - /// by scaling it up for current DPI and rounding to nearest integer value + /// Transforms a vertical integer coordinate from logical to device units + /// by scaling it up for current DPI and rounding to nearest integer value /// /// The vertical value in logical units /// The vertical value in device units @@ -164,8 +164,8 @@ public static int LogicalToDeviceUnitsY(int value) } /// - /// Returns a new Size with the input's - /// dimensions converted from logical units to device units. + /// Returns a new Size with the input's + /// dimensions converted from logical units to device units. /// /// Size in logical units /// Size in device units @@ -176,8 +176,8 @@ public static Size LogicalToDeviceUnits(Size logicalSize, int deviceDpi = 0) } /// - /// Create a new button bitmap scaled for the device units. - /// Note: original image might be disposed. + /// Create a new button bitmap scaled for the device units. + /// Note: original image might be disposed. /// /// button with an image, image size is defined in logical units public static void ScaleButtonImageLogicalToDevice(Button button) diff --git a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ArrayEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ArrayEditor.cs index 9b7f4e47919..fbf770b0311 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ArrayEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ArrayEditor.cs @@ -6,26 +6,26 @@ namespace System.ComponentModel.Design { /// - /// Edits an array of values. + /// Edits an array of values. /// public class ArrayEditor : CollectionEditor { /// - /// Initializes a new instance of - /// using the specified type for the array. + /// Initializes a new instance of + /// using the specified type for the array. /// public ArrayEditor(Type type) : base(type) { } /// - /// Gets or sets the data type this collection contains. + /// Gets or sets the data type this collection contains. /// protected override Type CreateCollectionItemType() => CollectionType?.GetElementType(); /// - /// Gets the items in the array. + /// Gets the items in the array. /// protected override object[] GetItems(object editValue) { @@ -40,7 +40,7 @@ protected override object[] GetItems(object editValue) } /// - /// Sets the items in the array. + /// Sets the items in the array. /// protected override object SetItems(object editValue, object[] value) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/CollectionEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/CollectionEditor.cs index 73c68213ce0..a1b933edfe5 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/CollectionEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/CollectionEditor.cs @@ -17,7 +17,7 @@ namespace System.ComponentModel.Design { /// - /// Provides a generic editor for most any collection. + /// Provides a generic editor for most any collection. /// public class CollectionEditor : UITypeEditor { @@ -29,7 +29,7 @@ public class CollectionEditor : UITypeEditor private bool _ignoreChangingEvents; /// - /// Initializes a new instance of the class using the specified collection type. + /// Initializes a new instance of the class using the specified collection type. /// public CollectionEditor(Type type) { @@ -37,7 +37,7 @@ public CollectionEditor(Type type) } /// - /// Gets or sets the data type of each item in the collection. + /// Gets or sets the data type of each item in the collection. /// protected Type CollectionItemType { @@ -45,27 +45,27 @@ protected Type CollectionItemType } /// - /// Gets or sets the type of the collection. + /// Gets or sets the type of the collection. /// protected Type CollectionType { get; } /// - /// Gets or sets a type descriptor that indicates the current context. + /// Gets or sets a type descriptor that indicates the current context. /// protected ITypeDescriptorContext Context => _currentContext; /// - /// Gets or sets the available item types that can be created for this collection. + /// Gets or sets the available item types that can be created for this collection. /// protected Type[] NewItemTypes => _newItemTypes ?? (_newItemTypes = CreateNewItemTypes()); /// - /// Gets the help topic to display for the dialog help button or pressing F1. Override to display a different help topic. + /// Gets the help topic to display for the dialog help button or pressing F1. Override to display a different help topic. /// protected virtual string HelpTopic => "net.ComponentModel.CollectionEditor"; /// - /// Gets or sets a value indicating whether original members of the collection can be removed. + /// Gets or sets a value indicating whether original members of the collection can be removed. /// protected virtual bool CanRemoveInstance(object value) { @@ -83,24 +83,24 @@ protected virtual bool CanRemoveInstance(object value) } /// - /// Useful for derived classes to do processing when cancelling changes + /// Useful for derived classes to do processing when cancelling changes /// protected virtual void CancelChanges() { } /// - /// Gets or sets a value indicating whether multiple collection members can be selected. + /// Gets or sets a value indicating whether multiple collection members can be selected. /// protected virtual bool CanSelectMultipleInstances() => true; /// - /// Creates a new form to show the current collection. + /// Creates a new form to show the current collection. /// protected virtual CollectionForm CreateCollectionForm() => new CollectionEditorCollectionForm(this); /// - /// Creates a new instance of the specified collection item type. + /// Creates a new instance of the specified collection item type. /// protected virtual object CreateInstance(Type itemType) { @@ -125,13 +125,13 @@ protected virtual object CreateInstance(Type itemType) } /// - /// This Function gets the object from the givem object. The input is an arrayList returned as an Object. - /// The output is a arraylist which contains the individual objects that need to be created. + /// This Function gets the object from the givem object. The input is an arrayList returned as an Object. + /// The output is a arraylist which contains the individual objects that need to be created. /// protected virtual IList GetObjectsFromInstance(object instance) => new ArrayList { instance }; /// - /// Retrieves the display text for the given list item. + /// Retrieves the display text for the given list item. /// protected virtual string GetDisplayText(object value) { @@ -172,7 +172,7 @@ protected virtual string GetDisplayText(object value) } /// - /// Gets an instance of the data type this collection contains. + /// Gets an instance of the data type this collection contains. /// protected virtual Type CreateCollectionItemType() { @@ -190,12 +190,12 @@ protected virtual Type CreateCollectionItemType() } /// - /// Gets the data types this collection editor can create. + /// Gets the data types this collection editor can create. /// protected virtual Type[] CreateNewItemTypes() => new Type[] { CollectionItemType }; /// - /// Destroys the specified instance of the object. + /// Destroys the specified instance of the object. /// protected virtual void DestroyInstance(object instance) { @@ -217,7 +217,7 @@ protected virtual void DestroyInstance(object instance) } /// - /// Edits the specified object value using the editor style provided by . + /// Edits the specified object value using the editor style provided by . /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -294,7 +294,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. + /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -334,7 +334,7 @@ private bool IsAnyObjectInheritedReadOnly(object[] items) } /// - /// Converts the specified collection into an array of objects. + /// Converts the specified collection into an array of objects. /// protected virtual object[] GetItems(object editValue) { @@ -356,12 +356,12 @@ protected virtual object[] GetItems(object editValue) } /// - /// Gets the requested service, if it is available. + /// Gets the requested service, if it is available. /// protected object GetService(Type serviceType) => Context?.GetService(serviceType); /// - /// Reflect any change events to the instance object + /// Reflect any change events to the instance object /// private void OnComponentChanged(object sender, ComponentChangedEventArgs e) { @@ -373,7 +373,7 @@ private void OnComponentChanged(object sender, ComponentChangedEventArgs e) } /// - /// Reflect any changed events to the instance object + /// Reflect any changed events to the instance object /// private void OnComponentChanging(object sender, ComponentChangingEventArgs e) { @@ -385,14 +385,14 @@ private void OnComponentChanging(object sender, ComponentChangingEventArgs e) } /// - /// Removes the item from the column header from the listview column header collection + /// Removes the item from the column header from the listview column header collection /// internal virtual void OnItemRemoving(object item) { } /// - /// Sets the specified collection to have the specified array of items. + /// Sets the specified collection to have the specified array of items. /// protected virtual object SetItems(object editValue, object[] value) { @@ -413,7 +413,7 @@ protected virtual object SetItems(object editValue, object[] value) } /// - /// Called when the help button is clicked. + /// Called when the help button is clicked. /// protected virtual void ShowHelp() { @@ -717,7 +717,7 @@ private void SetButtonDrawState() } /// - /// This is the collection editor's default implementation of a collection form. + /// This is the collection editor's default implementation of a collection form. /// private class CollectionEditorCollectionForm : CollectionForm { @@ -805,7 +805,7 @@ private bool IsImmutable } /// - /// Adds a new element to the collection. + /// Adds a new element to the collection. /// private void AddButton_click(object sender, EventArgs e) { @@ -813,7 +813,7 @@ private void AddButton_click(object sender, EventArgs e) } /// - /// Processes a click of the drop down type menu. This creates a new instance. + /// Processes a click of the drop down type menu. This creates a new instance. /// private void AddDownMenu_click(object sender, EventArgs e) { @@ -824,7 +824,7 @@ private void AddDownMenu_click(object sender, EventArgs e) } /// - /// This Function adds the individual objects to the ListBox. + /// This Function adds the individual objects to the ListBox. /// private void AddItems(IList instances) { @@ -895,10 +895,10 @@ private void AdjustListBoxItemHeight() } /// - /// Determines whether removal of a specific list item should be permitted. - /// Used to determine enabled/disabled state of the Remove (X) button. - /// Items added after editor was opened may always be removed. - /// Items that existed before editor was opened require a call to CanRemoveInstance. + /// Determines whether removal of a specific list item should be permitted. + /// Used to determine enabled/disabled state of the Remove (X) button. + /// Items added after editor was opened may always be removed. + /// Items that existed before editor was opened require a call to CanRemoveInstance. /// private bool AllowRemoveInstance(object value) { @@ -931,7 +931,7 @@ private int CalcItemWidth(Graphics g, ListItem item) } /// - /// Aborts changes made in the editor. + /// Aborts changes made in the editor. /// private void CancelButton_click(object sender, EventArgs e) { @@ -997,7 +997,7 @@ private void CancelButton_click(object sender, EventArgs e) } /// - /// Performs a create instance and then adds the instance to the list box. + /// Performs a create instance and then adds the instance to the list box. /// private void CreateAndAddInstance(Type type) { @@ -1018,7 +1018,7 @@ private void CreateAndAddInstance(Type type) } /// - /// Moves the selected item down one. + /// Moves the selected item down one. /// private void DownButton_click(object sender, EventArgs e) { @@ -1071,10 +1071,10 @@ private void Form_HelpRequested(object sender, HelpEventArgs e) } /// - /// Retrieves the display text for the given list item (if any). The item determines its own display text - /// through its ToString() method, which delegates to the GetDisplayText() override on the parent CollectionEditor. - /// This means in theory that the text can change at any time (ie. its not fixed when the item is added to the list). - /// The item returns its display text through ToString() so that the same text will be reported to Accessibility clients. + /// Retrieves the display text for the given list item (if any). The item determines its own display text + /// through its ToString() method, which delegates to the GetDisplayText() override on the parent CollectionEditor. + /// This means in theory that the text can change at any time (ie. its not fixed when the item is added to the list). + /// The item returns its display text through ToString() so that the same text will be reported to Accessibility clients. /// private string GetDisplayText(ListItem item) { @@ -1247,7 +1247,7 @@ private void UpdateItemWidths(ListItem item) } /// - /// This draws a row of the listbox. + /// This draws a row of the listbox. /// private void Listbox_drawItem(object sender, DrawItemEventArgs e) { @@ -1338,7 +1338,7 @@ private void Listbox_drawItem(object sender, DrawItemEventArgs e) } /// - /// Handles keypress events for the list box. + /// Handles keypress events for the list box. /// private void Listbox_keyDown(object sender, KeyEventArgs kevent) { @@ -1354,7 +1354,7 @@ private void Listbox_keyDown(object sender, KeyEventArgs kevent) } /// - /// Event that fires when the selected list box index changes. + /// Event that fires when the selected list box index changes. /// private void Listbox_SelectedIndexChanged(object sender, EventArgs e) { @@ -1362,7 +1362,7 @@ private void Listbox_SelectedIndexChanged(object sender, EventArgs e) } /// - /// Event that fires when the list box's window handle is created. + /// Event that fires when the list box's window handle is created. /// private void Listbox_HandleCreated(object sender, EventArgs e) { @@ -1370,7 +1370,7 @@ private void Listbox_HandleCreated(object sender, EventArgs e) } /// - /// Commits the changes to the editor. + /// Commits the changes to the editor. /// private void OKButton_Click(object sender, EventArgs e) { @@ -1419,7 +1419,7 @@ private void OKButton_Click(object sender, EventArgs e) } /// - /// Reflect any change events to the instance object + /// Reflect any change events to the instance object /// private void OnComponentChanged(object sender, ComponentChangedEventArgs e) { @@ -1438,8 +1438,8 @@ private void OnComponentChanged(object sender, ComponentChangedEventArgs e) } /// - /// This is called when the value property in the CollectionForm has changed. - /// In it you should update your user interface to reflect the current value. + /// This is called when the value property in the CollectionForm has changed. + /// In it you should update your user interface to reflect the current value. /// protected override void OnEditValueChanged() { @@ -1496,8 +1496,8 @@ protected override void OnFontChanged(EventArgs e) } /// - /// Performs the actual add of new items. This is invoked by the add button - /// as well as the insert key on the list box. + /// Performs the actual add of new items. This is invoked by the add button + /// as well as the insert key on the list box. /// private void PerformAdd() { @@ -1505,8 +1505,8 @@ private void PerformAdd() } /// - /// Performs a remove by deleting all items currently selected in the list box. - /// This is called by the delete button as well as the delete key on the list box. + /// Performs a remove by deleting all items currently selected in the list box. + /// This is called by the delete button as well as the delete key on the list box. /// private void PerformRemove() { @@ -1546,7 +1546,7 @@ private void PerformRemove() } /// - /// When something in the properties window changes, we update pertinent text here. + /// When something in the properties window changes, we update pertinent text here. /// private void PropertyGrid_propertyValueChanged(object sender, PropertyValueChangedEventArgs e) { @@ -1577,7 +1577,7 @@ private void PropertyGrid_propertyValueChanged(object sender, PropertyValueChang } /// - /// Used to actually remove the items, one by one. + /// Used to actually remove the items, one by one. /// private void RemoveInternal(ListItem item) { @@ -1623,7 +1623,7 @@ private void RemoveInternal(ListItem item) } /// - /// Removes the selected item. + /// Removes the selected item. /// private void RemoveButton_Click(object sender, EventArgs e) { @@ -1638,8 +1638,8 @@ private void RemoveButton_Click(object sender, EventArgs e) } /// - /// used to prevent flicker when playing with the list box selection call resume when done. - /// Calls to UpdateEnabled will return silently until Resume is called + /// used to prevent flicker when playing with the list box selection call resume when done. + /// Calls to UpdateEnabled will return silently until Resume is called /// private void ResumeEnabledUpdates(bool updateNow) { @@ -1657,13 +1657,13 @@ private void ResumeEnabledUpdates(bool updateNow) } } /// - /// Used to prevent flicker when playing with the list box selection call resume when done. - /// Calls to UpdateEnabled will return silently until Resume is called + /// Used to prevent flicker when playing with the list box selection call resume when done. + /// Calls to UpdateEnabled will return silently until Resume is called /// private void SuspendEnabledUpdates() => _suspendEnabledCount++; /// - /// Called to show the dialog via the IWindowsFormsEditorService + /// Called to show the dialog via the IWindowsFormsEditorService /// protected internal override DialogResult ShowEditorDialog(IWindowsFormsEditorService edSvc) { @@ -1692,7 +1692,7 @@ protected internal override DialogResult ShowEditorDialog(IWindowsFormsEditorSer } /// - /// Moves an item up one in the list box. + /// Moves an item up one in the list box. /// private void UpButton_Click(object sender, EventArgs e) { @@ -1735,7 +1735,7 @@ private void UpButton_Click(object sender, EventArgs e) } /// - /// Updates the set of enabled buttons. + /// Updates the set of enabled buttons. /// private void UpdateEnabled() { @@ -1805,7 +1805,7 @@ private void UpdateEnabled() } /// - /// When the form is first shown, update controls due to the edit value changes which happened when the form is invisible. + /// When the form is first shown, update controls due to the edit value changes which happened when the form is invisible. /// private void Form_Shown(object sender, EventArgs e) { @@ -1813,9 +1813,9 @@ private void Form_Shown(object sender, EventArgs e) } /// - /// This class implements a custom type descriptor that is used to provide - /// properties for the set of selected items in the collection editor. - /// It provides a single property that is equivalent to the editor's collection item type. + /// This class implements a custom type descriptor that is used to provide + /// properties for the set of selected items in the collection editor. + /// It provides a single property that is equivalent to the editor's collection item type. /// private class SelectionWrapper : PropertyDescriptor, ICustomTypeDescriptor { @@ -1875,39 +1875,39 @@ public SelectionWrapper(Type collectionType, Type collectionItemType, Control co } /// - /// When overridden in a derived class, gets the type of the component this property is bound to. + /// When overridden in a derived class, gets the type of the component this property is bound to. /// public override Type ComponentType { get; } /// - /// When overridden in a derived class, gets a value indicating whether this property is read-only. + /// When overridden in a derived class, gets a value indicating whether this property is read-only. /// public override bool IsReadOnly => false; /// - /// When overridden in a derived class, gets the type of the property. + /// When overridden in a derived class, gets the type of the property. /// public override Type PropertyType { get; } /// - /// When overridden in a derived class, indicates whether resetting the will change the value of the . + /// When overridden in a derived class, indicates whether resetting the will change the value of the . /// public override bool CanResetValue(object component) => false; /// - /// When overridden in a derived class, gets the current value of the property on a component. + /// When overridden in a derived class, gets the current value of the property on a component. /// public override object GetValue(object component) => _value; /// - /// When overridden in a derived class, resets the value for this property of the component. + /// When overridden in a derived class, resets the value for this property of the component. /// public override void ResetValue(object component) { } /// - /// When overridden in a derived class, sets the value of the component to a different value. + /// When overridden in a derived class, sets the value of the component to a different value. /// public override void SetValue(object component, object value) { @@ -1922,12 +1922,12 @@ public override void SetValue(object component, object value) } /// - /// When overridden in a derived class, indicates whether the value of this property needs to be persisted. + /// When overridden in a derived class, indicates whether the value of this property needs to be persisted. /// public override bool ShouldSerializeValue(object component) => false; /// - /// Retrieves an array of member attributes for the given object. + /// Retrieves an array of member attributes for the given object. /// AttributeCollection ICustomTypeDescriptor.GetAttributes() { @@ -1935,39 +1935,39 @@ AttributeCollection ICustomTypeDescriptor.GetAttributes() } /// - /// Retrieves the class name for this object. If null is returned, the type name is used. + /// Retrieves the class name for this object. If null is returned, the type name is used. /// string ICustomTypeDescriptor.GetClassName() => PropertyType.Name; /// - /// Retrieves the name for this object. If null is returned, the default is used. + /// Retrieves the name for this object. If null is returned, the default is used. /// string ICustomTypeDescriptor.GetComponentName() => null; /// - /// Retrieves the type converter for this object. + /// Retrieves the type converter for this object. /// TypeConverter ICustomTypeDescriptor.GetConverter() => null; /// - /// Retrieves the default event. + /// Retrieves the default event. /// EventDescriptor ICustomTypeDescriptor.GetDefaultEvent() => null; /// - /// Retrieves the default property. + /// Retrieves the default property. /// PropertyDescriptor ICustomTypeDescriptor.GetDefaultProperty() => this; /// - /// Retrieves the an editor for this object. + /// Retrieves the an editor for this object. /// object ICustomTypeDescriptor.GetEditor(Type editorBaseType) => null; /// - /// Retrieves an array of events that the given component instance provides. - /// This may differ from the set of events the class provides. - /// If the component is sited, the site may add or remove additional events. + /// Retrieves an array of events that the given component instance provides. + /// This may differ from the set of events the class provides. + /// If the component is sited, the site may add or remove additional events. /// EventDescriptorCollection ICustomTypeDescriptor.GetEvents() { @@ -1975,10 +1975,10 @@ EventDescriptorCollection ICustomTypeDescriptor.GetEvents() } /// - /// Retrieves an array of events that the given component instance provides. - /// This may differ from the set of events the class provides. - /// If the component is sited, the site may add or remove additional events. - /// The returned array of events will be filtered by the given set of attributes. + /// Retrieves an array of events that the given component instance provides. + /// This may differ from the set of events the class provides. + /// If the component is sited, the site may add or remove additional events. + /// The returned array of events will be filtered by the given set of attributes. /// EventDescriptorCollection ICustomTypeDescriptor.GetEvents(Attribute[] attributes) { @@ -1986,9 +1986,9 @@ EventDescriptorCollection ICustomTypeDescriptor.GetEvents(Attribute[] attributes } /// - /// Retrieves an array of properties that the given component instance provides. - /// This may differ from the set of properties the class provides. - /// If the component is sited, the site may add or remove additional properties. + /// Retrieves an array of properties that the given component instance provides. + /// This may differ from the set of properties the class provides. + /// If the component is sited, the site may add or remove additional properties. /// PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties() { @@ -1996,10 +1996,10 @@ PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties() } /// - /// Retrieves an array of properties that the given component instance provides. - /// This may differ from the set of properties the class provides. - /// If the component is sited, the site may add or remove additional properties. - /// The returned array of properties will be filtered by the given set of attributes. + /// Retrieves an array of properties that the given component instance provides. + /// This may differ from the set of properties the class provides. + /// If the component is sited, the site may add or remove additional properties. + /// The returned array of properties will be filtered by the given set of attributes. /// PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties(Attribute[] attributes) { @@ -2007,10 +2007,10 @@ PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties(Attribute[] att } /// - /// Retrieves the object that directly depends on this value being edited. - /// This is generally the object that is required for the PropertyDescriptor's GetValue and SetValue methods. - /// If 'null' is passed for the PropertyDescriptor, the ICustomComponent descripotor implemementation should return the default object, - /// that is the main object that exposes the properties and attributes + /// Retrieves the object that directly depends on this value being edited. + /// This is generally the object that is required for the PropertyDescriptor's GetValue and SetValue methods. + /// If 'null' is passed for the PropertyDescriptor, the ICustomComponent descripotor implemementation should return the default object, + /// that is the main object that exposes the properties and attributes /// object ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor pd) { @@ -2019,8 +2019,8 @@ object ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor pd) } /// - /// ListItem class. This is a single entry in our list box. - /// It contains the value we're editing as well as accessors for the type + /// ListItem class. This is a single entry in our list box. + /// It contains the value we're editing as well as accessors for the type // converter and UI editor. /// private class ListItem @@ -2074,7 +2074,7 @@ public object Value } /// - /// Menu items we attach to the drop down menu if there are multiple types the collection editor can create. + /// Menu items we attach to the drop down menu if there are multiple types the collection editor can create. /// private class TypeMenuItem : ToolStripMenuItem { @@ -2088,7 +2088,7 @@ public TypeMenuItem(Type itemType, EventHandler handler) : base(itemType.Name, n } /// - /// List box filled with ListItem objects representing the collection. + /// List box filled with ListItem objects representing the collection. /// internal class FilterListBox : ListBox { @@ -2117,7 +2117,7 @@ private PropertyGrid PropertyGrid } /// - /// Expose the protected RefreshItem() method so that CollectionEditor can use it + /// Expose the protected RefreshItem() method so that CollectionEditor can use it /// public new void RefreshItem(int index) => base.RefreshItem(index); @@ -2185,7 +2185,7 @@ protected override void WndProc(ref Message m) } /// - /// The provides a modal dialog for editing the contents of a collection. + /// The provides a modal dialog for editing the contents of a collection. /// protected abstract class CollectionForm : Form { @@ -2198,7 +2198,7 @@ protected abstract class CollectionForm : Form private const short EditableNo = 2; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public CollectionForm(CollectionEditor editor) { @@ -2206,12 +2206,12 @@ public CollectionForm(CollectionEditor editor) } /// - /// Gets or sets the data type of each item in the collection. + /// Gets or sets the data type of each item in the collection. /// protected Type CollectionItemType => _editor.CollectionItemType; /// - /// Gets or sets the type of the collection. + /// Gets or sets the type of the collection. /// protected Type CollectionType => _editor.CollectionType; @@ -2240,12 +2240,12 @@ internal virtual bool CollectionEditable } /// - /// Gets or sets a type descriptor that indicates the current context. + /// Gets or sets a type descriptor that indicates the current context. /// protected ITypeDescriptorContext Context => _editor.Context; /// - /// Gets or sets the value of the item being edited. + /// Gets or sets the value of the item being edited. /// public object EditValue { @@ -2258,7 +2258,7 @@ public object EditValue } /// - /// Gets or sets the array of items this form is to display. + /// Gets or sets the array of items this form is to display. /// protected object[] Items { @@ -2293,32 +2293,32 @@ protected object[] Items } /// - /// Gets or sets the available item types that can be created for this collection. + /// Gets or sets the available item types that can be created for this collection. /// protected Type[] NewItemTypes => _editor.NewItemTypes; /// - /// Gets or sets a value indicating whether original members of the collection can be removed. + /// Gets or sets a value indicating whether original members of the collection can be removed. /// protected bool CanRemoveInstance(object value) => _editor.CanRemoveInstance(value); /// - /// Gets or sets a value indicating whether multiple collection members can be selected. + /// Gets or sets a value indicating whether multiple collection members can be selected. /// protected virtual bool CanSelectMultipleInstances() => _editor.CanSelectMultipleInstances(); /// - /// Creates a new instance of the specified collection item type. + /// Creates a new instance of the specified collection item type. /// protected object CreateInstance(Type itemType) => _editor.CreateInstance(itemType); /// - /// Destroys the specified instance of the object. + /// Destroys the specified instance of the object. /// protected void DestroyInstance(object instance) => _editor.DestroyInstance(instance); /// - /// Displays the given exception to the user. + /// Displays the given exception to the user. /// protected virtual void DisplayError(Exception e) { @@ -2339,12 +2339,12 @@ protected virtual void DisplayError(Exception e) } /// - /// Gets the requested service, if it is available. + /// Gets the requested service, if it is available. /// protected override object GetService(Type serviceType) => _editor.GetService(serviceType); /// - /// Called to show the dialog via the IWindowsFormsEditorService + /// Called to show the dialog via the IWindowsFormsEditorService /// protected internal virtual DialogResult ShowEditorDialog(IWindowsFormsEditorService edSvc) { @@ -2357,7 +2357,7 @@ protected internal virtual DialogResult ShowEditorDialog(IWindowsFormsEditorServ } /// - /// This is called when the value property in the has changed. + /// This is called when the value property in the has changed. /// protected abstract void OnEditValueChanged(); } diff --git a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/MultilineStringEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/MultilineStringEditor.cs index cd76af60492..1dfefd419eb 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/MultilineStringEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/MultilineStringEditor.cs @@ -19,14 +19,14 @@ namespace System.ComponentModel.Design { /// - /// An editor for editing strings that supports multiple lines of text and is resizable. + /// An editor for editing strings that supports multiple lines of text and is resizable. /// public sealed class MultilineStringEditor : UITypeEditor { private MultilineStringEditorUI _editorUI; /// - /// Edits the given value, returning the editing results. + /// Edits the given value, returning the editing results. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -53,7 +53,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// The MultilineStringEditor is a drop down editor, so this returns UITypeEditorEditStyle.DropDown. + /// The MultilineStringEditor is a drop down editor, so this returns UITypeEditorEditStyle.DropDown. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -61,7 +61,7 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Returns false; no extra painting is performed. + /// Returns false; no extra painting is performed. /// public override bool GetPaintValueSupported(ITypeDescriptorContext context) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ObjectSelectorEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ObjectSelectorEditor.cs index 6d33ad38db0..567c0ff91c1 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ObjectSelectorEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/ComponentModel/Design/ObjectSelectorEditor.cs @@ -20,14 +20,14 @@ public abstract class ObjectSelectorEditor : UITypeEditor private Selector _selector = null; /// - /// Default constructor for ObjectSelectorEditor + /// Default constructor for ObjectSelectorEditor /// public ObjectSelectorEditor() { } /// - /// Constructor for ObjectSelectorEditor which sets SubObjectSelector equal to parameter subObjectSelector + /// Constructor for ObjectSelectorEditor which sets SubObjectSelector equal to parameter subObjectSelector /// public ObjectSelectorEditor(bool subObjectSelector) { @@ -35,7 +35,7 @@ public ObjectSelectorEditor(bool subObjectSelector) } /// - /// Edits the given object value using the editor style provided by ObjectSelectorEditor.GetEditStyle. + /// Edits the given object value using the editor style provided by ObjectSelectorEditor.GetEditStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -71,7 +71,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Modify a WinForms TreeView control to use the new Explorer style theme + /// Modify a WinForms TreeView control to use the new Explorer style theme /// /// The tree view control to modify public static void ApplyTreeViewThemeStyles(TreeView treeView) @@ -113,7 +113,7 @@ protected virtual void FillTreeWithData(Selector selector, ITypeDescriptorContex } /// - /// Override this method to add validation code for new value + /// Override this method to add validation code for new value /// public virtual void SetValue(object value) { @@ -127,7 +127,7 @@ public class Selector : TreeView public bool clickSeen = false; /// - /// Constructor for Selector, takes ObjectSelectorEditor + /// Constructor for Selector, takes ObjectSelectorEditor /// public Selector(ObjectSelectorEditor editor) { @@ -146,8 +146,8 @@ public Selector(ObjectSelectorEditor editor) } /// - /// Adds a Node with given label and value to the parent, provided the parent is not null; - /// Otherwise, adds that node to the Nodes TreeNodeCollection. Returns the new node. + /// Adds a Node with given label and value to the parent, provided the parent is not null; + /// Otherwise, adds that node to the Nodes TreeNodeCollection. Returns the new node. /// public SelectorNode AddNode(string label, object value, SelectorNode parent) { @@ -165,7 +165,7 @@ public SelectorNode AddNode(string label, object value, SelectorNode parent) } /// - /// Returns true if the given node was selected; false otherwise. + /// Returns true if the given node was selected; false otherwise. /// private bool ChooseSelectedNodeIfEqual() { @@ -182,7 +182,7 @@ private bool ChooseSelectedNodeIfEqual() } /// - /// Clears the TreeNodeCollection and sets clickSeen to false + /// Clears the TreeNodeCollection and sets clickSeen to false /// public void Clear() { @@ -242,7 +242,7 @@ protected override void OnNodeMouseClick(TreeNodeMouseClickEventArgs e) } /// - /// Sets the selection + /// Sets the selection /// public bool SetSelection(object value, TreeNodeCollection nodes) { @@ -286,7 +286,7 @@ public bool SetSelection(object value, TreeNodeCollection nodes) } /// - /// Sets the internal IWindowsFormsEditorService to the given edSvc, and calls SetSelection on the given value + /// Sets the internal IWindowsFormsEditorService to the given edSvc, and calls SetSelection on the given value /// public void Start(IWindowsFormsEditorService edSvc, object value) { @@ -296,7 +296,7 @@ public void Start(IWindowsFormsEditorService edSvc, object value) } /// - /// Sets the internal IWindowsFormsEditorService to null + /// Sets the internal IWindowsFormsEditorService to null /// public void Stop() { @@ -328,15 +328,15 @@ protected override void WndProc(ref Message m) } } - /// Suppressed because although the type implements ISerializable --its on the base class and this class - /// is not modifying the stream to include its local information. Therefore, we should not publicly advertise this as - /// Serializable unless explicitly required. + /// Suppressed because although the type implements ISerializable --its on the base class and this class + /// is not modifying the stream to include its local information. Therefore, we should not publicly advertise this as + /// Serializable unless explicitly required. public class SelectorNode : TreeNode { public object value = null; /// - /// Sets label and value to given. + /// Sets label and value to given. /// public SelectorNode(string label, object value) : base(label) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/BitmapEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/BitmapEditor.cs index 23663655f37..297ad48721f 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/BitmapEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/BitmapEditor.cs @@ -8,8 +8,8 @@ namespace System.Drawing.Design { /// - /// Provides an editor that can perform default file searching for bitmap (.bmp) - /// files. + /// Provides an editor that can perform default file searching for bitmap (.bmp) + /// files. /// [CLSCompliant(false)] public class BitmapEditor : ImageEditor diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ColorEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ColorEditor.cs index 258e2f52ee6..7b4f7513c7e 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ColorEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ColorEditor.cs @@ -17,7 +17,7 @@ namespace System.Drawing.Design { /// - /// Provides an editor for visually picking a color. + /// Provides an editor for visually picking a color. /// [CLSCompliant(false)] public class ColorEditor : UITypeEditor @@ -25,7 +25,7 @@ public class ColorEditor : UITypeEditor private ColorUI _colorUI; /// - /// Edits the given object value using the editor style provided by ColorEditor.GetEditStyle. + /// Edits the given object value using the editor style provided by ColorEditor.GetEditStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -56,8 +56,8 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. - /// If the method is not supported, this will return UITypeEditorEditStyle.None. + /// Gets the editing style of the Edit method. + /// If the method is not supported, this will return UITypeEditorEditStyle.None. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -65,8 +65,8 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Gets a value indicating if this editor supports the painting of a representation - /// of an object's value. + /// Gets a value indicating if this editor supports the painting of a representation + /// of an object's value. /// public override bool GetPaintValueSupported(ITypeDescriptorContext context) { @@ -74,8 +74,8 @@ public override bool GetPaintValueSupported(ITypeDescriptorContext context) } /// - /// Paints a representative value of the given object to the provided canvas. - /// Painting should be done within the boundaries of the provided rectangle. + /// Paints a representative value of the given object to the provided canvas. + /// Painting should be done within the boundaries of the provided rectangle. /// public override void PaintValue(PaintValueEventArgs e) { @@ -88,7 +88,7 @@ public override void PaintValue(PaintValueEventArgs e) } /// - /// A control to display the color palette. + /// A control to display the color palette. /// private class ColorPalette : Control { @@ -682,12 +682,12 @@ public ColorUI(ColorEditor editor) } /// - /// Array of standard colors. + /// Array of standard colors. /// private object[] ColorValues => colorConstants ?? (colorConstants = GetConstants(typeof(Color))); /// - /// Retrieves the array of custom colors for our use. + /// Retrieves the array of custom colors for our use. /// private Color[] CustomColors { @@ -712,12 +712,12 @@ private Color[] CustomColors } /// - /// Allows someone else to close our dropdown. + /// Allows someone else to close our dropdown. /// public IWindowsFormsEditorService EditorService => edSvc; /// - /// Array of system colors. + /// Array of system colors. /// private object[] SystemColorValues => systemColorConstants ?? (systemColorConstants = GetConstants(typeof(SystemColors))); @@ -747,7 +747,7 @@ private void AdjustListBoxItemHeight() } /// - /// Takes the given color and looks for an instance in the ColorValues table. + /// Takes the given color and looks for an instance in the ColorValues table. /// private Color GetBestColor(Color color) { @@ -764,7 +764,7 @@ private Color GetBestColor(Color color) } /// - /// Retrieves an array of color constants for the given object. + /// Retrieves an array of color constants for the given object. /// private static object[] GetConstants(Type enumType) { @@ -1150,7 +1150,7 @@ protected override IntPtr HookProc(IntPtr hwnd, int msg, IntPtr wParam, IntPtr l } /// - /// Comparer for system colors. + /// Comparer for system colors. /// private class SystemColorComparer : IComparer { @@ -1161,7 +1161,7 @@ public int Compare(object x, object y) } /// - /// Comparer for standard colors + /// Comparer for standard colors /// private class StandardColorComparer : IComparer { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/CursorEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/CursorEditor.cs index d287ff93a95..cef98dcde3d 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/CursorEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/CursorEditor.cs @@ -10,7 +10,7 @@ namespace System.Drawing.Design { /// - /// Provides an editor that can perform default file searching for cursor (.cur) files. + /// Provides an editor that can perform default file searching for cursor (.cur) files. /// [CLSCompliant(false)] public class CursorEditor : UITypeEditor @@ -18,13 +18,13 @@ public class CursorEditor : UITypeEditor private CursorUI _cursorUI; /// - /// Returns true, indicating that this drop-down control can be resized. + /// Returns true, indicating that this drop-down control can be resized. /// public override bool IsDropDownResizable => true; /// - /// Edits the given object value using the editor style provided by GetEditorStyle. A service - /// provider is provided so that any required editing services can be obtained. + /// Edits the given object value using the editor style provided by GetEditorStyle. A service + /// provider is provided so that any required editing services can be obtained. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -51,7 +51,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Retrieves the editing style of the Edit method. + /// Retrieves the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -59,7 +59,7 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// The user interface for the cursor drop-down. This is just an owner-drawn list box. + /// The user interface for the cursor drop-down. This is just an owner-drawn list box. /// private class CursorUI : ListBox { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontEditor.cs index 323cfec9109..2be45c66507 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontEditor.cs @@ -11,7 +11,7 @@ namespace System.Drawing.Design { /// - /// Provides a font editor that is used to visually select and configure a Font object. + /// Provides a font editor that is used to visually select and configure a Font object. /// [CLSCompliant(false)] public class FontEditor : UITypeEditor @@ -19,8 +19,8 @@ public class FontEditor : UITypeEditor private FontDialog _fontDialog; /// - /// Edits the given object value using the editor style provided by GetEditorStyle. - /// A service provider is provided so that any required editing services can be obtained. + /// Edits the given object value using the editor style provided by GetEditorStyle. + /// A service provider is provided so that any required editing services can be obtained. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -65,7 +65,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Retrieves the editing style of the Edit method.false + /// Retrieves the editing style of the Edit method.false /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontNameEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontNameEditor.cs index 4fe1b418829..6e9821d2eb5 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontNameEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/FontNameEditor.cs @@ -77,8 +77,8 @@ public override void PaintValue(PaintValueEventArgs e) } /// - /// Tries to render sample of text in specified font and style, - /// throwing exception if specified font does not support that style... + /// Tries to render sample of text in specified font and style, + /// throwing exception if specified font does not support that style... /// private static void DrawFontSample(PaintValueEventArgs e, FontFamily fontFamily, FontStyle fontStyle) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ImageEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ImageEditor.cs index b099fd204ad..8bcab6d6158 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ImageEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/ImageEditor.cs @@ -14,7 +14,7 @@ namespace System.Drawing.Design { /// - /// Provides an editor for visually picking an image. + /// Provides an editor for visually picking an image. /// [CLSCompliant(false)] public class ImageEditor : UITypeEditor @@ -68,9 +68,9 @@ protected static string CreateFilterEntry(ImageEditor e) } /// - /// Edits the given object value using the editor style provided by - /// GetEditorStyle. A service provider is provided so that any - /// required editing services can be obtained. + /// Edits the given object value using the editor style provided by + /// GetEditorStyle. A service provider is provided so that any + /// required editing services can be obtained. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -126,8 +126,8 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Retrieves the editing style of the Edit method. If the method is not supported, - /// this will return None. + /// Retrieves the editing style of the Edit method. If the method is not supported, + /// this will return None. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -162,8 +162,8 @@ protected virtual string[] GetExtensions() } /// - /// Determines if this editor supports the painting of a representation - /// of an object's value. + /// Determines if this editor supports the painting of a representation + /// of an object's value. /// public override bool GetPaintValueSupported(ITypeDescriptorContext context) => true; @@ -183,9 +183,9 @@ protected virtual Image LoadFromStream(Stream stream) } /// - /// Paints a representative value of the given object to the provided - /// canvas. Painting should be done within the boundaries of the - /// provided rectangle. + /// Paints a representative value of the given object to the provided + /// canvas. Painting should be done within the boundaries of the + /// provided rectangle. /// public override void PaintValue(PaintValueEventArgs e) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/MetafileEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/MetafileEditor.cs index 14f804eb974..ec9df27d2b8 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/MetafileEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Drawing/Design/MetafileEditor.cs @@ -8,8 +8,8 @@ namespace System.Drawing.Design { /// - /// Extends Image's editor class to provide default file searching for metafile (.emf) - /// files. + /// Extends Image's editor class to provide default file searching for metafile (.emf) + /// files. /// [CLSCompliant(false)] public class MetafileEditor : ImageEditor diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs index e8d5ebb31ae..e68e610db06 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/AnchorEditor.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms.Design { /// - /// Provides a design-time editor for specifying the - /// property. + /// Provides a design-time editor for specifying the + /// property. /// [CLSCompliant(false)] public sealed class AnchorEditor : UITypeEditor @@ -18,7 +18,7 @@ public sealed class AnchorEditor : UITypeEditor private AnchorUI _anchorUI; /// - /// Edits the given object value using the editor style provided by GetEditorStyle. + /// Edits the given object value using the editor style provided by GetEditorStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -45,7 +45,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. + /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -53,7 +53,7 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// User Interface for the AnchorEditor. + /// User Interface for the AnchorEditor. /// private class AnchorUI : Control { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/BorderSidesEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/BorderSidesEditor.cs index e8d95b180b1..2f3e136eb64 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/BorderSidesEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/BorderSidesEditor.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides an editor for setting the ToolStripStatusLabel BorderSides property.. + /// Provides an editor for setting the ToolStripStatusLabel BorderSides property.. /// [CLSCompliant(false)] public class BorderSidesEditor : UITypeEditor @@ -19,7 +19,7 @@ public class BorderSidesEditor : UITypeEditor private BorderSidesEditorUI _borderSidesEditorUI; /// - /// Edits the given object value using the editor style provided by BorderSidesEditor.GetEditStyle. + /// Edits the given object value using the editor style provided by BorderSidesEditor.GetEditStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -50,8 +50,8 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. - /// If the method is not supported, this will return UITypeEditorEditStyle.None. + /// Gets the editing style of the Edit method. + /// If the method is not supported, this will return UITypeEditorEditStyle.None. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -59,7 +59,7 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Editor UI for the BorderSides editor. + /// Editor UI for the BorderSides editor. /// private class BorderSidesEditorUI : UserControl { @@ -89,7 +89,7 @@ public BorderSidesEditorUI(BorderSidesEditor editor) } /// - /// Allows someone else to close our dropdown. + /// Allows someone else to close our dropdown. /// public IWindowsFormsEditorService EditorService { @@ -98,7 +98,7 @@ public IWindowsFormsEditorService EditorService } /// - /// Returns the current value of BorderSides, if nothing is selected returns BorderSides.None. + /// Returns the current value of BorderSides, if nothing is selected returns BorderSides.None. /// public object Value { get; private set; } @@ -111,7 +111,7 @@ public void End() } /// - /// The first checkBox (allCheckBox) gets the focus by default. + /// The first checkBox (allCheckBox) gets the focus by default. /// protected override void OnGotFocus(EventArgs e) { @@ -224,7 +224,7 @@ private void InitializeComponent() } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void rightCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -245,7 +245,7 @@ private void rightCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void leftCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -266,7 +266,7 @@ private void leftCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void bottomCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -287,7 +287,7 @@ private void bottomCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void topCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -308,7 +308,7 @@ private void topCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void noneCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -326,7 +326,7 @@ private void noneCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. + /// CheckBox CheckedChanged event.. allows selecting/Deselecting proper values. /// private void allCheckBox_CheckedChanged(object sender, EventArgs e) { @@ -344,7 +344,7 @@ private void allCheckBox_CheckedChanged(object sender, EventArgs e) } /// - /// Click event. + /// Click event. /// private void noneCheckBoxClicked(object sender, EventArgs e) { @@ -355,7 +355,7 @@ private void noneCheckBoxClicked(object sender, EventArgs e) } /// - /// Click event. + /// Click event. /// private void allCheckBoxClicked(object sender, EventArgs e) { @@ -366,7 +366,7 @@ private void allCheckBoxClicked(object sender, EventArgs e) } /// - /// Allows to reset the state and start afresh. + /// Allows to reset the state and start afresh. /// private void ResetCheckBoxState() { @@ -379,7 +379,7 @@ private void ResetCheckBoxState() } /// - /// Allows to select proper values.. + /// Allows to select proper values.. /// private void SetCheckBoxCheckState(ToolStripStatusLabelBorderSides sides) { @@ -409,7 +409,7 @@ private void SetCheckBoxCheckState(ToolStripStatusLabelBorderSides sides) } /// - /// Triggered whenever the user drops down the editor. + /// Triggered whenever the user drops down the editor. /// public void Start(IWindowsFormsEditorService edSvc, object value) { @@ -426,7 +426,7 @@ public void Start(IWindowsFormsEditorService edSvc, object value) } /// - /// Update the current value based on the state of the UI controls. + /// Update the current value based on the state of the UI controls. /// private void UpdateCurrentValue() { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs index a71676b1e61..1d17a7e33ff 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/DockEditor.cs @@ -10,8 +10,8 @@ namespace System.Windows.Forms.Design { /// - /// Implements the design time editor for specifying the - /// property. + /// Implements the design time editor for specifying the + /// property. /// [CLSCompliant(false)] public sealed class DockEditor : UITypeEditor @@ -19,8 +19,8 @@ public sealed class DockEditor : UITypeEditor private DockUI _dockUI; /// - /// Edits the given object value using the editor style provided by GetEditorStyle. - /// A service provider is provided so that any required editing services can be obtained. + /// Edits the given object value using the editor style provided by GetEditorStyle. + /// A service provider is provided so that any required editing services can be obtained. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -47,7 +47,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Retrieves the editing style of the Edit method. + /// Retrieves the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -55,7 +55,7 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// User Interface for the DockEditor. + /// User Interface for the DockEditor. /// private class DockUI : Control { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs index 485f6f4d5ca..cd10e3f43cc 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FileNameEditor.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides an editor for filenames. + /// Provides an editor for filenames. /// [CLSCompliant(false)] public class FileNameEditor : UITypeEditor @@ -17,8 +17,8 @@ public class FileNameEditor : UITypeEditor private OpenFileDialog _openFileDialog; /// - /// Edits the given object value using the editor style provided by GetEditorStyle. - /// A service provider is provided so that any required editing services can be obtained. + /// Edits the given object value using the editor style provided by GetEditorStyle. + /// A service provider is provided so that any required editing services can be obtained. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -48,7 +48,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. + /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -56,9 +56,9 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Initializes the open file dialog when it is created. This gives you an opportunity to - /// configure the dialog as you please. The default implementation provides a generic file - /// filter and title. + /// Initializes the open file dialog when it is created. This gives you an opportunity to + /// configure the dialog as you please. The default implementation provides a generic file + /// filter and title. /// protected virtual void InitializeDialog(OpenFileDialog openFileDialog) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs index 73ce9a60280..91c23774437 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/FolderNameEditor.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides an editor for choosing a folder from the filesystem. + /// Provides an editor for choosing a folder from the filesystem. /// [CLSCompliant(false)] public class FolderNameEditor : UITypeEditor @@ -36,7 +36,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Retrieves the editing style of the Edit method. + /// Retrieves the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -44,8 +44,8 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Initializes the folder browser dialog when it is created. This gives you an opportunity - /// to configure the dialog as you please. The default implementation provides a generic folder browser. + /// Initializes the folder browser dialog when it is created. This gives you an opportunity + /// to configure the dialog as you please. The default implementation provides a generic folder browser. /// protected virtual void InitializeDialog(FolderBrowser folderBrowser) { @@ -57,25 +57,25 @@ protected sealed class FolderBrowser : Component private string _descriptionText = string.Empty; /// - /// The styles the folder browser will use when browsing - /// folders. This should be a combination of flags from - /// the FolderBrowserStyles enum. + /// The styles the folder browser will use when browsing + /// folders. This should be a combination of flags from + /// the FolderBrowserStyles enum. /// public FolderBrowserStyles Style { get; set; } = FolderBrowserStyles.RestrictToFilesystem; /// - /// Gets the directory path of the folder the user picked. + /// Gets the directory path of the folder the user picked. /// public string DirectoryPath { get; private set; } = string.Empty; /// - /// Gets/sets the start location of the root node. + /// Gets/sets the start location of the root node. /// public FolderBrowserFolder StartLocation { get; set; } = FolderBrowserFolder.Desktop; /// - /// Gets or sets a description to show above the folders. Here you can provide instructions for - /// selecting a folder. + /// Gets or sets a description to show above the folders. Here you can provide instructions for + /// selecting a folder. /// public string Description { @@ -84,12 +84,12 @@ public string Description } /// - /// Shows the folder browser dialog. + /// Shows the folder browser dialog. /// public DialogResult ShowDialog() => ShowDialog(null); /// - /// Shows the folder browser dialog with the specified owner. + /// Shows the folder browser dialog with the specified owner. /// public unsafe DialogResult ShowDialog(IWin32Window owner) { diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ImageCollectionEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ImageCollectionEditor.cs index 4b1bfc6963e..c98c3ad0e07 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ImageCollectionEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ImageCollectionEditor.cs @@ -16,7 +16,7 @@ namespace System.Windows.Forms.Design internal class ImageCollectionEditor : CollectionEditor { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ImageCollectionEditor(Type type) : base(type) diff --git a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ShortcutKeysEditor.cs b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ShortcutKeysEditor.cs index 3fd64257959..09b4d2399a6 100644 --- a/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ShortcutKeysEditor.cs +++ b/src/System.Windows.Forms.Design.Editors/src/System/Windows/Forms/Design/ShortcutKeysEditor.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides an editor for picking shortcut keys. + /// Provides an editor for picking shortcut keys. /// [CLSCompliant(false)] public class ShortcutKeysEditor : UITypeEditor @@ -19,7 +19,7 @@ public class ShortcutKeysEditor : UITypeEditor private ShortcutKeysUI _shortcutKeysUI; /// - /// Edits the given object value using the editor style provided by ShortcutKeysEditor.GetEditStyle. + /// Edits the given object value using the editor style provided by ShortcutKeysEditor.GetEditStyle. /// public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { @@ -53,7 +53,7 @@ public override object EditValue(ITypeDescriptorContext context, IServiceProvide } /// - /// Gets the editing style of the Edit method. + /// Gets the editing style of the Edit method. /// public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) { @@ -61,12 +61,12 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// Editor UI for the shortcut keys editor. + /// Editor UI for the shortcut keys editor. /// private class ShortcutKeysUI : UserControl { /// - /// Array of keys that are present in the drop down list of the combo box. + /// Array of keys that are present in the drop down list of the combo box. /// private static readonly Keys[] validKeys = { @@ -126,7 +126,7 @@ public ShortcutKeysUI(ShortcutKeysEditor editor) } /// - /// Allows someone else to close our dropdown. + /// Allows someone else to close our dropdown. /// // Can be called through reflection. public IWindowsFormsEditorService EditorService @@ -136,7 +136,7 @@ public IWindowsFormsEditorService EditorService } /// - /// Returns the Keys' type converter. + /// Returns the Keys' type converter. /// private TypeConverter KeysConverter { @@ -153,7 +153,7 @@ private TypeConverter KeysConverter } /// - /// Returns the selected keys. If only modifers were selected, we return Keys.None. + /// Returns the selected keys. If only modifers were selected, we return Keys.None. /// public object Value { @@ -169,7 +169,7 @@ public object Value } /// - /// Triggered when the user clicks the Reset button. The value is set to Keys.None + /// Triggered when the user clicks the Reset button. The value is set to Keys.None /// private void btnReset_Click(object sender, EventArgs e) { @@ -338,7 +338,7 @@ private void AdjustSize() } /// - /// Returns True if the given key is part of the valid keys array. + /// Returns True if the given key is part of the valid keys array. /// private static bool IsValidKey(Keys keyCode) { @@ -355,7 +355,7 @@ private static bool IsValidKey(Keys keyCode) } /// - /// The Ctrl checkbox gets the focus by default. + /// The Ctrl checkbox gets the focus by default. /// protected override void OnGotFocus(EventArgs e) { @@ -364,7 +364,7 @@ protected override void OnGotFocus(EventArgs e) } /// - /// Fix keyboard navigation and handle escape key + /// Fix keyboard navigation and handle escape key /// protected override bool ProcessDialogKey(Keys keyData) { @@ -428,7 +428,7 @@ protected override bool ProcessDialogKey(Keys keyData) } /// - /// Triggered whenever the user drops down the editor. + /// Triggered whenever the user drops down the editor. /// public void Start(IWindowsFormsEditorService edSvc, object value) { @@ -462,7 +462,7 @@ public void Start(IWindowsFormsEditorService edSvc, object value) } /// - /// Update the current value based on the state of the UI controls. + /// Update the current value based on the state of the UI controls. /// private void UpdateCurrentValue() { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/CodeMarkers.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/CodeMarkers.cs index ab0a3baad3d..2ad9c92c752 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/CodeMarkers.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/CodeMarkers.cs @@ -27,7 +27,7 @@ static class NativeMethods [DllImport(ProductDllName, EntryPoint = "PerfCodeMarker")] public static extern void ProductDllPerfCodeMarkerString(int nTimerID, [MarshalAs(UnmanagedType.LPWStr, SizeParamIndex = 2)] string aUserParams, int cbParams); - /// global native method imports + /// global native method imports [DllImport("kernel32.dll", CharSet = CharSet.Unicode)] public static extern ushort FindAtom([MarshalAs(UnmanagedType.LPWStr)] string lpString); } @@ -44,17 +44,17 @@ static class NativeMethods enum State { /// - /// The atom is present. CodeMarkers are enabled. + /// The atom is present. CodeMarkers are enabled. /// Enabled, /// - /// The atom is not present, but InitPerformanceDll has not yet been called. + /// The atom is not present, but InitPerformanceDll has not yet been called. /// Disabled, /// - /// Disabled because the CodeMarkers transport DLL could not be found or an import failed to resolve. + /// Disabled because the CodeMarkers transport DLL could not be found or an import failed to resolve. /// DisabledDueToDllImportException } @@ -62,7 +62,7 @@ enum State private State _state; /// - /// Are CodeMarkers enabled? Note that even if IsEnabled returns false, CodeMarkers may still be enabled later in another component. + /// Are CodeMarkers enabled? Note that even if IsEnabled returns false, CodeMarkers may still be enabled later in another component. /// public bool IsEnabled { @@ -120,7 +120,7 @@ private CodeMarkers() } /// - /// Sends a code marker event + /// Sends a code marker event /// /// The code marker event ID /// true if the code marker was successfully sent, false if code markers are not enabled or an error occurred. @@ -153,7 +153,7 @@ public bool CodeMarker(int nTimerID) } /// - /// Sends a code marker event with additional user data + /// Sends a code marker event with additional user data /// /// The code marker event ID /// User data buffer. May not be null. @@ -196,7 +196,7 @@ public bool CodeMarkerEx(int nTimerID, byte[] aBuff) } /// - /// Used by ManagedPerfTrack.cs to report errors accessing the DLL. + /// Used by ManagedPerfTrack.cs to report errors accessing the DLL. /// public void SetStateDLLException() { @@ -204,7 +204,7 @@ public void SetStateDLLException() } /// - /// Sends a code marker event with additional Guid user data + /// Sends a code marker event with additional Guid user data /// /// The code marker event ID /// The additional Guid to include with the event @@ -215,7 +215,7 @@ public bool CodeMarkerEx(int nTimerID, Guid guidData) } /// - /// Sends a code marker event with additional String user data + /// Sends a code marker event with additional String user data /// /// The code marker event ID /// The additional String to include with the event @@ -257,7 +257,7 @@ public bool CodeMarkerEx(int nTimerID, string stringData) } /// - /// Converts a string into a byte buffer including a zero terminator (needed for proper ETW message formatting) + /// Converts a string into a byte buffer including a zero terminator (needed for proper ETW message formatting) /// /// String to be converted to bytes internal static byte[] StringToBytesZeroTerminated(string stringData) @@ -289,7 +289,7 @@ public static byte[] AttachCorrelationId(byte[] buffer, Guid correlationId) } /// - /// Sends a code marker event with additional DWORD user data + /// Sends a code marker event with additional DWORD user data /// /// The code marker event ID /// The additional DWORD to include with the event @@ -300,7 +300,7 @@ public bool CodeMarkerEx(int nTimerID, uint uintData) } /// - /// Sends a code marker event with additional QWORD user data + /// Sends a code marker event with additional QWORD user data /// /// The code marker event ID /// The additional QWORD to include with the event @@ -311,7 +311,7 @@ public bool CodeMarkerEx(int nTimerID, ulong ulongData) } /// - /// Checks the registry to see if code markers are enabled + /// Checks the registry to see if code markers are enabled /// /// The registry root /// The registry view. @@ -341,39 +341,39 @@ private static bool UsePrivateCodeMarkers(string regRoot, RegistryView registryV #if Codemarkers_IncludeAppEnum /// - /// Check the registry and, if appropriate, loads and initializes the code markers dll. - /// InitPerformanceDll may be called more than once, but only the first successful call will do anything. - /// Subsequent calls will be ignored. - /// For 32-bit processes on a 64-bit machine, the 32-bit (Wow6432Node) registry will be used. - /// For 64-bit processes, the 64-bit registry will be used. If you need to use the Wow6432Node in this case - /// then use the overload of InitPerformanceDll that takes a RegistryView parameter. + /// Check the registry and, if appropriate, loads and initializes the code markers dll. + /// InitPerformanceDll may be called more than once, but only the first successful call will do anything. + /// Subsequent calls will be ignored. + /// For 32-bit processes on a 64-bit machine, the 32-bit (Wow6432Node) registry will be used. + /// For 64-bit processes, the 64-bit registry will be used. If you need to use the Wow6432Node in this case + /// then use the overload of InitPerformanceDll that takes a RegistryView parameter. /// /// The application ID value that distinguishes these code marker events from other applications. /// The registry root of the application. The default value of the "Performance" subkey under this - /// root will be checked to determine if CodeMarkers should be enabled. + /// root will be checked to determine if CodeMarkers should be enabled. /// true if CodeMarkers were initialized successfully, or if InitPerformanceDll has already been called - /// successfully once. - /// false indicates that either CodeMarkers are not enabled in the registry, or that the CodeMarkers transport - /// DLL failed to load. + /// successfully once. + /// false indicates that either CodeMarkers are not enabled in the registry, or that the CodeMarkers transport + /// DLL failed to load. public bool InitPerformanceDll(int iApp, string strRegRoot) { return InitPerformanceDll(iApp, strRegRoot, RegistryView.Default); } /// - /// Check the registry and, if appropriate, loads and initializes the code markers dll. - /// InitPerformanceDll may be called more than once, but only the first successful call will do anything. - /// Subsequent calls will be ignored. + /// Check the registry and, if appropriate, loads and initializes the code markers dll. + /// InitPerformanceDll may be called more than once, but only the first successful call will do anything. + /// Subsequent calls will be ignored. /// /// The application ID value that distinguishes these code marker events from other applications. /// The registry root of the application. The default value of the "Performance" subkey under this - /// root will be checked to determine if CodeMarkers should be enabled. + /// root will be checked to determine if CodeMarkers should be enabled. /// Specify RegistryView.Registry32 to use the 32-bit registry even if the calling application - /// is 64-bit + /// is 64-bit /// true if CodeMarkers were initialized successfully, or if InitPerformanceDll has already been called - /// successfully once. - /// false indicates that either CodeMarkers are not enabled in the registry, or that the CodeMarkers transport - /// DLL failed to load. + /// successfully once. + /// false indicates that either CodeMarkers are not enabled in the registry, or that the CodeMarkers transport + /// DLL failed to load. public bool InitPerformanceDll(int iApp, string strRegRoot, RegistryView registryView) { // Prevent multiple initializations. @@ -467,7 +467,7 @@ public void UninitializePerformanceDLL(int iApp) #if !Codemarkers_NoCodeMarkerStartEnd /// - /// Use CodeMarkerStartEnd in a using clause when you need to bracket an operation with a start/end CodeMarker event pair. If you are using correlated codemarkers and providing your own event manifest, include two GUIDs (the correlation "marker" and the correlation ID itself) as the very first fields. + /// Use CodeMarkerStartEnd in a using clause when you need to bracket an operation with a start/end CodeMarker event pair. If you are using correlated codemarkers and providing your own event manifest, include two GUIDs (the correlation "marker" and the correlation ID itself) as the very first fields. /// internal struct CodeMarkerStartEnd : IDisposable { @@ -509,7 +509,7 @@ private void CodeMarker(int id) } /// - /// Use CodeMarkerExStartEnd in a using clause when you need to bracket an operation with a start/end CodeMarker event pair. If you are using correlated codemarkers and providing your own event manifest, include two GUIDs (the correlation "marker" and the correlation ID itself) as the very first fields. + /// Use CodeMarkerExStartEnd in a using clause when you need to bracket an operation with a start/end CodeMarker event pair. If you are using correlated codemarkers and providing your own event manifest, include two GUIDs (the correlation "marker" and the correlation ID itself) as the very first fields. /// internal struct CodeMarkerExStartEnd : IDisposable { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ComponentDesigner.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ComponentDesigner.cs index c722803dcc0..39ac942f5f5 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ComponentDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ComponentDesigner.cs @@ -12,7 +12,7 @@ namespace System.ComponentModel.Design { /// - /// The default designer for all components. + /// The default designer for all components. /// public class ComponentDesigner : ITreeDesigner, IDesignerFilter, IComponentInitializer { @@ -29,7 +29,7 @@ public class ComponentDesigner : ITreeDesigner, IDesignerFilter, IComponentIniti private protected const string SettingsKeyName = "SettingsKey"; /// - /// Gets the design-time actionlists supported by the component associated with the designer. + /// Gets the design-time actionlists supported by the component associated with the designer. /// public virtual DesignerActionListCollection ActionLists { @@ -44,7 +44,7 @@ public virtual DesignerActionListCollection ActionLists } /// - /// Retrieves a list of associated components. These are components that should be incluced in a cut or copy operation on this component. + /// Retrieves a list of associated components. These are components that should be incluced in a cut or copy operation on this component. /// public virtual ICollection AssociatedComponents { @@ -54,7 +54,7 @@ public virtual ICollection AssociatedComponents internal virtual bool CanBeAssociatedWith(IDesigner parentDesigner) => true; /// - /// Gets or sets a value indicating whether or not this component is being inherited. + /// Gets or sets a value indicating whether or not this component is being inherited. /// protected bool Inherited { @@ -66,11 +66,11 @@ protected bool Inherited } /// - /// This property provides a generic mechanism for discovering parent relationships within designers, - /// and is used by ComponentDesigner's ITreeDesigner interface implementation. This property - /// should only return null when this designer is the root component. Otherwise, it should return - /// the parent component. The default implementation of this property returns the root component - /// for all components that are not the root component, and it returns null for the root component. + /// This property provides a generic mechanism for discovering parent relationships within designers, + /// and is used by ComponentDesigner's ITreeDesigner interface implementation. This property + /// should only return null when this designer is the root component. Otherwise, it should return + /// the parent component. The default implementation of this property returns the root component + /// for all components that are not the root component, and it returns null for the root component. /// protected virtual IComponent ParentComponent { @@ -90,7 +90,7 @@ protected virtual IComponent ParentComponent } /// - /// Gets or sets the inheritance attribute for this component. + /// Gets or sets the inheritance attribute for this component. /// protected virtual InheritanceAttribute InheritanceAttribute { @@ -114,7 +114,7 @@ protected virtual InheritanceAttribute InheritanceAttribute } /// - /// Gets a collection that houses shadow properties. Shadow properties. are properties that fall through to the underlying component before they are set, but return their set values once they are set. + /// Gets a collection that houses shadow properties. Shadow properties. are properties that fall through to the underlying component before they are set, but return their set values once they are set. /// protected ShadowPropertyCollection ShadowProperties { @@ -129,10 +129,10 @@ protected ShadowPropertyCollection ShadowProperties } /// - /// This method is called when an existing component is being re-initialized. This may occur after dragging a component to another container, for example. - /// The defaultValues property contains a name/value dictionary of default values that should be applied to properties. This dictionary may be null if no default values are specified. - /// You may use the defaultValues dictionary to apply recommended defaults to proeprties but you should not modify component properties beyond what is stored in the dictionary, because this is an existing component that may already have properties set on it. - /// The default implemenation of this method does nothing. + /// This method is called when an existing component is being re-initialized. This may occur after dragging a component to another container, for example. + /// The defaultValues property contains a name/value dictionary of default values that should be applied to properties. This dictionary may be null if no default values are specified. + /// You may use the defaultValues dictionary to apply recommended defaults to proeprties but you should not modify component properties beyond what is stored in the dictionary, because this is an existing component that may already have properties set on it. + /// The default implemenation of this method does nothing. /// public virtual void InitializeExistingComponent(IDictionary defaultValues) { @@ -140,12 +140,12 @@ public virtual void InitializeExistingComponent(IDictionary defaultValues) } /// - /// This method is called when a component is first initialized, typically after being first added - /// to a design surface. The defaultValues property contains a name/value dictionary of default - /// values that should be applied to properties. This dictionary may be null if no default values - /// are specified. You may perform any initialization of this component that you like, and you - /// may even ignore the defaultValues dictionary altogether if you wish. - /// The default implemenation of this method does nothing. + /// This method is called when a component is first initialized, typically after being first added + /// to a design surface. The defaultValues property contains a name/value dictionary of default + /// values that should be applied to properties. This dictionary may be null if no default values + /// are specified. You may perform any initialization of this component that you like, and you + /// may even ignore the defaultValues dictionary altogether if you wish. + /// The default implemenation of this method does nothing. /// public virtual void InitializeNewComponent(IDictionary defaultValues) { @@ -186,7 +186,7 @@ void IDesignerFilter.PreFilterProperties(IDictionary properties) } /// - /// Gets or sets the component this designer is designing. + /// Gets or sets the component this designer is designing. /// public IComponent Component { @@ -197,7 +197,7 @@ public IComponent Component } /// - /// Gets the design-time verbs supported by the component associated with the designer. + /// Gets the design-time verbs supported by the component associated with the designer. /// public virtual DesignerVerbCollection Verbs { @@ -260,7 +260,7 @@ IDesigner ITreeDesigner.Parent } /// - /// Disposes of the resources (other than memory) used by the . + /// Disposes of the resources (other than memory) used by the . /// public void Dispose() { @@ -269,7 +269,7 @@ public void Dispose() } /// - /// Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location in preparation to assign the default action. + /// Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location in preparation to assign the default action. /// public virtual void DoDefaultAction() { @@ -411,7 +411,7 @@ internal bool IsRootDesigner } /// - /// Initializes a new instance of the class using the specified component. + /// Initializes a new instance of the class using the specified component. /// public virtual void Initialize(IComponent component) { @@ -443,7 +443,7 @@ public virtual void Initialize(IComponent component) } /// - /// DesignerCommandSet to be used as a site specific service. + /// DesignerCommandSet to be used as a site specific service. /// private class CDDesignerCommandSet : DesignerCommandSet { @@ -516,7 +516,7 @@ private void InitializeInheritedProperties() } /// - /// Invokes the get inheritance attribute of the specified ComponentDesigner. + /// Invokes the get inheritance attribute of the specified ComponentDesigner. /// protected InheritanceAttribute InvokeGetInheritanceAttribute(ComponentDesigner toInvoke) { @@ -524,7 +524,7 @@ protected InheritanceAttribute InvokeGetInheritanceAttribute(ComponentDesigner t } /// - /// Disposes of the resources (other than memory) used by the . + /// Disposes of the resources (other than memory) used by the . /// protected virtual void Dispose(bool disposing) { @@ -541,7 +541,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Raised when a component's name changes. Here we update the SettingsKey property if necessary. + /// Raised when a component's name changes. Here we update the SettingsKey property if necessary. /// private void OnComponentRename(object sender, ComponentRenameEventArgs e) { @@ -560,7 +560,7 @@ private void OnComponentRename(object sender, ComponentRenameEventArgs e) } /// - /// shadowing the SettingsKey so we can default it to be RootComponent.Name + "." + Control.Name + /// shadowing the SettingsKey so we can default it to be RootComponent.Name + "." + Control.Name /// private string SettingsKey { @@ -610,9 +610,9 @@ private void ResetSettingsKey() } /// - /// Called when the designer has been associated with a control that is not in it's default state, such as one that has been pasted or drag-dropped onto the designer. - /// This is an opportunity to fixup any shadowed properties in a different way than for default components. - /// This is called after the other initialize functions. + /// Called when the designer has been associated with a control that is not in it's default state, such as one that has been pasted or drag-dropped onto the designer. + /// This is an opportunity to fixup any shadowed properties in a different way than for default components. + /// This is called after the other initialize functions. /// [Obsolete("This method has been deprecated. Use InitializeExistingComponent instead. http://go.microsoft.com/fwlink/?linkid=14202")] public virtual void InitializeNonDefault() @@ -620,7 +620,7 @@ public virtual void InitializeNonDefault() } /// - /// Provides a way for a designer to get services from the hosting environment. + /// Provides a way for a designer to get services from the hosting environment. /// protected virtual object GetService(Type serviceType) { @@ -636,7 +636,7 @@ protected virtual object GetService(Type serviceType) } /// - /// Raises the SetComponentDefault event. + /// Raises the SetComponentDefault event. /// [Obsolete("This method has been deprecated. Use InitializeNewComponent instead. http://go.microsoft.com/fwlink/?linkid=14202")] public virtual void OnSetComponentDefaults() @@ -659,7 +659,7 @@ public virtual void OnSetComponentDefaults() } /// - /// Called when the context menu should be displayed + /// Called when the context menu should be displayed /// internal virtual void ShowContextMenu(int x, int y) { @@ -671,7 +671,7 @@ internal virtual void ShowContextMenu(int x, int y) } /// - /// Allows a designer to filter the set of member attributes the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of member attributes the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PostFilterAttributes(IDictionary attributes) { @@ -696,7 +696,7 @@ protected virtual void PostFilterAttributes(IDictionary attributes) } /// - /// Allows a designer to filter the set of events the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of events the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PostFilterEvents(IDictionary events) { @@ -726,7 +726,7 @@ protected virtual void PostFilterEvents(IDictionary events) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PostFilterProperties(IDictionary properties) { @@ -770,21 +770,21 @@ protected virtual void PostFilterProperties(IDictionary properties) } /// - /// Allows a designer to filter the set of member attributes the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of member attributes the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PreFilterAttributes(IDictionary attributes) { } /// - /// Allows a designer to filter the set of events the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of events the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PreFilterEvents(IDictionary events) { } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. /// protected virtual void PreFilterProperties(IDictionary properties) { @@ -798,8 +798,8 @@ protected virtual void PreFilterProperties(IDictionary properties) } /// - /// Notifies the that this component has been changed. - /// You only need to call this when you are affecting component properties directly and not through the MemberDescriptor's accessors. + /// Notifies the that this component has been changed. + /// You only need to call this when you are affecting component properties directly and not through the MemberDescriptor's accessors. /// protected void RaiseComponentChanged(MemberDescriptor member, object oldValue, object newValue) { @@ -810,8 +810,8 @@ protected void RaiseComponentChanged(MemberDescriptor member, object oldValue, o } /// - /// Notifies the that this component is about to be changed. - /// You only need to call this when you are affecting component properties directly and not through the MemberDescriptor's accessors. + /// Notifies the that this component is about to be changed. + /// You only need to call this when you are affecting component properties directly and not through the MemberDescriptor's accessors. /// protected void RaiseComponentChanging(MemberDescriptor member) { @@ -822,7 +822,7 @@ protected void RaiseComponentChanging(MemberDescriptor member) } /// - /// Collection that holds shadow properties. + /// Collection that holds shadow properties. /// protected sealed class ShadowPropertyCollection { @@ -835,7 +835,7 @@ internal ShadowPropertyCollection(ComponentDesigner designer) } /// - /// Accesses the given property name. This will throw an exception if the property does not exsit on the base component. + /// Accesses the given property name. This will throw an exception if the property does not exsit on the base component. /// public object this[string propertyName] { @@ -868,7 +868,7 @@ public object this[string propertyName] } /// - /// Returns true if this shadow properties object contains the given property name. + /// Returns true if this shadow properties object contains the given property name. /// public bool Contains(string propertyName) { @@ -876,7 +876,7 @@ public bool Contains(string propertyName) } /// - /// Returns the underlying property descriptor for this property on the component + /// Returns the underlying property descriptor for this property on the component /// private PropertyDescriptor GetShadowedPropertyDescriptor(string propertyName) { @@ -896,8 +896,8 @@ private PropertyDescriptor GetShadowedPropertyDescriptor(string propertyName) } /// - /// Returns true if the given property name should be serialized, or false if not. - /// This is useful in implementing your own ShouldSerialize* methods on shadowed properties. + /// Returns true if the given property name should be serialized, or false if not. + /// This is useful in implementing your own ShouldSerialize* methods on shadowed properties. /// internal bool ShouldSerializeValue(string propertyName, object defaultValue) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurface.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurface.cs index bb74ce17157..8560565f66e 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurface.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurface.cs @@ -10,7 +10,7 @@ namespace System.ComponentModel.Design { /// - /// A design surface is an object that contains multiple designers and presents a user-editable surface for them. + /// A design surface is an object that contains multiple designers and presents a user-editable surface for them. /// public class DesignSurface : IDisposable, IServiceProvider { @@ -21,14 +21,14 @@ public class DesignSurface : IDisposable, IServiceProvider private bool _loaded; /// - /// Creates a new DesignSurface. + /// Creates a new DesignSurface. /// public DesignSurface() : this((IServiceProvider)null) { } /// - /// Creates a new DesignSurface given a parent service provider. + /// Creates a new DesignSurface given a parent service provider. /// /// The parent service provider. If there is no parent used to resolve services this can be null. public DesignSurface(IServiceProvider parentProvider) @@ -49,14 +49,14 @@ public DesignSurface(IServiceProvider parentProvider) } /// - /// Creates a new DesignSurface. + /// Creates a new DesignSurface. /// public DesignSurface(Type rootComponentType) : this(null, rootComponentType) { } /// - /// Creates a new DesignSurface given a parent service provider. + /// Creates a new DesignSurface given a parent service provider. /// /// The parent service provider. If there is no parent used to resolve services this can be null. public DesignSurface(IServiceProvider parentProvider, Type rootComponentType) : this(parentProvider) @@ -69,7 +69,7 @@ public DesignSurface(IServiceProvider parentProvider, Type rootComponentType) : } /// - /// Provides access to the design surface's container, which contains all components currently being designed. + /// Provides access to the design surface's container, which contains all components currently being designed. /// public IContainer ComponentContainer { @@ -84,7 +84,7 @@ public IContainer ComponentContainer } /// - /// Returns true if the design surface is currently loaded. This will be true when a successful load has completed, or false for all other cases. + /// Returns true if the design surface is currently loaded. This will be true when a successful load has completed, or false for all other cases. /// public bool IsLoaded { @@ -95,7 +95,7 @@ public bool IsLoaded } /// - /// Returns a collection of LoadErrors or a void collection. + /// Returns a collection of LoadErrors or a void collection. /// public ICollection LoadErrors { @@ -110,7 +110,7 @@ public ICollection LoadErrors } /// - /// Returns true if DTEL (WSOD) is currently loading. + /// Returns true if DTEL (WSOD) is currently loading. /// public bool DtelLoading { @@ -119,7 +119,7 @@ public bool DtelLoading } /// - /// Provides access to the design surface's ServiceContainer. This property allows inheritors to add their own services. + /// Provides access to the design surface's ServiceContainer. This property allows inheritors to add their own services. /// protected ServiceContainer ServiceContainer { @@ -134,10 +134,10 @@ protected ServiceContainer ServiceContainer } /// - /// This property will return the view for the root designer. BeginLoad must have been called beforehand to start the loading process. It is possible to return a view before the designer loader finishes loading because the root designer, which supplies the view, is the first object created by the designer loader. If a view is unavailable this method will throw an exception. - /// Possible exceptions: - /// The design surface is not loading or the designer loader has not yet created a root designer: InvalidOperationException - /// The design surface finished the load, but failed. (Various. This will throw the first exception the designer loader added to the error collection). + /// This property will return the view for the root designer. BeginLoad must have been called beforehand to start the loading process. It is possible to return a view before the designer loader finishes loading because the root designer, which supplies the view, is the first object created by the designer loader. If a view is unavailable this method will throw an exception. + /// Possible exceptions: + /// The design surface is not loading or the designer loader has not yet created a root designer: InvalidOperationException + /// The design surface finished the load, but failed. (Various. This will throw the first exception the designer loader added to the error collection). /// public object View { @@ -196,43 +196,43 @@ public object View } /// - /// Adds a event handler to listen to the Disposed event on the component. + /// Adds a event handler to listen to the Disposed event on the component. /// public event EventHandler Disposed; /// - /// Adds a event handler to listen to the Flushed event on the component. This is called after the design surface has asked the designer loader to flush its state. + /// Adds a event handler to listen to the Flushed event on the component. This is called after the design surface has asked the designer loader to flush its state. /// public event EventHandler Flushed; /// - /// Called when the designer load has completed. This is called for successful loads as well as unsuccessful ones. If code in this event handler throws an exception the designer will be unloaded. + /// Called when the designer load has completed. This is called for successful loads as well as unsuccessful ones. If code in this event handler throws an exception the designer will be unloaded. /// public event LoadedEventHandler Loaded; /// - /// Called when the designer load is about to begin the loading process. + /// Called when the designer load is about to begin the loading process. /// public event EventHandler Loading; /// - /// Called when the designer has completed the unloading - /// process. + /// Called when the designer has completed the unloading + /// process. /// public event EventHandler Unloaded; /// - /// Called when a designer is about to begin reloading. When a designer reloads, all of the state for that designer is recreated, including the designer's view. The view should be unparented at this time. + /// Called when a designer is about to begin reloading. When a designer reloads, all of the state for that designer is recreated, including the designer's view. The view should be unparented at this time. /// public event EventHandler Unloading; /// - /// Called when someone has called the Activate method on IDesignerHost. You should attach a handler to this event that activates the window for this design surface. + /// Called when someone has called the Activate method on IDesignerHost. You should attach a handler to this event that activates the window for this design surface. /// public event EventHandler ViewActivated; /// - /// This method begins the loading process with the given designer loader. Designer loading can be asynchronous, so the loading may continue to progress after this call has returned. Listen to the Loaded event to know when the design surface has completed loading. + /// This method begins the loading process with the given designer loader. Designer loading can be asynchronous, so the loading may continue to progress after this call has returned. Listen to the Loaded event to know when the design surface has completed loading. /// public void BeginLoad(DesignerLoader loader) { @@ -252,7 +252,7 @@ public void BeginLoad(DesignerLoader loader) } /// - /// This method begins the loading process for a component of the given type. This will create an instance of the component type and initialize a designer for that instance. Loaded is raised before this method returns. + /// This method begins the loading process for a component of the given type. This will create an instance of the component type and initialize a designer for that instance. Loaded is raised before this method returns. /// public void BeginLoad(Type rootComponentType) { @@ -269,7 +269,7 @@ public void BeginLoad(Type rootComponentType) } /// - /// This method is called to create a component of the given type. + /// This method is called to create a component of the given type. /// [Obsolete("CreateComponent has been replaced by CreateInstance and will be removed after Beta2")] protected internal virtual IComponent CreateComponent(Type componentType) @@ -278,7 +278,7 @@ protected internal virtual IComponent CreateComponent(Type componentType) } /// - /// This method is called to create a designer for a component. + /// This method is called to create a designer for a component. /// protected internal virtual IDesigner CreateDesigner(IComponent component, bool rootDesigner) { @@ -305,8 +305,8 @@ protected internal virtual IDesigner CreateDesigner(IComponent component, bool r } /// - /// This method is called to create an instance of the given type. If the type is a component - /// this will search for a constructor of type IContainer first, and then an empty constructor. + /// This method is called to create an instance of the given type. If the type is a component + /// this will search for a constructor of type IContainer first, and then an empty constructor. /// protected internal virtual object CreateInstance(Type type) { @@ -342,7 +342,7 @@ protected internal virtual object CreateInstance(Type type) } /// - /// Creates a container suitable for nesting controls or components. Adding a component to a nested container creates its doesigner and makes it elligble for all all services available from the design surface. Components added to nested containers do not participate in serialization. You may provide an additional name for this container by passing a value into containerName. + /// Creates a container suitable for nesting controls or components. Adding a component to a nested container creates its doesigner and makes it elligble for all all services available from the design surface. Components added to nested containers do not participate in serialization. You may provide an additional name for this container by passing a value into containerName. /// public INestedContainer CreateNestedContainer(IComponent owningComponent) { @@ -350,7 +350,7 @@ public INestedContainer CreateNestedContainer(IComponent owningComponent) } /// - /// Creates a container suitable for nesting controls or components. Adding a component to a nested container creates its doesigner and makes it elligble for all all services available from the design surface. Components added to nested containers do not participate in serialization. You may provide an additional name for this container by passing a value into containerName. + /// Creates a container suitable for nesting controls or components. Adding a component to a nested container creates its doesigner and makes it elligble for all all services available from the design surface. Components added to nested containers do not participate in serialization. You may provide an additional name for this container by passing a value into containerName. /// public INestedContainer CreateNestedContainer(IComponent owningComponent, string containerName) { @@ -367,7 +367,7 @@ public INestedContainer CreateNestedContainer(IComponent owningComponent, string } /// - /// Disposes the design surface. + /// Disposes the design surface. /// public void Dispose() { @@ -375,7 +375,7 @@ public void Dispose() } /// - /// Protected override of Dispose that allows for cleanup. + /// Protected override of Dispose that allows for cleanup. /// /// True if Dispose is being called or false if this is being invoked by a finalizer. protected virtual void Dispose(bool disposing) @@ -413,7 +413,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Flushes any design changes to the underlying loader. + /// Flushes any design changes to the underlying loader. /// public void Flush() { @@ -426,7 +426,7 @@ public void Flush() } /// - /// Retrieves a service in this design surface's service container. + /// Retrieves a service in this design surface's service container. /// /// The type of service to retrieve. /// An instance of the requested service or null if the service could not be found. @@ -440,7 +440,7 @@ public object GetService(Type serviceType) } /// - /// Called by the designer host in response to an Activate call on its interface. + /// Called by the designer host in response to an Activate call on its interface. /// internal void OnViewActivate() { @@ -448,7 +448,7 @@ internal void OnViewActivate() } /// - /// Private method that demand-creates services we offer. + /// Private method that demand-creates services we offer. /// /// The service container requesting the service. /// The type of service being requested. @@ -480,7 +480,7 @@ private object OnCreateService(IServiceContainer container, Type serviceType) } /// - /// This is invoked by the designer host when it has finished the load. + /// This is invoked by the designer host when it has finished the load. /// internal void OnLoaded(bool successful, ICollection errors) { @@ -510,8 +510,8 @@ internal void OnLoaded(bool successful, ICollection errors) } /// - /// Called when the loading process has completed. This is invoked for both successful and unsuccessful loads. The EventArgs passed into this method can be used to tell a successful from an unsuccessful load. It can also be used to create a view for this design surface. If code in this event handler or override throws an exception, - /// the designer will be unloaded. + /// Called when the loading process has completed. This is invoked for both successful and unsuccessful loads. The EventArgs passed into this method can be used to tell a successful from an unsuccessful load. It can also be used to create a view for this design surface. If code in this event handler or override throws an exception, + /// the designer will be unloaded. /// protected virtual void OnLoaded(LoadedEventArgs e) { @@ -519,7 +519,7 @@ protected virtual void OnLoaded(LoadedEventArgs e) } /// - /// Called when the loading process is about to begin. + /// Called when the loading process is about to begin. /// internal void OnLoading() { @@ -527,7 +527,7 @@ internal void OnLoading() } /// - /// Called when the loading process is about to begin. + /// Called when the loading process is about to begin. /// protected virtual void OnLoading(EventArgs e) { @@ -535,7 +535,7 @@ protected virtual void OnLoading(EventArgs e) } /// - /// This is invoked by the designer host after it has unloaded a document. + /// This is invoked by the designer host after it has unloaded a document. /// internal void OnUnloaded() { @@ -543,7 +543,7 @@ internal void OnUnloaded() } /// - /// Called when a designer has finished unloading a document. + /// Called when a designer has finished unloading a document. /// protected virtual void OnUnloaded(EventArgs e) { @@ -551,7 +551,7 @@ protected virtual void OnUnloaded(EventArgs e) } /// - /// This is invoked by the designer host when it is about to unload a document. + /// This is invoked by the designer host when it is about to unload a document. /// internal void OnUnloading() { @@ -560,7 +560,7 @@ internal void OnUnloading() } /// - /// Called when a designer is about to begin reloading. When a designer reloads, all of the state for that designer is recreated, including the designer's view. The view should be unparented at this time. + /// Called when a designer is about to begin reloading. When a designer reloads, all of the state for that designer is recreated, including the designer's view. The view should be unparented at this time. /// protected virtual void OnUnloading(EventArgs e) { @@ -568,7 +568,7 @@ protected virtual void OnUnloading(EventArgs e) } /// - /// Called when someone has called the Activate method on IDesignerHost. You should attach a handler to this event that activates the window for this design surface. + /// Called when someone has called the Activate method on IDesignerHost. You should attach a handler to this event that activates the window for this design surface. /// protected virtual void OnViewActivate(EventArgs e) { @@ -576,7 +576,7 @@ protected virtual void OnViewActivate(EventArgs e) } /// - /// This is a simple designer loader that creates an instance of the given type and then calls EndLoad. If a collection of objects was passed, this will simply add those objects to the container. + /// This is a simple designer loader that creates an instance of the given type and then calls EndLoad. If a collection of objects was passed, this will simply add those objects to the container. /// private class DefaultDesignerLoader : DesignerLoader { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurfaceServiceContainer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurfaceServiceContainer.cs index 5d43c590b51..ca366919fb8 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurfaceServiceContainer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignSurfaceServiceContainer.cs @@ -7,14 +7,14 @@ namespace System.ComponentModel.Design { /// - /// A service container that supports "fixed" services. Fixed services cannot be removed. + /// A service container that supports "fixed" services. Fixed services cannot be removed. /// internal sealed class DesignSurfaceServiceContainer : ServiceContainer { private readonly Hashtable _fixedServices = new Hashtable(); /// - /// We always add ourselves as a service. + /// We always add ourselves as a service. /// internal DesignSurfaceServiceContainer(IServiceProvider parentProvider) : base(parentProvider) { @@ -22,7 +22,7 @@ internal DesignSurfaceServiceContainer(IServiceProvider parentProvider) : base(p } /// - /// Removes the given service type from the service container. + /// Removes the given service type from the service container. /// internal void AddFixedService(Type serviceType, object serviceInstance) { @@ -31,7 +31,7 @@ internal void AddFixedService(Type serviceType, object serviceInstance) } /// - /// Removes a previously added fixed service. + /// Removes a previously added fixed service. /// internal void RemoveFixedService(Type serviceType) { @@ -40,7 +40,7 @@ internal void RemoveFixedService(Type serviceType) } /// - /// Removes the given service type from the service container. Throws an exception if the service is fixed. + /// Removes the given service type from the service container. Throws an exception if the service is fixed. /// public override void RemoveService(Type serviceType, bool promote) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionItem.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionItem.cs index 34d64277245..5902f9a0359 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionItem.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionItem.cs @@ -9,9 +9,9 @@ namespace System.ComponentModel.Design { /// - /// A menu command that defines text and other metadata to describe a targeted task that can be performed. - /// Tasks typically walk the user through some multi-step process, such as configuring a data source for a component. - /// Designer tasks are shown in a custom piece of UI (Chrome). + /// A menu command that defines text and other metadata to describe a targeted task that can be performed. + /// Tasks typically walk the user through some multi-step process, such as configuring a data source for a component. + /// Designer tasks are shown in a custom piece of UI (Chrome). /// public abstract class DesignerActionItem { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionList.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionList.cs index 0b11c725058..f7a63653546 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionList.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionList.cs @@ -8,9 +8,9 @@ namespace System.ComponentModel.Design { /// - /// DesignerActionList is the abstract base class which control authors inherit from to create a task sheet. - /// Typical usage is to add properties and methods and then implement the abstract - /// GetSortedActionItems method to return an array of DesignerActionItems in the order they are to be displayed. + /// DesignerActionList is the abstract base class which control authors inherit from to create a task sheet. + /// Typical usage is to add properties and methods and then implement the abstract + /// GetSortedActionItems method to return an array of DesignerActionItems in the order they are to be displayed. /// public class DesignerActionList { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventArgs.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventArgs.cs index 2fa23e5eae3..fd285248a80 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. + /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. /// public class DesignerActionListsChangedEventArgs : EventArgs { @@ -16,7 +16,7 @@ public class DesignerActionListsChangedEventArgs : EventArgs private readonly DesignerActionListsChangedType _changeType; //type of change /// - /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object. on the related object. + /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object. on the related object. /// public DesignerActionListsChangedEventArgs(object relatedObject, DesignerActionListsChangedType changeType, DesignerActionListCollection actionLists) { @@ -26,7 +26,7 @@ public DesignerActionListsChangedEventArgs(object relatedObject, DesignerActionL } /// - /// The type of changed that caused the related event to be thrown. + /// The type of changed that caused the related event to be thrown. /// public DesignerActionListsChangedType ChangeType { @@ -34,7 +34,7 @@ public DesignerActionListsChangedType ChangeType } /// - /// The object this change is related to. + /// The object this change is related to. /// public object RelatedObject { @@ -42,7 +42,7 @@ public object RelatedObject } /// - /// The remaining actionlists left for the related object. + /// The remaining actionlists left for the related object. /// public DesignerActionListCollection ActionLists { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventHandler.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventHandler.cs index 0c5e5b1fac0..03f416e5fbe 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.Design { /// - /// This event is thown by the DesignerActionListservice when a shortcut is either added or removed to/from the related object. + /// This event is thown by the DesignerActionListservice when a shortcut is either added or removed to/from the related object. /// [System.Runtime.InteropServices.ComVisible(true)] public delegate void DesignerActionListsChangedEventHandler(object sender, DesignerActionListsChangedEventArgs e); diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedType.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedType.cs index 7d4d4f8d577..c8bac43229a 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedType.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionListsChangedType.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms.Design { /// - /// An enum that defines what time of action happend to the related object's DesignerActionLists collection. + /// An enum that defines what time of action happend to the related object's DesignerActionLists collection. /// [Runtime.InteropServices.ComVisible(true)] public enum DesignerActionListsChangedType { /// - /// Signifies that one or more DesignerActionList was added. + /// Signifies that one or more DesignerActionList was added. /// ActionListsAdded, /// - /// Signifies that one or more DesignerActionList was removed. + /// Signifies that one or more DesignerActionList was removed. /// ActionListsRemoved diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionPanel.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionPanel.cs index 2e7e9e5ac4b..d05688995de 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionPanel.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionPanel.cs @@ -145,7 +145,7 @@ private bool DropDownActive } /// - /// Returns the list of commands that should be filtered by the form that hosts this panel. This is done so that these specific commands will not get passed on to VS, and can instead be handled by the panel itself. + /// Returns the list of commands that should be filtered by the form that hosts this panel. This is done so that these specific commands will not get passed on to VS, and can instead be handled by the panel itself. /// public CommandID[] FilteredCommandIDs { @@ -194,7 +194,7 @@ public CommandID[] FilteredCommandIDs } /// - /// Gets the Line that currently has input focus. + /// Gets the Line that currently has input focus. /// private Line FocusedLine { @@ -261,7 +261,7 @@ public Color LabelForeColor } /// - /// Helper event so that Lines can be notified of this event. + /// Helper event so that Lines can be notified of this event. /// private event EventHandler FormActivated { @@ -270,7 +270,7 @@ private event EventHandler FormActivated } /// - /// Helper event so that Lines can be notified of this event. + /// Helper event so that Lines can be notified of this event. /// private event EventHandler FormDeactivate { @@ -303,7 +303,7 @@ private void AddToCategories(LineInfo lineInfo, ListDictionary categories) } /// - /// Computes the best possible location (in desktop coordinates) to display the panel, given the size of the panel and the position of its anchor + /// Computes the best possible location (in desktop coordinates) to display the panel, given the size of the panel and the position of its anchor /// public static Point ComputePreferredDesktopLocation(Rectangle rectangleAnchor, Size sizePanel, out DockStyle edgeToDock) { @@ -816,10 +816,10 @@ private void ShowError(string errorMessage) } /// - /// Strips out ampersands used for mnemonics so that they don't show up in the rendering. - /// - Convert "&&" to "&" - /// - Convert "&x" to "x" - /// - An ampersand by itself at the end of a string is displayed as-is + /// Strips out ampersands used for mnemonics so that they don't show up in the rendering. + /// - Convert "&&" to "&" + /// - Convert "&x" to "x" + /// - An ampersand by itself at the end of a string is displayed as-is /// private static string StripAmpersands(string s) { @@ -1858,7 +1858,7 @@ private void UpdateValue() } /// - /// Custom label that provides accurate accessibility information and focus abilities. + /// Custom label that provides accurate accessibility information and focus abilities. /// private sealed class EditorLabel : Label { @@ -2410,7 +2410,7 @@ public void DoModalLoop() } /// - /// General purpose method, based on Control.Contains()... Determines whether a given window (specified using native window handle) is a descendant of this control. This catches both contained descendants and 'owned' windows such as modal dialogs. Using window handles rather than Control objects allows it to catch un-managed windows as well. + /// General purpose method, based on Control.Contains()... Determines whether a given window (specified using native window handle) is a descendant of this control. This catches both contained descendants and 'owned' windows such as modal dialogs. Using window handles rather than Control objects allows it to catch un-managed windows as well. /// private bool OwnsWindow(IntPtr hWnd) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIService.cs index 49d59476856..5a46ae40dd1 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIService.cs @@ -26,7 +26,7 @@ internal DesignerActionUIService(IServiceProvider serviceProvider) } /// - /// Disposes all resources and unhooks all events. + /// Disposes all resources and unhooks all events. /// public void Dispose() { @@ -41,7 +41,7 @@ public void Dispose() } /// - /// This event is thrown whenever a request is made to show/hide the ui + /// This event is thrown whenever a request is made to show/hide the ui /// public event DesignerActionUIStateChangeEventHandler DesignerActionUIStateChange { @@ -60,7 +60,7 @@ public void ShowUI(IComponent component) } /// - /// This is a new Helper Method that the service provides to refresh the DesignerActionGlyph as well as DesignerActionPanels. + /// This is a new Helper Method that the service provides to refresh the DesignerActionGlyph as well as DesignerActionPanels. /// public void Refresh(IComponent component) { @@ -68,7 +68,7 @@ public void Refresh(IComponent component) } /// - /// This fires our DesignerActionsChanged event. + /// This fires our DesignerActionsChanged event. /// private void OnDesignerActionUIStateChange(DesignerActionUIStateChangeEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIStateChangeEventArgs.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIStateChangeEventArgs.cs index 87ccda9e5b7..8d09fbfd12e 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIStateChangeEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerActionUIStateChangeEventArgs.cs @@ -5,12 +5,12 @@ namespace System.ComponentModel.Design { /// - /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. + /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. /// public class DesignerActionUIStateChangeEventArgs : EventArgs { /// - /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object on the related object. + /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object on the related object. /// public DesignerActionUIStateChangeEventArgs(object relatedObject, DesignerActionUIStateChangeType changeType) { @@ -19,12 +19,12 @@ public DesignerActionUIStateChangeEventArgs(object relatedObject, DesignerAction } /// - /// The object this change is related to. + /// The object this change is related to. /// public object RelatedObject { get; } /// - /// The type of changed that caused the related event to be thrown. + /// The type of changed that caused the related event to be thrown. /// public DesignerActionUIStateChangeType ChangeType { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerHost.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerHost.cs index e8c1ff060d6..aa4fae2c3c3 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerHost.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/DesignerHost.cs @@ -12,7 +12,7 @@ namespace System.ComponentModel.Design { /// - /// This is the main hosting object. DesignerHost implements services and interfaces specific to the design time IContainer object. The services this class implements are generally non-removable (they work as a unit so removing them would break things). + /// This is the main hosting object. DesignerHost implements services and interfaces specific to the design time IContainer object. The services this class implements are generally non-removable (they work as a unit so removing them would break things). /// internal sealed class DesignerHost : Container, IDesignerLoaderHost2, IDesignerHostTransactionState, IComponentChangeService, IReflect { @@ -114,7 +114,7 @@ bool IDesignerHostTransactionState.IsClosingTransaction } /// - /// Override of Container.Add + /// Override of Container.Add /// public override void Add(IComponent component, string name) { @@ -162,8 +162,8 @@ private void PerformAdd(IComponent component, string name) } /// - /// We support adding to either our main IDesignerHost container or to a private per-site container for nested objects. This code is the stock add code that creates a designer, etc. See Add (above) for an example of how to call this correctly. - /// This method is called before the component is actually added. It returns true if the component can be added to this container or false if the add should not occur (because the component may already be in this container, for example.) It may also throw if adding this component is illegal. + /// We support adding to either our main IDesignerHost container or to a private per-site container for nested objects. This code is the stock add code that creates a designer, etc. See Add (above) for an example of how to call this correctly. + /// This method is called before the component is actually added. It returns true if the component can be added to this container or false if the add should not occur (because the component may already be in this container, for example.) It may also throw if adding this component is illegal. /// internal bool AddToContainerPreProcess(IComponent component, string name, IContainer containerToAddTo) { @@ -212,7 +212,7 @@ internal bool AddToContainerPreProcess(IComponent component, string name, IConta } /// - /// We support adding to either our main IDesignerHost container or to a private per-site container for nested objects. This code is the stock add code that creates a designer, etc. See Add (above) for an example of how to call this correctly. + /// We support adding to either our main IDesignerHost container or to a private per-site container for nested objects. This code is the stock add code that creates a designer, etc. See Add (above) for an example of how to call this correctly. /// internal void AddToContainerPostProcess(IComponent component, string name, IContainer containerToAddTo) { @@ -287,7 +287,7 @@ internal void AddToContainerPostProcess(IComponent component, string name, ICont } /// - /// Called by DesignerSurface to begin loading the designer. + /// Called by DesignerSurface to begin loading the designer. /// internal void BeginLoad(DesignerLoader loader) { @@ -353,7 +353,7 @@ internal void BeginLoad(DesignerLoader loader) } /// - /// Override of CreateSite. We create a custom site here, called Site, which is an inner class of DesignerHost. DesignerSite contains an instance of the designer for the component. + /// Override of CreateSite. We create a custom site here, called Site, which is an inner class of DesignerHost. DesignerSite contains an instance of the designer for the component. /// /// The component to create the site for /// The name of the component. If no name is provided this will fabricate a name for you. @@ -398,7 +398,7 @@ protected override ISite CreateSite(IComponent component, string name) } /// - /// Override of dispose to clean up our state. + /// Override of dispose to clean up our state. /// protected override void Dispose(bool disposing) { @@ -410,7 +410,7 @@ protected override void Dispose(bool disposing) } /// - /// We move all "dispose" functionality to the DisposeHost method. The reason for this is that Dispose is inherited from our container implementation, and we do not want someone disposing the container. That would leave the design surface still alive, but it would kill the host. Instead, DesignSurface always calls DisposeHost, which calls the base version of Dispose to clean out the container. + /// We move all "dispose" functionality to the DisposeHost method. The reason for this is that Dispose is inherited from our container implementation, and we do not want someone disposing the container. That would leave the design surface still alive, but it would kill the host. Instead, DesignSurface always calls DisposeHost, which calls the base version of Dispose to clean out the container. /// internal void DisposeHost() { @@ -460,7 +460,7 @@ internal void DisposeHost() } /// - /// Invokes flush on the designer loader. + /// Invokes flush on the designer loader. /// internal void Flush() { @@ -471,7 +471,7 @@ internal void Flush() } /// - /// Override of Container's GetService method. This just delegates to the parent service provider. + /// Override of Container's GetService method. This just delegates to the parent service provider. /// /// The type of service to retrieve /// An instance of the service. @@ -502,7 +502,7 @@ protected override object GetService(Type service) } /// - /// Called in response to a designer becoming active or inactive. + /// Called in response to a designer becoming active or inactive. /// private void OnActiveDesignerChanged(object sender, ActiveDesignerEventArgs e) { @@ -540,7 +540,7 @@ private void OnActiveDesignerChanged(object sender, ActiveDesignerEventArgs e) } /// - /// Method is called by the site when a component is renamed. + /// Method is called by the site when a component is renamed. /// private void OnComponentRename(IComponent component, string oldName, string newName) { @@ -564,7 +564,7 @@ private void OnComponentRename(IComponent component, string oldName, string newN } /// - /// Method is called when the designer has finished loading. + /// Method is called when the designer has finished loading. /// private void OnLoadComplete(EventArgs e) { @@ -572,7 +572,7 @@ private void OnLoadComplete(EventArgs e) } /// - /// Method is called when the last transaction has closed. + /// Method is called when the last transaction has closed. /// private void OnTransactionClosed(DesignerTransactionCloseEventArgs e) { @@ -580,7 +580,7 @@ private void OnTransactionClosed(DesignerTransactionCloseEventArgs e) } /// - /// Method is called when the last transaction is closing. + /// Method is called when the last transaction is closing. /// private void OnTransactionClosing(DesignerTransactionCloseEventArgs e) { @@ -588,7 +588,7 @@ private void OnTransactionClosing(DesignerTransactionCloseEventArgs e) } /// - /// Method is called when the first transaction has opened. + /// Method is called when the first transaction has opened. /// private void OnTransactionOpened(EventArgs e) { @@ -596,7 +596,7 @@ private void OnTransactionOpened(EventArgs e) } /// - /// Method is called when the first transaction is opening. + /// Method is called when the first transaction is opening. /// private void OnTransactionOpening(EventArgs e) { @@ -604,7 +604,7 @@ private void OnTransactionOpening(EventArgs e) } /// - /// Called to remove a component from its container. + /// Called to remove a component from its container. /// public override void Remove(IComponent component) { @@ -689,7 +689,7 @@ internal void RemoveFromContainerPostProcess(IComponent component, IContainer co } /// - /// Called to unload the design surface. + /// Called to unload the design surface. /// private void Unload() { @@ -798,7 +798,7 @@ private void Unload() } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentAdded event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentAdded event. /// event ComponentEventHandler IComponentChangeService.ComponentAdded { @@ -807,7 +807,7 @@ event ComponentEventHandler IComponentChangeService.ComponentAdded } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentAdding event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentAdding event. /// event ComponentEventHandler IComponentChangeService.ComponentAdding { @@ -816,7 +816,7 @@ event ComponentEventHandler IComponentChangeService.ComponentAdding } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentChanged event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentChanged event. /// event ComponentChangedEventHandler IComponentChangeService.ComponentChanged { @@ -825,7 +825,7 @@ event ComponentChangedEventHandler IComponentChangeService.ComponentChanged } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentChanging event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.ComponentChanging event. /// event ComponentChangingEventHandler IComponentChangeService.ComponentChanging { @@ -834,7 +834,7 @@ event ComponentChangingEventHandler IComponentChangeService.ComponentChanging } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRemoved event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRemoved event. /// event ComponentEventHandler IComponentChangeService.ComponentRemoved { @@ -843,7 +843,7 @@ event ComponentEventHandler IComponentChangeService.ComponentRemoved } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRemoving event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRemoving event. /// event ComponentEventHandler IComponentChangeService.ComponentRemoving { @@ -852,7 +852,7 @@ event ComponentEventHandler IComponentChangeService.ComponentRemoving } /// - /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRename event. + /// Adds an event handler for the System.ComponentModel.Design.IComponentChangeService.OnComponentRename event. /// event ComponentRenameEventHandler IComponentChangeService.ComponentRename { @@ -861,7 +861,7 @@ event ComponentRenameEventHandler IComponentChangeService.ComponentRename } /// - /// Announces to the component change service that a particular component has changed. + /// Announces to the component change service that a particular component has changed. /// void IComponentChangeService.OnComponentChanged(object component, MemberDescriptor member, object oldValue, object newValue) { @@ -872,7 +872,7 @@ void IComponentChangeService.OnComponentChanged(object component, MemberDescript } /// - /// Announces to the component change service that a particular component is changing. + /// Announces to the component change service that a particular component is changing. /// void IComponentChangeService.OnComponentChanging(object component, MemberDescriptor member) { @@ -883,7 +883,7 @@ void IComponentChangeService.OnComponentChanging(object component, MemberDescrip } /// - /// Gets or sets a value indicating whether the designer host is currently loading the document. + /// Gets or sets a value indicating whether the designer host is currently loading the document. /// bool IDesignerHost.Loading { @@ -891,7 +891,7 @@ bool IDesignerHost.Loading } /// - /// Gets a value indicating whether the designer host is currently in a transaction. + /// Gets a value indicating whether the designer host is currently in a transaction. /// bool IDesignerHost.InTransaction { @@ -899,7 +899,7 @@ bool IDesignerHost.InTransaction } /// - /// Gets the container for this designer host. + /// Gets the container for this designer host. /// IContainer IDesignerHost.Container { @@ -907,7 +907,7 @@ IContainer IDesignerHost.Container } /// - /// Gets the instance of the base class used as the base class for the current design. + /// Gets the instance of the base class used as the base class for the current design. /// IComponent IDesignerHost.RootComponent { @@ -915,7 +915,7 @@ IComponent IDesignerHost.RootComponent } /// - /// Gets the fully qualified name of the class that is being designed. + /// Gets the fully qualified name of the class that is being designed. /// string IDesignerHost.RootComponentClassName { @@ -923,7 +923,7 @@ string IDesignerHost.RootComponentClassName } /// - /// Gets the description of the current transaction. + /// Gets the description of the current transaction. /// string IDesignerHost.TransactionDescription { @@ -938,7 +938,7 @@ string IDesignerHost.TransactionDescription } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event EventHandler IDesignerHost.Activated { @@ -947,7 +947,7 @@ event EventHandler IDesignerHost.Activated } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event EventHandler IDesignerHost.Deactivated { @@ -956,7 +956,7 @@ event EventHandler IDesignerHost.Deactivated } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event EventHandler IDesignerHost.LoadComplete { @@ -965,7 +965,7 @@ event EventHandler IDesignerHost.LoadComplete } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event DesignerTransactionCloseEventHandler IDesignerHost.TransactionClosed { @@ -974,7 +974,7 @@ event DesignerTransactionCloseEventHandler IDesignerHost.TransactionClosed } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event DesignerTransactionCloseEventHandler IDesignerHost.TransactionClosing { @@ -983,7 +983,7 @@ event DesignerTransactionCloseEventHandler IDesignerHost.TransactionClosing } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event EventHandler IDesignerHost.TransactionOpened { @@ -992,7 +992,7 @@ event EventHandler IDesignerHost.TransactionOpened } /// - /// Adds an event handler for the event. + /// Adds an event handler for the event. /// event EventHandler IDesignerHost.TransactionOpening { @@ -1001,7 +1001,7 @@ event EventHandler IDesignerHost.TransactionOpening } /// - /// Activates the designer that this host is hosting. + /// Activates the designer that this host is hosting. /// void IDesignerHost.Activate() { @@ -1009,7 +1009,7 @@ void IDesignerHost.Activate() } /// - /// Creates a component of the specified class type. + /// Creates a component of the specified class type. /// IComponent IDesignerHost.CreateComponent(Type componentType) { @@ -1017,7 +1017,7 @@ IComponent IDesignerHost.CreateComponent(Type componentType) } /// - /// Creates a component of the given class type and name and places it into the designer container. + /// Creates a component of the given class type and name and places it into the designer container. /// IComponent IDesignerHost.CreateComponent(Type componentType, string name) { @@ -1077,7 +1077,7 @@ IComponent IDesignerHost.CreateComponent(Type componentType, string name) } /// - /// Lengthy operations that involve multiple components may raise many events. These events may cause other side-effects, such as flicker or performance degradation. When operating on multiple components at one time, or setting multiple properties on a single component, you should encompass these changes inside a transaction. Transactions are used to improve performance and reduce flicker. Slow operations can listen to transaction events and only do work when the transaction completes. + /// Lengthy operations that involve multiple components may raise many events. These events may cause other side-effects, such as flicker or performance degradation. When operating on multiple components at one time, or setting multiple properties on a single component, you should encompass these changes inside a transaction. Transactions are used to improve performance and reduce flicker. Slow operations can listen to transaction events and only do work when the transaction completes. /// DesignerTransaction IDesignerHost.CreateTransaction() { @@ -1085,7 +1085,7 @@ DesignerTransaction IDesignerHost.CreateTransaction() } /// - /// Lengthy operations that involve multiple components may raise many events. These events may cause other side-effects, such as flicker or performance degradation. When operating on multiple components at one time, or setting multiple properties on a single component, you should encompass these changes inside a transaction. Transactions are used to improve performance and reduce flicker. Slow operations can listen to transaction events and only do work when the transaction completes. + /// Lengthy operations that involve multiple components may raise many events. These events may cause other side-effects, such as flicker or performance degradation. When operating on multiple components at one time, or setting multiple properties on a single component, you should encompass these changes inside a transaction. Transactions are used to improve performance and reduce flicker. Slow operations can listen to transaction events and only do work when the transaction completes. /// DesignerTransaction IDesignerHost.CreateTransaction(string description) { @@ -1097,7 +1097,7 @@ DesignerTransaction IDesignerHost.CreateTransaction(string description) } /// - /// Destroys the given component, removing it from the design container. + /// Destroys the given component, removing it from the design container. /// void IDesignerHost.DestroyComponent(IComponent component) { @@ -1147,7 +1147,7 @@ void IDesignerHost.DestroyComponent(IComponent component) } /// - /// Gets the designer instance for the specified component. + /// Gets the designer instance for the specified component. /// IDesigner IDesignerHost.GetDesigner(IComponent component) { @@ -1159,7 +1159,7 @@ IDesigner IDesignerHost.GetDesigner(IComponent component) } /// - /// Gets the type instance for the specified fully qualified type name . + /// Gets the type instance for the specified fully qualified type name . /// Type IDesignerHost.GetType(string typeName) { @@ -1176,7 +1176,7 @@ Type IDesignerHost.GetType(string typeName) } /// - /// This is called by the designer loader to indicate that the load has terminated. If there were errors, they should be passed in the errorCollection as a collection of exceptions (if they are not exceptions the designer loader host may just call ToString on them). If the load was successful then errorCollection should either be null or contain an empty collection. + /// This is called by the designer loader to indicate that the load has terminated. If there were errors, they should be passed in the errorCollection as a collection of exceptions (if they are not exceptions the designer loader host may just call ToString on them). If the load was successful then errorCollection should either be null or contain an empty collection. /// void IDesignerLoaderHost.EndLoad(string rootClassName, bool successful, ICollection errorCollection) { @@ -1283,7 +1283,7 @@ void IDesignerLoaderHost.EndLoad(string rootClassName, bool successful, ICollect } /// - /// This is called by the designer loader when it wishes to reload the design document. The reload will happen immediately so the caller should ensure that it is in a state where BeginLoad may be called again. + /// This is called by the designer loader when it wishes to reload the design document. The reload will happen immediately so the caller should ensure that it is in a state where BeginLoad may be called again. /// void IDesignerLoaderHost.Reload() { @@ -1330,7 +1330,7 @@ bool IDesignerLoaderHost2.CanReloadWithErrors } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr, Binder binder, Type[] types, ParameterModifier[] modifiers) { @@ -1338,7 +1338,7 @@ MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr, Binder bind } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr) { @@ -1346,7 +1346,7 @@ MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// MethodInfo[] IReflect.GetMethods(BindingFlags bindingAttr) { @@ -1354,7 +1354,7 @@ MethodInfo[] IReflect.GetMethods(BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// FieldInfo IReflect.GetField(string name, BindingFlags bindingAttr) { @@ -1362,7 +1362,7 @@ FieldInfo IReflect.GetField(string name, BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// FieldInfo[] IReflect.GetFields(BindingFlags bindingAttr) { @@ -1370,7 +1370,7 @@ FieldInfo[] IReflect.GetFields(BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr) { @@ -1378,7 +1378,7 @@ PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr, Binder binder, Type returnType, Type[] types, ParameterModifier[] modifiers) { @@ -1386,7 +1386,7 @@ PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr, Binder } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// PropertyInfo[] IReflect.GetProperties(BindingFlags bindingAttr) { @@ -1394,7 +1394,7 @@ PropertyInfo[] IReflect.GetProperties(BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// MemberInfo[] IReflect.GetMember(string name, BindingFlags bindingAttr) { @@ -1402,7 +1402,7 @@ MemberInfo[] IReflect.GetMember(string name, BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// MemberInfo[] IReflect.GetMembers(BindingFlags bindingAttr) { @@ -1410,7 +1410,7 @@ MemberInfo[] IReflect.GetMembers(BindingFlags bindingAttr) } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// object IReflect.InvokeMember(string name, BindingFlags invokeAttr, Binder binder, object target, object[] args, ParameterModifier[] modifiers, CultureInfo culture, string[] namedParameters) { @@ -1418,7 +1418,7 @@ object IReflect.InvokeMember(string name, BindingFlags invokeAttr, Binder binder } /// - /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. + /// IReflect implementation to map DesignerHost to IDesignerHost. This helps keep us private. /// Type IReflect.UnderlyingSystemType { @@ -1426,7 +1426,7 @@ Type IReflect.UnderlyingSystemType } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, object serviceInstance) { @@ -1439,7 +1439,7 @@ void IServiceContainer.AddService(Type serviceType, object serviceInstance) } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, object serviceInstance, bool promote) { @@ -1452,7 +1452,7 @@ void IServiceContainer.AddService(Type serviceType, object serviceInstance, bool } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callback) { @@ -1465,7 +1465,7 @@ void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callb } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callback, bool promote) { @@ -1478,7 +1478,7 @@ void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callb } /// - /// Removes the given service type from the service container. + /// Removes the given service type from the service container. /// void IServiceContainer.RemoveService(Type serviceType) { @@ -1491,7 +1491,7 @@ void IServiceContainer.RemoveService(Type serviceType) } /// - /// Removes the given service type from the service container. + /// Removes the given service type from the service container. /// void IServiceContainer.RemoveService(Type serviceType, bool promote) { @@ -1504,7 +1504,7 @@ void IServiceContainer.RemoveService(Type serviceType, bool promote) } /// - /// IServiceProvider implementation. We just delegate to the protected GetService method we are inheriting from our container. + /// IServiceProvider implementation. We just delegate to the protected GetService method we are inheriting from our container. /// object IServiceProvider.GetService(Type serviceType) { @@ -1512,7 +1512,7 @@ object IServiceProvider.GetService(Type serviceType) } /// - /// DesignerHostTransaction is our implementation of the DesignerTransaction abstract class. + /// DesignerHostTransaction is our implementation of the DesignerTransaction abstract class. /// private sealed class DesignerHostTransaction : DesignerTransaction { @@ -1531,7 +1531,7 @@ public DesignerHostTransaction(DesignerHost host, string description) : base(des } /// - /// User code should implement this method to perform the actual work of committing a transaction. + /// User code should implement this method to perform the actual work of committing a transaction. /// protected override void OnCancel() { @@ -1559,7 +1559,7 @@ protected override void OnCancel() } /// - /// User code should implement this method to perform the actual work of committing a transaction. + /// User code should implement this method to perform the actual work of committing a transaction. /// protected override void OnCommit() { @@ -1589,7 +1589,7 @@ protected override void OnCommit() } /// - /// Site is the site we use at design time when we host components. + /// Site is the site we use at design time when we host components. /// internal class Site : ISite, IServiceContainer, IDictionaryService { @@ -1610,7 +1610,7 @@ internal Site(IComponent component, DesignerHost host, string name, Container co } /// - /// Used by the IServiceContainer implementation to return a container-specific service container. + /// Used by the IServiceContainer implementation to return a container-specific service container. /// private IServiceContainer SiteServiceContainer { @@ -1625,7 +1625,7 @@ private IServiceContainer SiteServiceContainer } /// - /// Retrieves the key corresponding to the given value. + /// Retrieves the key corresponding to the given value. /// object IDictionaryService.GetKey(object value) { @@ -1644,7 +1644,7 @@ object IDictionaryService.GetKey(object value) } /// - /// Retrieves the value corresponding to the given key. + /// Retrieves the value corresponding to the given key. /// object IDictionaryService.GetValue(object key) { @@ -1656,7 +1656,7 @@ object IDictionaryService.GetValue(object key) } /// - /// Stores the given key-value pair in an object's site. This key-value pair is stored on a per-object basis, and is a handy place to save additional information about a component. + /// Stores the given key-value pair in an object's site. This key-value pair is stored on a per-object basis, and is a handy place to save additional information about a component. /// void IDictionaryService.SetValue(object key, object value) { @@ -1675,7 +1675,7 @@ void IDictionaryService.SetValue(object key, object value) } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, object serviceInstance) { @@ -1683,7 +1683,7 @@ void IServiceContainer.AddService(Type serviceType, object serviceInstance) } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, object serviceInstance, bool promote) { @@ -1691,7 +1691,7 @@ void IServiceContainer.AddService(Type serviceType, object serviceInstance, bool } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callback) { @@ -1699,7 +1699,7 @@ void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callb } /// - /// Adds the given service to the service container. + /// Adds the given service to the service container. /// void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callback, bool promote) { @@ -1707,7 +1707,7 @@ void IServiceContainer.AddService(Type serviceType, ServiceCreatorCallback callb } /// - /// Removes the given service type from the service container. + /// Removes the given service type from the service container. /// void IServiceContainer.RemoveService(Type serviceType) { @@ -1715,7 +1715,7 @@ void IServiceContainer.RemoveService(Type serviceType) } /// - /// Removes the given service type from the service container. + /// Removes the given service type from the service container. /// void IServiceContainer.RemoveService(Type serviceType, bool promote) { @@ -1723,7 +1723,7 @@ void IServiceContainer.RemoveService(Type serviceType, bool promote) } /// - /// Returns the requested service. + /// Returns the requested service. /// object IServiceProvider.GetService(Type service) { @@ -1758,7 +1758,7 @@ object IServiceProvider.GetService(Type service) } /// - /// The component sited by this component site. + /// The component sited by this component site. /// IComponent ISite.Component { @@ -1766,7 +1766,7 @@ IComponent ISite.Component } /// - /// The container in which the component is sited. + /// The container in which the component is sited. /// IContainer ISite.Container { @@ -1774,7 +1774,7 @@ IContainer ISite.Container } /// - /// Indicates whether the component is in design mode. + /// Indicates whether the component is in design mode. /// bool ISite.DesignMode { @@ -1782,7 +1782,7 @@ bool ISite.DesignMode } /// - /// Indicates whether this Site has been disposed. + /// Indicates whether this Site has been disposed. /// internal bool Disposed { @@ -1799,7 +1799,7 @@ internal bool Disposed } /// - /// The name of the component. + /// The name of the component. /// string ISite.Name { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ExtenderProviderService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ExtenderProviderService.cs index 4a09849052e..7e67bc24bfa 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ExtenderProviderService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ExtenderProviderService.cs @@ -7,9 +7,9 @@ namespace System.ComponentModel.Design { /// - /// The extender provider service actually provides two services: IExtenderProviderService, - /// which allows other objects to add and remove extender providers, and IExtenderListService, - /// which is used by TypeDescriptor to discover the set of extender providers. + /// The extender provider service actually provides two services: IExtenderProviderService, + /// which allows other objects to add and remove extender providers, and IExtenderListService, + /// which is used by TypeDescriptor to discover the set of extender providers. /// internal sealed class ExtenderProviderService : IExtenderProviderService, IExtenderListService { @@ -20,7 +20,7 @@ internal ExtenderProviderService() } /// - /// Gets the set of extender providers for the component. + /// Gets the set of extender providers for the component. /// IExtenderProvider[] IExtenderListService.GetExtenderProviders() { @@ -34,7 +34,7 @@ IExtenderProvider[] IExtenderListService.GetExtenderProviders() } /// - /// Adds an extender provider. + /// Adds an extender provider. /// void IExtenderProviderService.AddExtenderProvider(IExtenderProvider provider) { @@ -57,7 +57,7 @@ void IExtenderProviderService.AddExtenderProvider(IExtenderProvider provider) } /// - /// Removes an extender provider. + /// Removes an extender provider. /// void IExtenderProviderService.RemoveExtenderProvider(IExtenderProvider provider) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/HostDesigntimeLicenseContext.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/HostDesigntimeLicenseContext.cs index 02a41ceb514..dc34b248de0 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/HostDesigntimeLicenseContext.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/HostDesigntimeLicenseContext.cs @@ -5,8 +5,8 @@ namespace System.ComponentModel.Design { /// - /// This class will provide a license context that the LicenseManager can use to get to - /// the design time services, like ITypeResolutionService. + /// This class will provide a license context that the LicenseManager can use to get to + /// the design time services, like ITypeResolutionService. /// internal class HostDesigntimeLicenseContext : DesigntimeLicenseContext { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/IMultitargetHelperService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/IMultitargetHelperService.cs index 5cc8bb232ab..940b20d91dc 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/IMultitargetHelperService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/IMultitargetHelperService.cs @@ -5,12 +5,12 @@ namespace System.ComponentModel.Design { /// - /// Provides multitarget type name resolution services in a design-time environment. + /// Provides multitarget type name resolution services in a design-time environment. /// public interface IMultitargetHelperService { /// - /// To be implemented by a VS component that can get resolve a Type for the target framework and return type.AssemblyQualifiedName. + /// To be implemented by a VS component that can get resolve a Type for the target framework and return type.AssemblyQualifiedName. /// string GetAssemblyQualifiedName(Type type); } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/InheritedPropertyDescriptor.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/InheritedPropertyDescriptor.cs index e41c85ca1cf..8e5e28075a1 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/InheritedPropertyDescriptor.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/InheritedPropertyDescriptor.cs @@ -11,7 +11,7 @@ namespace System.ComponentModel.Design { /// - /// Describes and represents inherited properties in an inherited class. + /// Describes and represents inherited properties in an inherited class. /// internal sealed class InheritedPropertyDescriptor : PropertyDescriptor { @@ -22,7 +22,7 @@ internal sealed class InheritedPropertyDescriptor : PropertyDescriptor private object _originalValue; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public InheritedPropertyDescriptor( PropertyDescriptor propertyDescriptor, object component) : base(propertyDescriptor, new Attribute[] { }) { @@ -111,7 +111,7 @@ internal sealed class InheritedPropertyDescriptor : PropertyDescriptor } /// - /// Gets or sets the type of the component this property descriptor is bound to. + /// Gets or sets the type of the component this property descriptor is bound to. /// public override Type ComponentType { @@ -122,7 +122,7 @@ public override Type ComponentType } /// - /// Gets or sets a value indicating whether this property is read only. + /// Gets or sets a value indicating whether this property is read only. /// public override bool IsReadOnly { @@ -154,7 +154,7 @@ internal PropertyDescriptor PropertyDescriptor } /// - /// Gets or sets the type of the property. + /// Gets or sets the type of the property. /// public override Type PropertyType { @@ -162,7 +162,7 @@ public override Type PropertyType } /// - /// Indicates whether reset will change the value of the component. + /// Indicates whether reset will change the value of the component. /// public override bool CanResetValue(object component) { @@ -209,7 +209,7 @@ private object ClonedDefaultValue(object value) } /// - /// We need to merge in attributes from the wrapped property descriptor here. + /// We need to merge in attributes from the wrapped property descriptor here. /// protected override void FillAttributes(IList attributeList) { @@ -221,7 +221,7 @@ protected override void FillAttributes(IList attributeList) } /// - /// Gets the current value of the property on the component, invoking the getXXX method. + /// Gets the current value of the property on the component, invoking the getXXX method. /// public override object GetValue(object component) { @@ -267,7 +267,7 @@ private void InitInheritedDefaultValue(object component) } /// - /// Resets the default value for this property on the component. + /// Resets the default value for this property on the component. /// public override void ResetValue(object component) { @@ -295,7 +295,7 @@ private void SaveOriginalValue(object value) } /// - /// Sets the value to be the new value of this property on the component by invoking the setXXX method on the component. + /// Sets the value to be the new value of this property on the component by invoking the setXXX method on the component. /// public override void SetValue(object component, object value) { @@ -303,7 +303,7 @@ public override void SetValue(object component, object value) } /// - /// Indicates whether the value of this property needs to be persisted. + /// Indicates whether the value of this property needs to be persisted. /// public override bool ShouldSerializeValue(object component) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventArgs.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventArgs.cs index d0f45bb2d8b..5f728dc1d57 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventArgs.cs @@ -7,12 +7,12 @@ namespace System.ComponentModel.Design { /// - /// Provides additional information for the Loaded event. + /// Provides additional information for the Loaded event. /// public sealed class LoadedEventArgs : EventArgs { /// - /// Creates a new LoadedEventArgs object. + /// Creates a new LoadedEventArgs object. /// public LoadedEventArgs(bool succeeded, ICollection errors) { @@ -21,12 +21,12 @@ public LoadedEventArgs(bool succeeded, ICollection errors) } /// - /// True to indicate the designer load was successful. Even successful loads can have errors, if the errors were not too servere to prevent the designer from loading. + /// True to indicate the designer load was successful. Even successful loads can have errors, if the errors were not too servere to prevent the designer from loading. /// public bool HasSucceeded { get; } /// - /// A collection of errors that occurred while the designer was loading. + /// A collection of errors that occurred while the designer was loading. /// public ICollection Errors { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventHandler.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventHandler.cs index afcca44f685..99c67c99644 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/LoadedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.ComponentModel.Design { /// - /// Represents the method that will handle a Loaded event. + /// Represents the method that will handle a Loaded event. /// public delegate void LoadedEventHandler(object sender, LoadedEventArgs e); } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ReferenceService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ReferenceService.cs index 0c3a16b19d2..24d397114e8 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ReferenceService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/ReferenceService.cs @@ -9,7 +9,7 @@ namespace System.ComponentModel.Design { /// - /// This service allows clients to work with all references on a form, not just the top-level sited components. + /// This service allows clients to work with all references on a form, not just the top-level sited components. /// internal sealed class ReferenceService : IReferenceService, IDisposable { @@ -22,7 +22,7 @@ internal sealed class ReferenceService : IReferenceService, IDisposable private bool _populating; /// - /// Constructs the ReferenceService. + /// Constructs the ReferenceService. /// internal ReferenceService(IServiceProvider provider) { @@ -30,7 +30,7 @@ internal ReferenceService(IServiceProvider provider) } /// - /// Creates an entry for a top-level component and it's children. + /// Creates an entry for a top-level component and it's children. /// private void CreateReferences(IComponent component) { @@ -38,7 +38,7 @@ private void CreateReferences(IComponent component) } /// - /// Recursively creates references for namespaced objects. + /// Recursively creates references for namespaced objects. /// private void CreateReferences(string trailingName, object reference, IComponent sitedComponent) { @@ -59,7 +59,7 @@ private void CreateReferences(string trailingName, object reference, IComponent } /// - /// Demand populates the _references variable. + /// Demand populates the _references variable. /// private void EnsureReferences() { @@ -126,7 +126,7 @@ private void EnsureReferences() } /// - /// Listens for component additions to find all the references it contributes. + /// Listens for component additions to find all the references it contributes. /// private void OnComponentAdded(object sender, ComponentEventArgs cevent) { @@ -147,7 +147,7 @@ private void OnComponentAdded(object sender, ComponentEventArgs cevent) } /// - /// Listens for component removes to delete all the references it holds. + /// Listens for component removes to delete all the references it holds. /// private void OnComponentRemoved(object sender, ComponentEventArgs cevent) { @@ -168,7 +168,7 @@ private void OnComponentRemoved(object sender, ComponentEventArgs cevent) } /// - /// Listens for component removes to delete all the references it holds. + /// Listens for component removes to delete all the references it holds. /// private void OnComponentRename(object sender, ComponentRenameEventArgs cevent) { @@ -183,7 +183,7 @@ private void OnComponentRename(object sender, ComponentRenameEventArgs cevent) } /// - /// Removes all the references that this component owns. + /// Removes all the references that this component owns. /// private void RemoveReferences(IComponent component) { @@ -201,7 +201,7 @@ private void RemoveReferences(IComponent component) } /// - /// Cleanup and detach from our events. + /// Cleanup and detach from our events. /// void IDisposable.Dispose() { @@ -219,7 +219,7 @@ void IDisposable.Dispose() } /// - /// Finds the sited component for a given reference, returning null if not found. + /// Finds the sited component for a given reference, returning null if not found. /// IComponent IReferenceService.GetComponent(object reference) { @@ -240,7 +240,7 @@ IComponent IReferenceService.GetComponent(object reference) } /// - /// Finds name for a given reference, returning null if not found. + /// Finds name for a given reference, returning null if not found. /// string IReferenceService.GetName(object reference) { @@ -262,7 +262,7 @@ string IReferenceService.GetName(object reference) } /// - /// Finds a reference with the given name, returning null if not found. + /// Finds a reference with the given name, returning null if not found. /// object IReferenceService.GetReference(string name) { @@ -283,7 +283,7 @@ object IReferenceService.GetReference(string name) } /// - /// Returns all references available in this designer. + /// Returns all references available in this designer. /// object[] IReferenceService.GetReferences() { @@ -298,7 +298,7 @@ object[] IReferenceService.GetReferences() } /// - /// Returns all references available in this designer that are assignable to the given type. + /// Returns all references available in this designer that are assignable to the given type. /// object[] IReferenceService.GetReferences(Type baseType) { @@ -325,7 +325,7 @@ object[] IReferenceService.GetReferences(Type baseType) } /// - /// The class that holds the information about a reference. + /// The class that holds the information about a reference. /// private sealed class ReferenceHolder { @@ -335,7 +335,7 @@ private sealed class ReferenceHolder private string _fullName; /// - /// Creates a new reference holder. + /// Creates a new reference holder. /// internal ReferenceHolder(string trailingName, object reference, IComponent sitedComponent) { @@ -360,7 +360,7 @@ internal ReferenceHolder(string trailingName, object reference, IComponent sited } /// - /// Resets the name of this reference holder. It will be re-aquired on demand + /// Resets the name of this reference holder. It will be re-aquired on demand /// internal void ResetName() { @@ -368,7 +368,7 @@ internal void ResetName() } /// - /// The name of the reference we are holding. + /// The name of the reference we are holding. /// internal string Name { @@ -406,7 +406,7 @@ internal string Name } /// - /// The reference we are holding. + /// The reference we are holding. /// internal object Reference { @@ -414,7 +414,7 @@ internal object Reference } /// - /// The sited component associated with this reference. + /// The sited component associated with this reference. /// internal IComponent SitedComponent { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SelectionService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SelectionService.cs index 270a4151473..41f18c0d5b8 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SelectionService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SelectionService.cs @@ -11,7 +11,7 @@ namespace System.ComponentModel.Design { /// - /// The selection service handles selection within a form. There is one selection service for each designer host. A selection consists of an array of objects. One objects is designated the "primary" selection. + /// The selection service handles selection within a form. There is one selection service for each designer host. A selection consists of an array of objects. One objects is designated the "primary" selection. /// internal sealed class SelectionService : ISelectionService, IDisposable { @@ -36,7 +36,7 @@ internal sealed class SelectionService : ISelectionService, IDisposable private StatusCommandUI _statusCommandUI; // UI for setting the StatusBar Information.. /// - /// Creates a new selection manager object. The selection manager manages all selection of all designers under the current form file. + /// Creates a new selection manager object. The selection manager manages all selection of all designers under the current form file. /// internal SelectionService(IServiceProvider provider) : base() { @@ -47,7 +47,7 @@ internal SelectionService(IServiceProvider provider) : base() } /// - /// Adds the given selection to our selection list. + /// Adds the given selection to our selection list. /// internal void AddSelection(object sel) { @@ -77,7 +77,7 @@ internal void AddSelection(object sel) } /// - /// Called when our visiblity or batch mode changes. Flushes any pending notifications or updates if possible. + /// Called when our visiblity or batch mode changes. Flushes any pending notifications or updates if possible. /// private void FlushSelectionChanges() { @@ -89,7 +89,7 @@ private void FlushSelectionChanges() } /// - /// Helper function to retrieve services. + /// Helper function to retrieve services. /// private object GetService(Type serviceType) { @@ -101,7 +101,7 @@ private object GetService(Type serviceType) } /// - /// called by the formcore when someone has removed a component. This will remove any selection on the component without disturbing the rest of the selection + /// called by the formcore when someone has removed a component. This will remove any selection on the component without disturbing the rest of the selection /// private void OnComponentRemove(object sender, ComponentEventArgs ce) { @@ -113,7 +113,7 @@ private void OnComponentRemove(object sender, ComponentEventArgs ce) } /// - /// called anytime the selection has changed. We update our UI for the selection, and then we fire a juicy change event. + /// called anytime the selection has changed. We update our UI for the selection, and then we fire a juicy change event. /// private void OnSelectionChanged() { @@ -144,7 +144,7 @@ private void OnSelectionChanged() } /// - /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. + /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. /// private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArgs e) { @@ -156,7 +156,7 @@ private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArg } /// - /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. + /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. /// private void OnTransactionOpened(object sender, EventArgs e) { @@ -169,7 +169,7 @@ internal object PrimarySelection } /// - /// Removes the given selection from the selection list. + /// Removes the given selection from the selection list. /// internal void RemoveSelection(object sel) { @@ -186,7 +186,7 @@ private void ApplicationIdle(object source, EventArgs args) } /// - /// Pushes the help context into the help service for the current set of selected objects. + /// Pushes the help context into the help service for the current set of selected objects. /// private void UpdateHelpKeyword(bool tryLater) { @@ -260,7 +260,7 @@ private void UpdateHelpKeyword(bool tryLater) } /// - /// Disposes the entire selection service. + /// Disposes the entire selection service. /// void IDisposable.Dispose() { @@ -287,7 +287,7 @@ void IDisposable.Dispose() } /// - /// Retrieves the object that is currently the primary selection. The primary selection has a slightly different UI look and is used as a "key" when an operation is to be done on multiple components. + /// Retrieves the object that is currently the primary selection. The primary selection has a slightly different UI look and is used as a "key" when an operation is to be done on multiple components. /// object ISelectionService.PrimarySelection { @@ -303,7 +303,7 @@ object ISelectionService.PrimarySelection } /// - /// Retrieves the count of selected objects. + /// Retrieves the count of selected objects. /// int ISelectionService.SelectionCount { @@ -318,7 +318,7 @@ int ISelectionService.SelectionCount } /// - /// Adds a event handler to the selection service. + /// Adds a event handler to the selection service. /// event EventHandler ISelectionService.SelectionChanged { @@ -327,7 +327,7 @@ event EventHandler ISelectionService.SelectionChanged } /// - /// Occurs whenever the user changes the current list of selected components in the designer. This event is raised before the actual selection changes. + /// Occurs whenever the user changes the current list of selected components in the designer. This event is raised before the actual selection changes. /// event EventHandler ISelectionService.SelectionChanging { @@ -336,7 +336,7 @@ event EventHandler ISelectionService.SelectionChanging } /// - /// Determines if the component is currently selected. This is faster than getting the entire list of selelected components. + /// Determines if the component is currently selected. This is faster than getting the entire list of selelected components. /// bool ISelectionService.GetComponentSelected(object component) { @@ -348,7 +348,7 @@ bool ISelectionService.GetComponentSelected(object component) } /// - /// Retrieves an array of components that are currently part of the user's selection. + /// Retrieves an array of components that are currently part of the user's selection. /// ICollection ISelectionService.GetSelectedComponents() { @@ -363,7 +363,7 @@ ICollection ISelectionService.GetSelectedComponents() } /// - /// Changes the user's current set of selected components to the components in the given array. If the array is null or doesn't contain any components, this will select the top level component in the designer. + /// Changes the user's current set of selected components to the components in the given array. If the array is null or doesn't contain any components, this will select the top level component in the designer. /// void ISelectionService.SetSelectedComponents(ICollection components) { @@ -371,7 +371,7 @@ void ISelectionService.SetSelectedComponents(ICollection components) } /// - /// Changes the user's current set of selected components to the components in the given array. If the array is null or doesn't contain any components, this will select the top level component in the designer. + /// Changes the user's current set of selected components to the components in the given array. If the array is null or doesn't contain any components, this will select the top level component in the designer. /// void ISelectionService.SetSelectedComponents(ICollection components, SelectionTypes selectionType) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomComponentSerializationService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomComponentSerializationService.cs index b04be992219..699706955cb 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomComponentSerializationService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomComponentSerializationService.cs @@ -16,21 +16,21 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This class serializes a set of components or serializable objects into a serialization store. The store can then be deserialized at a later date. CodeDomComponentSerializationService differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object. + /// This class serializes a set of components or serializable objects into a serialization store. The store can then be deserialized at a later date. CodeDomComponentSerializationService differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object. /// public sealed class CodeDomComponentSerializationService : ComponentSerializationService { private readonly IServiceProvider _provider; /// - /// Creates a new CodeDomComponentSerializationService object. + /// Creates a new CodeDomComponentSerializationService object. /// public CodeDomComponentSerializationService() : this(null) { } /// - /// Creates a new CodeDomComponentSerializationService object using the given service provider to resolve services. + /// Creates a new CodeDomComponentSerializationService object using the given service provider to resolve services. /// public CodeDomComponentSerializationService(IServiceProvider provider) { @@ -38,7 +38,7 @@ public CodeDomComponentSerializationService(IServiceProvider provider) } /// - /// This method creates a new SerializationStore. The serialization store can be passed to any of the various Serialize methods to build up serialization state for a group of objects. + /// This method creates a new SerializationStore. The serialization store can be passed to any of the various Serialize methods to build up serialization state for a group of objects. /// public override SerializationStore CreateStore() { @@ -46,7 +46,7 @@ public override SerializationStore CreateStore() } /// - /// This method loads a SerializationStore and from the given stream. This store can then be used to deserialize objects by passing it to the various Deserialize methods. + /// This method loads a SerializationStore and from the given stream. This store can then be used to deserialize objects by passing it to the various Deserialize methods. /// public override SerializationStore LoadStore(Stream stream) { @@ -54,7 +54,7 @@ public override SerializationStore LoadStore(Stream stream) } /// - /// This method serializes the given object to the store. The store can be used to serialize more than one object by calling this method more than once. + /// This method serializes the given object to the store. The store can be used to serialize more than one object by calling this method more than once. /// public override void Serialize(SerializationStore store, object value) { @@ -77,7 +77,7 @@ public override void Serialize(SerializationStore store, object value) } /// - /// This method serializes the given object to the store. The store can be used to serialize more than one object by calling this method more than once. + /// This method serializes the given object to the store. The store can be used to serialize more than one object by calling this method more than once. /// public override void SerializeAbsolute(SerializationStore store, object value) { @@ -100,7 +100,7 @@ public override void SerializeAbsolute(SerializationStore store, object value) } /// - /// This method serializes the given member on the given object. This method can be invoked multiple times for the same object to build up a list of serialized members within the serialization store. The member generally has to be a property or an event. + /// This method serializes the given member on the given object. This method can be invoked multiple times for the same object to build up a list of serialized members within the serialization store. The member generally has to be a property or an event. /// public override void SerializeMember(SerializationStore store, object owningObject, MemberDescriptor member) { @@ -128,8 +128,8 @@ public override void SerializeMember(SerializationStore store, object owningObje } /// - /// This method serializes the given member on the given object, but also serializes the member if it contains the default value. - /// Note that for some members, containing the default value and setting the same value back to the member are different concepts. For example, if a property inherits its value from a parent object if no local value is set, setting the value back to the property can may not be what is desired. SerializeMemberAbsolute takes this into account and would clear the state of the property in this case. + /// This method serializes the given member on the given object, but also serializes the member if it contains the default value. + /// Note that for some members, containing the default value and setting the same value back to the member are different concepts. For example, if a property inherits its value from a parent object if no local value is set, setting the value back to the property can may not be what is desired. SerializeMemberAbsolute takes this into account and would clear the state of the property in this case. /// public override void SerializeMemberAbsolute(SerializationStore store, object owningObject, MemberDescriptor member) { @@ -157,7 +157,7 @@ public override void SerializeMemberAbsolute(SerializationStore store, object ow } /// - /// This method deserializes the given store to produce a collection of objects contained within it. If a container is provided, objects that are created that implement IComponent will be added to the container. + /// This method deserializes the given store to produce a collection of objects contained within it. If a container is provided, objects that are created that implement IComponent will be added to the container. /// public override ICollection Deserialize(SerializationStore store) { @@ -175,7 +175,7 @@ public override ICollection Deserialize(SerializationStore store) } /// - /// This method deserializes the given store to produce a collection of objects contained within it. If a container is provided, objects that are created that implement IComponent will be added to the container. + /// This method deserializes the given store to produce a collection of objects contained within it. If a container is provided, objects that are created that implement IComponent will be added to the container. /// public override ICollection Deserialize(SerializationStore store, IContainer container) { @@ -198,7 +198,7 @@ public override ICollection Deserialize(SerializationStore store, IContainer con } /// - /// This method deserializes the given store, but rather than produce new objects object, the data in the store is applied to an existing set of objects that are taken from the provided container. This allows the caller to pre-create an object however it sees fit. If an object has deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements IComponent, it will be added to the given container. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. + /// This method deserializes the given store, but rather than produce new objects object, the data in the store is applied to an existing set of objects that are taken from the provided container. This allows the caller to pre-create an object however it sees fit. If an object has deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements IComponent, it will be added to the given container. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. /// public override void DeserializeTo(SerializationStore store, IContainer container, bool validateRecycledTypes, bool applyDefaults) { @@ -221,11 +221,11 @@ public override void DeserializeTo(SerializationStore store, IContainer containe } /// - /// The SerializationStore class is an implementation-specific class that stores serialization data for the component serialization service. - /// The service adds state to this serialization store. Once the store is closed it can be saved to a stream. A serialization store can - /// be deserialized at a later date by the same type of serialization service. SerializationStore implements the IDisposable interface such - /// that Dispose simply calls the Close method. Dispose is implemented as a private interface to avoid confusion. - /// The pattern is provided for languages that support a "using" syntax like C# and VB .NET. + /// The SerializationStore class is an implementation-specific class that stores serialization data for the component serialization service. + /// The service adds state to this serialization store. Once the store is closed it can be saved to a stream. A serialization store can + /// be deserialized at a later date by the same type of serialization service. SerializationStore implements the IDisposable interface such + /// that Dispose simply calls the Close method. Dispose is implemented as a private interface to avoid confusion. + /// The pattern is provided for languages that support a "using" syntax like C# and VB .NET. /// private sealed class CodeDomSerializationStore : SerializationStore, ISerializable { @@ -261,7 +261,7 @@ private sealed class CodeDomSerializationStore : SerializationStore, ISerializab private ICollection _errors; /// - /// Creates a new store. + /// Creates a new store. /// internal CodeDomSerializationStore(IServiceProvider provider) { @@ -272,7 +272,7 @@ internal CodeDomSerializationStore(IServiceProvider provider) } /// - /// Nested classes within us access this property to get to our array of saved assembly names. + /// Nested classes within us access this property to get to our array of saved assembly names. /// private AssemblyName[] AssemblyNames { @@ -280,7 +280,7 @@ private AssemblyName[] AssemblyNames } /// - /// If there were errors generated during serialization or deserialization of the store, they will be added to this collection. + /// If there were errors generated during serialization or deserialization of the store, they will be added to this collection. /// public override ICollection Errors { @@ -298,7 +298,7 @@ public override ICollection Errors } /// - /// Nested classes within us access this property to get to our collection of resources. + /// Nested classes within us access this property to get to our collection of resources. /// private LocalResourceManager Resources { @@ -313,7 +313,7 @@ private LocalResourceManager Resources } /// - /// Adds a new member serialization to our list of things to serialize. + /// Adds a new member serialization to our list of things to serialize. /// internal void AddMember(object value, MemberDescriptor member, bool absolute) { @@ -340,7 +340,7 @@ internal void AddMember(object value, MemberDescriptor member, bool absolute) } /// - /// Adds a new object serialization to our list of things to serialize. + /// Adds a new object serialization to our list of things to serialize. /// internal void AddObject(object value, bool absolute) { @@ -368,7 +368,7 @@ internal void AddObject(object value, bool absolute) } /// - /// The Close method closes this store and prevents any objects from being serialized into it. Once closed, the serialization store may be saved. + /// The Close method closes this store and prevents any objects from being serialized into it. Once closed, the serialization store may be saved. /// public override void Close() { @@ -437,7 +437,7 @@ public override void Close() } /// - /// Deserializes the saved bits. + /// Deserializes the saved bits. /// internal ICollection Deserialize(IServiceProvider provider) { @@ -445,7 +445,7 @@ internal ICollection Deserialize(IServiceProvider provider) } /// - /// Deserializes the saved bits. + /// Deserializes the saved bits. /// internal ICollection Deserialize(IServiceProvider provider, IContainer container) { @@ -526,7 +526,7 @@ private ICollection Deserialize(IServiceProvider provider, IContainer container, } /// - /// Deserializes the saved bits. + /// Deserializes the saved bits. /// internal void DeserializeTo(IServiceProvider provider, IContainer container, bool validateRecycledTypes, bool applyDefaults) { @@ -534,7 +534,7 @@ internal void DeserializeTo(IServiceProvider provider, IContainer container, boo } /// - /// Gets a name for this object. It first tries the object's site, if it exists, and otherwise fabricates a unique name. + /// Gets a name for this object. It first tries the object's site, if it exists, and otherwise fabricates a unique name. /// private string GetObjectName(object value) { @@ -561,7 +561,7 @@ private string GetObjectName(object value) } /// - /// Loads our state from a stream. + /// Loads our state from a stream. /// internal static CodeDomSerializationStore Load(Stream stream) { @@ -570,7 +570,7 @@ internal static CodeDomSerializationStore Load(Stream stream) } /// - /// The Save method is not supported. + /// The Save method is not supported. /// public override void Save(Stream stream) { @@ -647,7 +647,7 @@ internal static void TraceCode(string name, object code) #endif /// - /// Implements the save part of ISerializable. Used in unit tests only. + /// Implements the save part of ISerializable. Used in unit tests only. /// void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context) { @@ -664,7 +664,7 @@ void ISerializable.GetObjectData(SerializationInfo info, StreamingContext contex } /// - /// This is a simple code dom serializer that serializes a set of objects as a unit. + /// This is a simple code dom serializer that serializes a set of objects as a unit. /// private class ComponentListCodeDomSerializer : CodeDomSerializer { @@ -711,7 +711,7 @@ private void PopulateCompleteStatements(object data, string name, CodeStatementC } } /// - /// Deserializes the given object state. The results are contained within the serialization manager's name table. The objectNames list is used to deserialize in the proper order, as objectState is unordered. + /// Deserializes the given object state. The results are contained within the serialization manager's name table. The objectNames list is used to deserialize in the proper order, as objectState is unordered. /// internal void Deserialize(IDesignerSerializationManager manager, IDictionary objectState, IList objectNames, bool applyDefaults) { @@ -847,8 +847,8 @@ private void DeserializeDesignTimeProperties(IDesignerSerializationManager manag } /// - /// This is used to resolve nested component references. NestedComponents don't exist as sited components within the DesignerHost, they are actually sited within a parent component. This method takes the FullName defined on INestedSite and returns the component which matches it. outerComponent is the name of the topmost component which does exist in the DesignerHost - /// This code also exists in VSCodeDomDesignerLoader -- please keep them in sync. + /// This is used to resolve nested component references. NestedComponents don't exist as sited components within the DesignerHost, they are actually sited within a parent component. This method takes the FullName defined on INestedSite and returns the component which matches it. outerComponent is the name of the topmost component which does exist in the DesignerHost + /// This code also exists in VSCodeDomDesignerLoader -- please keep them in sync. /// private IComponent ResolveNestedName(IDesignerSerializationManager manager, string name, ref string outerComponent) { @@ -1160,7 +1160,7 @@ internal void SetupVariableReferences(IDesignerSerializationManager manager, ICo } /// - /// Serializes the given set of objects (contained in objectData) into the given object state dictionary. + /// Serializes the given set of objects (contained in objectData) into the given object state dictionary. /// internal void Serialize(IDesignerSerializationManager manager, IDictionary objectData, IDictionary objectState, IList shimObjectNames) { @@ -1367,22 +1367,22 @@ internal void Serialize(IDesignerSerializationManager manager, IDictionary objec } /// - /// We create one of these for each specific member on an object. + /// We create one of these for each specific member on an object. /// private class MemberData { /// - /// The member we're serializing. + /// The member we're serializing. /// internal MemberDescriptor _member; /// - /// True if we should try to serialize values that contain their defaults as well. + /// True if we should try to serialize values that contain their defaults as well. /// internal bool _absolute; /// - /// Creates a new member data ready to be serialized. + /// Creates a new member data ready to be serialized. /// internal MemberData(MemberDescriptor member, bool absolute) { @@ -1392,7 +1392,7 @@ internal MemberData(MemberDescriptor member, bool absolute) } /// - /// We create one of these for each object we process. + /// We create one of these for each object we process. /// private class ObjectData { @@ -1401,17 +1401,17 @@ private class ObjectData private ArrayList _members; /// - /// The object value we're serializing. + /// The object value we're serializing. /// internal object _value; /// - /// The name of the object we're serializing. + /// The name of the object we're serializing. /// internal string _name; /// - /// If true, the entire object should be serialized. If false, only the members in the member list should be serialized. + /// If true, the entire object should be serialized. If false, only the members in the member list should be serialized. /// internal bool EntireObject { @@ -1427,7 +1427,7 @@ internal bool EntireObject } /// - /// If true, the object should be serialized such that during deserialization to an existing object the object is reconstructed entirely. If false, serialize normally + /// If true, the object should be serialized such that during deserialization to an existing object the object is reconstructed entirely. If false, serialize normally /// internal bool Absolute { @@ -1436,7 +1436,7 @@ internal bool Absolute } /// - /// A list of MemberData objects representing specific members that should be serialized. + /// A list of MemberData objects representing specific members that should be serialized. /// internal IList Members { @@ -1452,7 +1452,7 @@ internal IList Members } /// - /// Our private resource manager...it just pushes all the data into a hashtable and then we serialize the hashtable. On deseriaization, the hashtable is rebuilt for us and we have all the data we saved out. + /// Our private resource manager...it just pushes all the data into a hashtable and then we serialize the hashtable. On deseriaization, the hashtable is rebuilt for us and we have all the data we saved out. /// private class LocalResourceManager : ResourceManager, IResourceWriter, IResourceReader { @@ -1492,7 +1492,7 @@ IEnumerator IEnumerable.GetEnumerator() } /// - /// LocalServices contains the services that we add to our serialization manager. We do this, rather than implement interfaces directly on CodeDomSerializationStore to prevent people from assuming what our implementation is (CodeDomSerializationStore is returned publicly as SerializationStore). + /// LocalServices contains the services that we add to our serialization manager. We do this, rather than implement interfaces directly on CodeDomSerializationStore to prevent people from assuming what our implementation is (CodeDomSerializationStore is returned publicly as SerializationStore). /// private class LocalServices : IServiceProvider, IResourceService { @@ -1636,7 +1636,7 @@ object IServiceProvider.GetService(Type serviceType) } /// - /// This is a serialzation manager that can load assemblies and search for types and provide a resource manager from our serialization store. + /// This is a serialzation manager that can load assemblies and search for types and provide a resource manager from our serialization store. /// private class LocalDesignerSerializationManager : DesignerSerializationManager { @@ -1644,7 +1644,7 @@ private class LocalDesignerSerializationManager : DesignerSerializationManager private Nullable _typeSvcAvailable = new Nullable(); /// - /// Creates a new serilalization manager. + /// Creates a new serilalization manager. /// internal LocalDesignerSerializationManager(CodeDomSerializationStore store, IServiceProvider provider) : base(provider) { @@ -1652,7 +1652,7 @@ internal LocalDesignerSerializationManager(CodeDomSerializationStore store, ISer } /// - /// We override CreateInstance here to provide a hook to our resource manager. + /// We override CreateInstance here to provide a hook to our resource manager. /// protected override object CreateInstance(Type type, ICollection arguments, string name, bool addToContainer) { @@ -1676,7 +1676,7 @@ private Nullable TypeResolutionAvailable } /// - /// Override of GetType. We favor the base implementation first, which uses the type resolution service if it is available. If that fails, we will try to load assemblies from the given array of assembly names. + /// Override of GetType. We favor the base implementation first, which uses the type resolution service if it is available. If that fails, we will try to load assemblies from the given array of assembly names. /// protected override Type GetType(string name) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs index 8350e56df74..1f395d982af 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs @@ -50,8 +50,8 @@ protected virtual object DeserializeInstance(IDesignerSerializationManager manag } /// - /// This routine returns the correct typename given a CodeTypeReference. It expands the child typenames - /// and builds up the clr formatted generic name. If its not a generic, it just returns BaseType. + /// This routine returns the correct typename given a CodeTypeReference. It expands the child typenames + /// and builds up the clr formatted generic name. If its not a generic, it just returns BaseType. /// internal static string GetTypeNameFromCodeTypeReference(IDesignerSerializationManager manager, CodeTypeReference typeref) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerException.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerException.cs index 7cbf47a9400..56a1db0ace2 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerException.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerException.cs @@ -8,7 +8,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// The exception that is thrown when the code dom serializer experiences an error. + /// The exception that is thrown when the code dom serializer experiences an error. /// public class CodeDomSerializerException : SystemException { @@ -39,7 +39,7 @@ public CodeDomSerializerException(Exception ex, IDesignerSerializationManager ma } /// - /// Gets the line pragma object that is related to this error. + /// Gets the line pragma object that is related to this error. /// public CodeLinePragma LinePragma { get; } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeMethodMap.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeMethodMap.cs index 1bbd2e82e6e..cc8e2a9b4a1 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeMethodMap.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeMethodMap.cs @@ -7,7 +7,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This structure is used by IntegrateStatements to put statements in the right place. + /// This structure is used by IntegrateStatements to put statements in the right place. /// internal class CodeMethodMap { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CollectionCodeDomSerializer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CollectionCodeDomSerializer.cs index fa860d7b39b..8ed87c7c7f1 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CollectionCodeDomSerializer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CollectionCodeDomSerializer.cs @@ -13,14 +13,14 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This serializer serializes collections. This can either create statements or expressions. It will create an expression and assign it to the statement in the current context stack if the object is an array. If it is a collection with an add range or similar method, it will create a statement calling the method. + /// This serializer serializes collections. This can either create statements or expressions. It will create an expression and assign it to the statement in the current context stack if the object is an array. If it is a collection with an add range or similar method, it will create a statement calling the method. /// public class CollectionCodeDomSerializer : CodeDomSerializer { private static CollectionCodeDomSerializer s_defaultSerializer; /// - /// Retrieves a default static instance of this serializer. + /// Retrieves a default static instance of this serializer. /// internal new static CollectionCodeDomSerializer Default { @@ -35,7 +35,7 @@ public class CollectionCodeDomSerializer : CodeDomSerializer } /// - /// Computes the delta between an existing collection and a modified one. This is for the case of inherited items that have collection properties so we only generate Add/AddRange calls for the items that have been added. It works by Hashing up the items in the original collection and then walking the modified collection and only returning those items which do not exist in the base collection. + /// Computes the delta between an existing collection and a modified one. This is for the case of inherited items that have collection properties so we only generate Add/AddRange calls for the items that have been added. It works by Hashing up the items in the original collection and then walking the modified collection and only returning those items which do not exist in the base collection. /// private ICollection GetCollectionDelta(ICollection original, ICollection modified) { @@ -115,7 +115,7 @@ private ICollection GetCollectionDelta(ICollection original, ICollection modifie } /// - /// Checks the attributes on this method to see if they support serialization. + /// Checks the attributes on this method to see if they support serialization. /// protected bool MethodSupportsSerialization(MethodInfo method) { @@ -139,7 +139,7 @@ protected bool MethodSupportsSerialization(MethodInfo method) } /// - /// Serializes the given object into a CodeDom object. + /// Serializes the given object into a CodeDom object. /// public override object Serialize(IDesignerSerializationManager manager, object value) { @@ -241,7 +241,7 @@ public override object Serialize(IDesignerSerializationManager manager, object v } /// - /// Given a set of methods and objects, determines the method with the correct of parameter type for all objects. + /// Given a set of methods and objects, determines the method with the correct of parameter type for all objects. /// private static MethodInfo ChooseMethodByType(TypeDescriptionProvider provider, List methods, ICollection values) { @@ -303,7 +303,7 @@ private static MethodInfo ChooseMethodByType(TypeDescriptionProvider provider, L } /// - /// Serializes the given collection. targetExpression will refer to the expression used to rever to the collection, but it can be null. + /// Serializes the given collection. targetExpression will refer to the expression used to rever to the collection, but it can be null. /// protected virtual object SerializeCollection(IDesignerSerializationManager manager, CodeExpression targetExpression, Type targetType, ICollection originalCollection, ICollection valuesToSerialize) { @@ -418,7 +418,7 @@ protected virtual object SerializeCollection(IDesignerSerializationManager manag } /// - /// Serializes the given array. + /// Serializes the given array. /// private CodeArrayCreateExpression SerializeArray(IDesignerSerializationManager manager, Type targetType, ICollection array, ICollection valuesToSerialize) { @@ -501,7 +501,7 @@ private CodeArrayCreateExpression SerializeArray(IDesignerSerializationManager m } /// - /// Serializes the given collection by creating multiple calls to an Add method. + /// Serializes the given collection by creating multiple calls to an Add method. /// private object SerializeViaAdd( IDesignerSerializationManager manager, @@ -593,7 +593,7 @@ private object SerializeViaAdd( } /// - /// Serializes the given collection by creating an array and passing it to the AddRange method. + /// Serializes the given collection by creating an array and passing it to the AddRange method. /// private object SerializeViaAddRange( IDesignerSerializationManager manager, @@ -701,7 +701,7 @@ private object SerializeViaAddRange( } /// - /// Returns true if we should clear the collection contents. + /// Returns true if we should clear the collection contents. /// private bool ShouldClearCollection(IDesignerSerializationManager manager, ICollection collection) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ComponentCache.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ComponentCache.cs index bcab393bfa6..c41c3fc23b6 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ComponentCache.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ComponentCache.cs @@ -8,7 +8,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This class is used to cache serialized properties and events of components to speed-up Design to Code view switches + /// This class is used to cache serialized properties and events of components to speed-up Design to Code view switches /// internal class ComponentCache : IDisposable { @@ -50,7 +50,7 @@ internal bool Enabled } /// - /// Access serialized Properties and events for the given component + /// Access serialized Properties and events for the given component /// internal Entry this[object component] { @@ -219,7 +219,7 @@ private void OnComponentRemove(object source, ComponentEventArgs ce) } /// - /// Helper to remove an entry from the cache. + /// Helper to remove an entry from the cache. /// internal void RemoveEntry(object component) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/DesignerSerializationManager.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/DesignerSerializationManager.cs index fb71afd1bcc..c8b5e45180e 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/DesignerSerializationManager.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/DesignerSerializationManager.cs @@ -10,7 +10,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This object is a complete implementation of IDesignerSerializationManager. It can be used to begin the serialization / deserialization process for any serialization scheme that utilizes IDesignerSerializationManager. + /// This object is a complete implementation of IDesignerSerializationManager. It can be used to begin the serialization / deserialization process for any serialization scheme that utilizes IDesignerSerializationManager. /// public class DesignerSerializationManager : IDesignerSerializationManager { @@ -37,7 +37,7 @@ public class DesignerSerializationManager : IDesignerSerializationManager private object propertyProvider; /// - /// Creates a new serialization manager. + /// Creates a new serialization manager. /// public DesignerSerializationManager() { @@ -46,7 +46,7 @@ public DesignerSerializationManager() } /// - /// Creates a new serialization manager. + /// Creates a new serialization manager. /// public DesignerSerializationManager(IServiceProvider provider) { @@ -56,7 +56,7 @@ public DesignerSerializationManager(IServiceProvider provider) } /// - /// Provides access to the container that components will be added to. The default implementation searches for IDesignerHost in the service provider and uses its container if it exists. + /// Provides access to the container that components will be added to. The default implementation searches for IDesignerHost in the service provider and uses its container if it exists. /// public IContainer Container { @@ -79,7 +79,7 @@ public IContainer Container } /// - /// This retrieves the collection of errors that have been reported to the serialization manager. Additionaly, new errors can be added to the list by accessing this property. + /// This retrieves the collection of errors that have been reported to the serialization manager. Additionaly, new errors can be added to the list by accessing this property. /// public IList Errors { @@ -95,7 +95,7 @@ public IList Errors } /// - /// This property determines the behavior of the CreateInstance method. If true, CreateInstance will pass the given component name. If false, CreateInstance will check for the presence of the given name in the container. If it does not exist, it will use the given name. If it does exist, it will pass a null value as the name of a component when adding it to the container, thereby giving it a new name. This second variation is useful for implementing a serializer that always duplicates objects, rather than assuming those objects do not exist. Paste commands often use this type of serializer. The default value of this property is true. + /// This property determines the behavior of the CreateInstance method. If true, CreateInstance will pass the given component name. If false, CreateInstance will check for the presence of the given name in the container. If it does not exist, it will use the given name. If it does exist, it will pass a null value as the name of a component when adding it to the container, thereby giving it a new name. This second variation is useful for implementing a serializer that always duplicates objects, rather than assuming those objects do not exist. Paste commands often use this type of serializer. The default value of this property is true. /// public bool PreserveNames { @@ -108,7 +108,7 @@ public bool PreserveNames } /// - /// This property returns the object that should be used to provide properties to the serialization manager's Propeties property. This object's public properties will be inspected and wrapped in new property descriptors that have a target object of the serialization manager. + /// This property returns the object that should be used to provide properties to the serialization manager's Propeties property. This object's public properties will be inspected and wrapped in new property descriptors that have a target object of the serialization manager. /// public object PropertyProvider { @@ -124,7 +124,7 @@ public object PropertyProvider } /// - /// This property determines the behavior of the CreateInstance method. If false, CreateInstance will always create a new instance of an object. If true, CreateInstance will first search the nametable and container for an object of the same name. If such an object exists and is of the same type, CreateInstance will return the existing object instance. This second variation is useful for implemeting a serializer that applies serialization state to an existing set of objects, rather than always creating a new tree. Undo often uses this type of serializer. The default value of this property is false. + /// This property determines the behavior of the CreateInstance method. If false, CreateInstance will always create a new instance of an object. If true, CreateInstance will first search the nametable and container for an object of the same name. If such an object exists and is of the same type, CreateInstance will return the existing object instance. This second variation is useful for implemeting a serializer that applies serialization state to an existing set of objects, rather than always creating a new tree. Undo often uses this type of serializer. The default value of this property is false. /// public bool RecycleInstances { @@ -137,7 +137,7 @@ public bool RecycleInstances } /// - /// This property determines the behavior of the CreateInstance method and only applies if RecyleInstances is true. If true, and an existing instance is found for the given name, it will only be returned if the two types match. If false, the instance will be returned even if the two types do not match. This is useful for "morphing" one type of object to another if they have similar properties but share no common parent or interface. The default value of this property is true. + /// This property determines the behavior of the CreateInstance method and only applies if RecyleInstances is true. If true, and an existing instance is found for the given name, it will only be returned if the two types match. If false, the instance will be returned even if the two types do not match. This is useful for "morphing" one type of object to another if they have similar properties but share no common parent or interface. The default value of this property is true. /// public bool ValidateRecycledTypes { @@ -150,7 +150,7 @@ public bool ValidateRecycledTypes } /// - /// Event that is raised when a session is created. + /// Event that is raised when a session is created. /// public event EventHandler SessionCreated { @@ -159,7 +159,7 @@ public event EventHandler SessionCreated } /// - /// Event that is raised when a session is disposed. + /// Event that is raised when a session is disposed. /// public event EventHandler SessionDisposed { @@ -168,7 +168,7 @@ public event EventHandler SessionDisposed } /// - /// Used to verify that no session is active. If there is, this method throws. + /// Used to verify that no session is active. If there is, this method throws. /// private void CheckNoSession() { @@ -179,7 +179,7 @@ private void CheckNoSession() } /// - /// Used to verify that there is an open session. If there isn't, this method throws. + /// Used to verify that there is an open session. If there isn't, this method throws. /// private void CheckSession() { @@ -190,7 +190,7 @@ private void CheckSession() } /// - /// Creates an instance of the specified type. The default implementation will create the object. If the object implements IComponent and only requires an empty or IContainer style constructor, this will search for IDesignerHost and create through the host. Otherwise it will use reflection. If addToContainer is true, this will add to the container using this class's Conainer property, using the name provided if it is not null. + /// Creates an instance of the specified type. The default implementation will create the object. If the object implements IComponent and only requires an empty or IContainer style constructor, this will search for IDesignerHost and create through the host. Otherwise it will use reflection. If addToContainer is true, this will add to the container using this class's Conainer property, using the name provided if it is not null. /// protected virtual object CreateInstance(Type type, ICollection arguments, string name, bool addToContainer) { @@ -380,7 +380,7 @@ protected virtual object CreateInstance(Type type, ICollection arguments, string } /// - /// Creates a new serialization session. Most data within the serialization manager is transient and only lives for the life of a serialization session. When a session is disposed, serialization is considered to be complete and this transient state is cleared. This allows a single instance of a serialization manager to be used to serialize multiple object trees. Some state, including the service provider and any custom serialization providers that were added to the serialization manager, span sessions. + /// Creates a new serialization session. Most data within the serialization manager is transient and only lives for the life of a serialization session. When a session is disposed, serialization is considered to be complete and this transient state is cleared. This allows a single instance of a serialization manager to be used to serialize multiple object trees. Some state, including the service provider and any custom serialization providers that were added to the serialization manager, span sessions. /// public IDisposable CreateSession() { @@ -395,7 +395,7 @@ public IDisposable CreateSession() } /// - /// This retrieves the serializer for the given object type. You can request what type of serializer you would like. It is possible for this method to return null if there is no serializer of the requested type. + /// This retrieves the serializer for the given object type. You can request what type of serializer you would like. It is possible for this method to return null if there is no serializer of the requested type. /// public object GetSerializer(Type objectType, Type serializerType) { @@ -500,7 +500,7 @@ public object GetSerializer(Type objectType, Type serializerType) } /// - /// Provides access to the underlying IServiceProvider + /// Provides access to the underlying IServiceProvider /// protected virtual object GetService(Type serviceType) { @@ -517,7 +517,7 @@ protected virtual object GetService(Type serviceType) } /// - /// Retrieves the type for the given name using the type resolution service, if available. + /// Retrieves the type for the given name using the type resolution service, if available. /// protected virtual Type GetType(string typeName) { @@ -537,7 +537,7 @@ protected virtual Type GetType(string typeName) } /// - /// Use this one for Serializer, converter, designer and editor types, types which are only used by the IDE internally + /// Use this one for Serializer, converter, designer and editor types, types which are only used by the IDE internally /// public Type GetRuntimeType(string typeName) { @@ -560,7 +560,7 @@ public Type GetRuntimeType(string typeName) } /// - /// Event that is raised when a name needs to be resolved to an object instance.. + /// Event that is raised when a name needs to be resolved to an object instance.. /// protected virtual void OnResolveName(ResolveNameEventArgs e) { @@ -568,7 +568,7 @@ protected virtual void OnResolveName(ResolveNameEventArgs e) } /// - /// Event that is raised when a session is created. + /// Event that is raised when a session is created. /// protected virtual void OnSessionCreated(EventArgs e) { @@ -576,7 +576,7 @@ protected virtual void OnSessionCreated(EventArgs e) } /// - /// Event that is raised when a session is disposed. + /// Event that is raised when a session is disposed. /// protected virtual void OnSessionDisposed(EventArgs e) { @@ -605,7 +605,7 @@ protected virtual void OnSessionDisposed(EventArgs e) } /// - /// This method takes a property that is owned by the given owner, and it wraps them in new property that is owned by the serialization manager. + /// This method takes a property that is owned by the given owner, and it wraps them in new property that is owned by the serialization manager. /// private PropertyDescriptor WrapProperty(PropertyDescriptor property, object owner) { @@ -618,7 +618,7 @@ private PropertyDescriptor WrapProperty(PropertyDescriptor property, object owne } /// - /// The Context property provides a user-defined storage area implemented as a stack. This storage area is a useful way to provide communication across serializers, as serialization is a generally hierarchial process. + /// The Context property provides a user-defined storage area implemented as a stack. This storage area is a useful way to provide communication across serializers, as serialization is a generally hierarchial process. /// ContextStack IDesignerSerializationManager.Context { @@ -634,7 +634,7 @@ ContextStack IDesignerSerializationManager.Context } /// - /// The Properties property provides a set of custom properties the serialization manager may surface. The set of properties exposed here is defined by the implementor of IDesignerSerializationManager. + /// The Properties property provides a set of custom properties the serialization manager may surface. The set of properties exposed here is defined by the implementor of IDesignerSerializationManager. /// PropertyDescriptorCollection IDesignerSerializationManager.Properties { @@ -665,7 +665,7 @@ PropertyDescriptorCollection IDesignerSerializationManager.Properties } /// - /// ResolveName event. This event is raised when GetName is called, but the name is not found in the serialization manager's name table. It provides a way for a serializer to demand-create an object so the serializer does not have to order object creation by dependency. This delegate is cleared immediately after serialization or deserialization is complete. + /// ResolveName event. This event is raised when GetName is called, but the name is not found in the serialization manager's name table. It provides a way for a serializer to demand-create an object so the serializer does not have to order object creation by dependency. This delegate is cleared immediately after serialization or deserialization is complete. /// event ResolveNameEventHandler IDesignerSerializationManager.ResolveName { @@ -678,7 +678,7 @@ event ResolveNameEventHandler IDesignerSerializationManager.ResolveName } /// - /// This event is raised when serialization or deserialization has been completed. Generally, serialization code should be written to be stateless. Should some sort of state be necessary to maintain, a serializer can listen to this event to know when that state should be cleared. An example of this is if a serializer needs to write to another file, such as a resource file. In this case it would be inefficient to design the serializer to close the file when finished because serialization of an object graph generally requires several serializers. The resource file would be opened and closed many times. Instead, the resource file could be accessed through an object that listened to the SerializationComplete event, and that object could close the resource file at the end of serialization. + /// This event is raised when serialization or deserialization has been completed. Generally, serialization code should be written to be stateless. Should some sort of state be necessary to maintain, a serializer can listen to this event to know when that state should be cleared. An example of this is if a serializer needs to write to another file, such as a resource file. In this case it would be inefficient to design the serializer to close the file when finished because serialization of an object graph generally requires several serializers. The resource file would be opened and closed many times. Instead, the resource file could be accessed through an object that listened to the SerializationComplete event, and that object could close the resource file at the end of serialization. /// event EventHandler IDesignerSerializationManager.SerializationComplete { @@ -691,7 +691,7 @@ event EventHandler IDesignerSerializationManager.SerializationComplete } /// - /// This method adds a custom serialization provider to the serialization manager. A custom serialization provider will get the opportunity to return a serializer for a data type before the serialization manager looks in the type's metadata. + /// This method adds a custom serialization provider to the serialization manager. A custom serialization provider will get the opportunity to return a serializer for a data type before the serialization manager looks in the type's metadata. /// void IDesignerSerializationManager.AddSerializationProvider(IDesignerSerializationProvider provider) { @@ -706,7 +706,7 @@ void IDesignerSerializationManager.AddSerializationProvider(IDesignerSerializati } /// - /// Creates an instance of the given type and adds it to a collection of named instances. Objects that implement IComponent will be added to the design time container if addToContainer is true. + /// Creates an instance of the given type and adds it to a collection of named instances. Objects that implement IComponent will be added to the design time container if addToContainer is true. /// object IDesignerSerializationManager.CreateInstance(Type type, ICollection arguments, string name, bool addToContainer) { @@ -742,7 +742,7 @@ object IDesignerSerializationManager.CreateInstance(Type type, ICollection argum } /// - /// Retrieves an instance of a created object of the given name, or null if that object does not exist. + /// Retrieves an instance of a created object of the given name, or null if that object does not exist. /// object IDesignerSerializationManager.GetInstance(string name) { @@ -774,7 +774,7 @@ object IDesignerSerializationManager.GetInstance(string name) } /// - /// Retrieves a name for the specified object, or null if the object has no name. + /// Retrieves a name for the specified object, or null if the object has no name. /// string IDesignerSerializationManager.GetName(object value) { @@ -810,7 +810,7 @@ string IDesignerSerializationManager.GetName(object value) } /// - /// Retrieves a serializer of the requested type for the given object type. + /// Retrieves a serializer of the requested type for the given object type. /// object IDesignerSerializationManager.GetSerializer(Type objectType, Type serializerType) { @@ -818,7 +818,7 @@ object IDesignerSerializationManager.GetSerializer(Type objectType, Type seriali } /// - /// Retrieves a type of the given name. + /// Retrieves a type of the given name. /// Type IDesignerSerializationManager.GetType(string typeName) { @@ -846,7 +846,7 @@ Type IDesignerSerializationManager.GetType(string typeName) } /// - /// Removes a previously added serialization provider. + /// Removes a previously added serialization provider. /// void IDesignerSerializationManager.RemoveSerializationProvider(IDesignerSerializationProvider provider) { @@ -857,7 +857,7 @@ void IDesignerSerializationManager.RemoveSerializationProvider(IDesignerSerializ } /// - /// Reports a non-fatal error in serialization. The serialization manager may implement a logging scheme to alert the caller to all non-fatal errors at once. If it doesn't, it should immediately throw in this method, which should abort serialization. Serialization may continue after calling this function. + /// Reports a non-fatal error in serialization. The serialization manager may implement a logging scheme to alert the caller to all non-fatal errors at once. If it doesn't, it should immediately throw in this method, which should abort serialization. Serialization may continue after calling this function. /// void IDesignerSerializationManager.ReportError(object errorInformation) { @@ -874,7 +874,7 @@ internal ArrayList SerializationProviders } /// - /// Provides a way to set the name of an existing object. This is useful when it is necessary to create an instance of an object without going through CreateInstance. An exception will be thrown if you try to rename an existing object or if you try to give a new object a name that is already taken. + /// Provides a way to set the name of an existing object. This is useful when it is necessary to create an instance of an object without going through CreateInstance. An exception will be thrown if you try to rename an existing object or if you try to give a new object a name that is already taken. /// void IDesignerSerializationManager.SetName(object instance, string name) { @@ -909,7 +909,7 @@ void IDesignerSerializationManager.SetName(object instance, string name) } /// - /// IServiceProvider implementation. + /// IServiceProvider implementation. /// object IServiceProvider.GetService(Type serviceType) { @@ -917,7 +917,7 @@ object IServiceProvider.GetService(Type serviceType) } /// - /// Session object that implements IDisposable. + /// Session object that implements IDisposable. /// private sealed class SerializationSession : IDisposable { @@ -935,7 +935,7 @@ public void Dispose() } /// - /// A key comparer that can be passed to a hash table to use object reference identity as the key comparision. + /// A key comparer that can be passed to a hash table to use object reference identity as the key comparision. /// private sealed class ReferenceComparer : IEqualityComparer { @@ -955,7 +955,7 @@ int IEqualityComparer.GetHashCode(object x) } /// - /// Wrapped property descriptor. Takes the given property and wraps it in a new one that can take the designer serialization manager as a target. + /// Wrapped property descriptor. Takes the given property and wraps it in a new one that can take the designer serialization manager as a target. /// private sealed class WrappedPropertyDescriptor : PropertyDescriptor { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionContext.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionContext.cs index 051de753676..1cc04d86cbd 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionContext.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionContext.cs @@ -8,11 +8,11 @@ namespace System.ComponentModel.Design.Serialization { /// - /// An expression context is an object that is placed on the context stack and contains the most relevant expression during serialization. For example, take the following statement: - /// button1.Text = "Hello"; - /// During serialization several serializers will be responsible for creating this single statement. One of those serializers will be responsible for writing "Hello". There are times when that serializer may need to know the context in which it is creating its expression. In the above example, this isn't needed, but take this slightly modified example: - /// button1.Text = rm.GetString("button1_Text"); - /// Here, the serializer responsible for writing the resource expression needs to know the names of the target objects. The ExpressionContext class can be used for this. As each serializer creates an expression and invokes a serializer to handle a smaller part of the statement as a whole, the serializer pushes an expression context on the context stack. Each expression context has a parent property that locates the next expression context on the stack, which provides a way for easy traversal. + /// An expression context is an object that is placed on the context stack and contains the most relevant expression during serialization. For example, take the following statement: + /// button1.Text = "Hello"; + /// During serialization several serializers will be responsible for creating this single statement. One of those serializers will be responsible for writing "Hello". There are times when that serializer may need to know the context in which it is creating its expression. In the above example, this isn't needed, but take this slightly modified example: + /// button1.Text = rm.GetString("button1_Text"); + /// Here, the serializer responsible for writing the resource expression needs to know the names of the target objects. The ExpressionContext class can be used for this. As each serializer creates an expression and invokes a serializer to handle a smaller part of the statement as a whole, the serializer pushes an expression context on the context stack. Each expression context has a parent property that locates the next expression context on the stack, which provides a way for easy traversal. /// public sealed class ExpressionContext { @@ -29,43 +29,43 @@ public ExpressionContext(CodeExpression expression, Type expressionType, object } /// - /// The expression this context represents. + /// The expression this context represents. /// public CodeExpression Expression { get; } /// - /// The type of the expression. This can be used to determine if a - /// cast is needed when assigning to the expression. + /// The type of the expression. This can be used to determine if a + /// cast is needed when assigning to the expression. /// public Type ExpressionType { get; } /// - /// The object owning this expression. For example, if the expression - /// was a property reference to button1's Text property, Owner would - /// return button1. + /// The object owning this expression. For example, if the expression + /// was a property reference to button1's Text property, Owner would + /// return button1. /// public object Owner { get; } /// - /// Contains the preset value of an expression, should one exist. - /// For example, if the expression is a property reference expression - /// referring to the Controls property of a button, PresetValue will - /// contain the instance of Controls property because the property is - /// read-only and preset by the object to contain a value. On the other - /// hand, a property such as Text or Visible does not have a preset - /// value and therefore the PresetValue property will return null. - /// Serializers can use this information to guide serialization. - /// For example, take the following two snippts of code: - /// Padding p = new Padding(); - /// p.Left = 5; - /// button1.Padding = p; - /// button1.Padding.Left = 5; - /// The serializer of the Padding class needs to know if it should - /// generate the first or second form. The first form would be - /// generated by default. The second form will only be generated - /// if there is an ExpressionContext on the stack that contains a - /// PresetValue equal to the value of the Padding object currently - /// being serialized. + /// Contains the preset value of an expression, should one exist. + /// For example, if the expression is a property reference expression + /// referring to the Controls property of a button, PresetValue will + /// contain the instance of Controls property because the property is + /// read-only and preset by the object to contain a value. On the other + /// hand, a property such as Text or Visible does not have a preset + /// value and therefore the PresetValue property will return null. + /// Serializers can use this information to guide serialization. + /// For example, take the following two snippts of code: + /// Padding p = new Padding(); + /// p.Left = 5; + /// button1.Padding = p; + /// button1.Padding.Left = 5; + /// The serializer of the Padding class needs to know if it should + /// generate the first or second form. The first form would be + /// generated by default. The second form will only be generated + /// if there is an ExpressionContext on the stack that contains a + /// PresetValue equal to the value of the Padding object currently + /// being serialized. /// public object PresetValue { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionTable.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionTable.cs index c56fbc81551..992ccc71bca 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionTable.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ExpressionTable.cs @@ -8,7 +8,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// An expression table allows a lookup from expression to object and object to expression. It is similar to the serialization manager's GetName and GetInstance methods, only with rich code expressions. + /// An expression table allows a lookup from expression to object and object to expression. It is similar to the serialization manager's GetName and GetInstance methods, only with rich code expressions. /// internal sealed class ExpressionTable { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/MemberCodeDomSerializer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/MemberCodeDomSerializer.cs index 9eee94c2a4b..09ae1a3149a 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/MemberCodeDomSerializer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/MemberCodeDomSerializer.cs @@ -11,12 +11,12 @@ namespace System.ComponentModel.Design.Serialization public abstract class MemberCodeDomSerializer : CodeDomSerializerBase { /// - /// This method actually performs the serialization. When the member is serialized the necessary statements will be added to the statements collection. + /// This method actually performs the serialization. When the member is serialized the necessary statements will be added to the statements collection. /// public abstract void Serialize(IDesignerSerializationManager manager, object value, MemberDescriptor descriptor, CodeStatementCollection statements); /// - /// This method returns true if the given member descriptor should be serialized, or false if there is no need to serialize the member. + /// This method returns true if the given member descriptor should be serialized, or false if there is no need to serialize the member. /// public abstract bool ShouldSerialize(IDesignerSerializationManager manager, object value, MemberDescriptor descriptor); } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ResourceCodeDomSerializer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ResourceCodeDomSerializer.cs index e5efe6d36bf..af438286433 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ResourceCodeDomSerializer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/ResourceCodeDomSerializer.cs @@ -13,15 +13,15 @@ namespace System.ComponentModel.Design.Serialization { /// - /// Code model serializer for resource managers. This is called in one of two ways. On Deserialization, we are associated with a ResourceManager object. Instead of creating a ResourceManager, however, we create an object called a SerializationResourceManager. This class inherits from ResourceManager, but overrides all of the methods. Instead of letting resource manager maintain resource sets, it uses the designer host's IResourceService for this purpose. - /// During serialization, this class will also create a SerializationResourceManager. This will be added to the serialization manager as a service so other resource serializers can get at it. SerializationResourceManager has additional methods on it to support writing data into the resource streams for various cultures. + /// Code model serializer for resource managers. This is called in one of two ways. On Deserialization, we are associated with a ResourceManager object. Instead of creating a ResourceManager, however, we create an object called a SerializationResourceManager. This class inherits from ResourceManager, but overrides all of the methods. Instead of letting resource manager maintain resource sets, it uses the designer host's IResourceService for this purpose. + /// During serialization, this class will also create a SerializationResourceManager. This will be added to the serialization manager as a service so other resource serializers can get at it. SerializationResourceManager has additional methods on it to support writing data into the resource streams for various cultures. /// internal class ResourceCodeDomSerializer : CodeDomSerializer { private static ResourceCodeDomSerializer s_defaultSerializer; /// - /// Retrieves a default static instance of this serializer. + /// Retrieves a default static instance of this serializer. /// internal new static ResourceCodeDomSerializer Default { @@ -67,7 +67,7 @@ public override string GetTargetComponentName(CodeStatement statement, CodeExpre } /// - /// This is the name of the resource manager object we declare on the component surface. + /// This is the name of the resource manager object we declare on the component surface. /// private string ResourceManagerName { @@ -75,7 +75,7 @@ private string ResourceManagerName } /// - /// Deserilizes the given CodeDom object into a real object. This will use the serialization manager to create objects and resolve data types. The root of the object graph is returned. + /// Deserilizes the given CodeDom object into a real object. This will use the serialization manager to create objects and resolve data types. The root of the object graph is returned. /// public override object Deserialize(IDesignerSerializationManager manager, object codeObject) { @@ -150,7 +150,7 @@ private SerializationResourceManager CreateResourceManager(IDesignerSerializatio } /// - /// This method is invoked during deserialization to obtain an instance of an object. When this is called, an instance of the requested type should be returned. Our implementation provides a design time resource manager. + /// This method is invoked during deserialization to obtain an instance of an object. When this is called, an instance of the requested type should be returned. Our implementation provides a design time resource manager. /// protected override object DeserializeInstance(IDesignerSerializationManager manager, Type type, object[] parameters, string name, bool addToContainer) { @@ -175,7 +175,7 @@ protected override object DeserializeInstance(IDesignerSerializationManager mana } /// - /// Deserilizes the given CodeDom object into a real object. This will use the serialization manager to create objects and resolve data types. It uses the invariant resource blob to obtain resources. + /// Deserilizes the given CodeDom object into a real object. This will use the serialization manager to create objects and resolve data types. It uses the invariant resource blob to obtain resources. /// public object DeserializeInvariant(IDesignerSerializationManager manager, string resourceName) { @@ -184,7 +184,7 @@ public object DeserializeInvariant(IDesignerSerializationManager manager, string } /// - /// Try to discover the data type we should apply a cast for. To do this, we first search the context stack for an ExpressionContext to decrypt, and if we fail that we try the actual object. If we can't find a cast type we return null. + /// Try to discover the data type we should apply a cast for. To do this, we first search the context stack for an ExpressionContext to decrypt, and if we fail that we try the actual object. If we can't find a cast type we return null. /// private Type GetCastType(IDesignerSerializationManager manager, object value) { @@ -211,7 +211,7 @@ private Type GetCastType(IDesignerSerializationManager manager, object value) } /// - /// Retrieves a dictionary enumerator for the requested culture, or null if no resources for that culture exist. + /// Retrieves a dictionary enumerator for the requested culture, or null if no resources for that culture exist. /// public IDictionaryEnumerator GetEnumerator(IDesignerSerializationManager manager, CultureInfo culture) { @@ -220,7 +220,7 @@ public IDictionaryEnumerator GetEnumerator(IDesignerSerializationManager manager } /// - /// Retrieves a dictionary enumerator for the requested culture, or null if no resources for that culture exist. + /// Retrieves a dictionary enumerator for the requested culture, or null if no resources for that culture exist. /// public IDictionaryEnumerator GetMetadataEnumerator(IDesignerSerializationManager manager) { @@ -229,7 +229,7 @@ public IDictionaryEnumerator GetMetadataEnumerator(IDesignerSerializationManager } /// - /// Demand creates the serialization resource manager. Stores the manager as an appended context value. + /// Demand creates the serialization resource manager. Stores the manager as an appended context value. /// private SerializationResourceManager GetResourceManager(IDesignerSerializationManager manager) { @@ -242,9 +242,9 @@ private SerializationResourceManager GetResourceManager(IDesignerSerializationMa } /// - /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: - /// A CodeStatementCollection that we can add our resource declaration to, if necessary. - /// An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. + /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: + /// A CodeStatementCollection that we can add our resource declaration to, if necessary. + /// An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. /// public override object Serialize(IDesignerSerializationManager manager, object value) { @@ -252,7 +252,7 @@ public override object Serialize(IDesignerSerializationManager manager, object v } /// - /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. + /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. /// public object Serialize(IDesignerSerializationManager manager, object value, bool shouldSerializeInvariant) { @@ -260,7 +260,7 @@ public object Serialize(IDesignerSerializationManager manager, object value, boo } /// - /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. + /// Serializes the given object into a CodeDom object. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. /// public object Serialize(IDesignerSerializationManager manager, object value, bool shouldSerializeInvariant, bool ensureInvariant) { @@ -268,7 +268,7 @@ public object Serialize(IDesignerSerializationManager manager, object value, boo } /// - /// This performs the actual work of serialization between Serialize and SerializeInvariant. + /// This performs the actual work of serialization between Serialize and SerializeInvariant. /// private object Serialize(IDesignerSerializationManager manager, object value, bool forceInvariant, bool shouldSerializeInvariant, bool ensureInvariant) { @@ -369,8 +369,8 @@ private object Serialize(IDesignerSerializationManager manager, object value, bo } /// - /// Serializes the given object into a CodeDom object saving resources in the invariant culture, rather than the current culture. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. - /// An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. + /// Serializes the given object into a CodeDom object saving resources in the invariant culture, rather than the current culture. This expects the following values to be available on the context stack: A CodeStatementCollection that we can add our resource declaration to, if necessary. + /// An ExpressionContext that contains the property, field or method that is being serialized, along with the object being serialized. We need this so we can create a unique resource name for the object. /// public object SerializeInvariant(IDesignerSerializationManager manager, object value, bool shouldSerializeValue) { @@ -378,7 +378,7 @@ public object SerializeInvariant(IDesignerSerializationManager manager, object v } /// - /// Writes out the given metadata. + /// Writes out the given metadata. /// public void SerializeMetadata(IDesignerSerializationManager manager, string name, object value, bool shouldSerializeValue) { @@ -392,7 +392,7 @@ public void SerializeMetadata(IDesignerSerializationManager manager, string name } /// - /// Serializes the given resource value into the resource set. This does not effect the code dom values. The resource is written into the current culture. + /// Serializes the given resource value into the resource set. This does not effect the code dom values. The resource is written into the current culture. /// public void WriteResource(IDesignerSerializationManager manager, string name, object value) { @@ -400,7 +400,7 @@ public void WriteResource(IDesignerSerializationManager manager, string name, ob } /// - /// Serializes the given resource value into the resource set. This does not effect the code dom values. The resource is written into the invariant culture. + /// Serializes the given resource value into the resource set. This does not effect the code dom values. The resource is written into the invariant culture. /// public void WriteResourceInvariant(IDesignerSerializationManager manager, string name, object value) { @@ -420,7 +420,7 @@ private void SetValueUsingCommonTraceScope(IDesignerSerializationManager manager } /// - /// This is called by the component code dom serializer's caching logic to save cached resource data back into the resx files. + /// This is called by the component code dom serializer's caching logic to save cached resource data back into the resx files. /// internal void ApplyCacheEntry(IDesignerSerializationManager manager, ComponentCache.Entry entry) { @@ -455,7 +455,7 @@ internal void ApplyCacheEntry(IDesignerSerializationManager manager, ComponentCa } /// - /// This is the meat of resource serialization. This implements a resource manager through a host-provided IResourceService interface. The resource service feeds us with resource readers and writers, and we simulate a runtime ResourceManager. There is one instance of this object for the entire serialization process, just like there is one resource manager in runtime code. When an instance of this object is created, it adds itself to the serialization manager's service list, and listens for the SerializationComplete event. When serialization is complete, this will close and flush any readers or writers it may have opened and will also remove itself from the service list. + /// This is the meat of resource serialization. This implements a resource manager through a host-provided IResourceService interface. The resource service feeds us with resource readers and writers, and we simulate a runtime ResourceManager. There is one instance of this object for the entire serialization process, just like there is one resource manager in runtime code. When an instance of this object is created, it adds itself to the serialization manager's service list, and listens for the SerializationComplete event. When serialization is complete, this will close and flush any readers or writers it may have opened and will also remove itself from the service list. /// internal class SerializationResourceManager : ComponentResourceManager { @@ -483,17 +483,17 @@ public SerializationResourceManager(IDesignerSerializationManager manager) } /// - /// State the serializers use to determine if the declaration of this resource manager has been performed. This is just per-document state we keep; we do not actually care about this value. + /// State the serializers use to determine if the declaration of this resource manager has been performed. This is just per-document state we keep; we do not actually care about this value. /// public bool DeclarationAdded { get; set; } = false; /// - /// When a declaration is added, we also setup an expression other serializers can use to reference our resource declaration. This bit tracks if we have setup this expression yet. Note that the expression and declaration may be added at diffrerent times, if the declaration was added by a cached component. + /// When a declaration is added, we also setup an expression other serializers can use to reference our resource declaration. This bit tracks if we have setup this expression yet. Note that the expression and declaration may be added at diffrerent times, if the declaration was added by a cached component. /// public bool ExpressionAdded { get; set; } = false; /// - /// The language we should be localizing into. + /// The language we should be localizing into. /// private CultureInfo LocalizationLanguage { @@ -518,7 +518,7 @@ private CultureInfo LocalizationLanguage } /// - /// This is the culture info we should use to read and write resources. We always write using the same culture we read with so we don't stomp on data. + /// This is the culture info we should use to read and write resources. We always write using the same culture we read with so we don't stomp on data. /// private CultureInfo ReadCulture { @@ -541,7 +541,7 @@ private CultureInfo ReadCulture } /// - /// Returns a hash table where we shove resource sets. + /// Returns a hash table where we shove resource sets. /// private Hashtable ResourceTable { @@ -556,7 +556,7 @@ private Hashtable ResourceTable } /// - /// Retrieves the root component we're designing. + /// Retrieves the root component we're designing. /// private object RootComponent { @@ -574,7 +574,7 @@ private object RootComponent } /// - /// Retrieves a resource writer we should write into. + /// Retrieves a resource writer we should write into. /// private IResourceWriter Writer { @@ -601,7 +601,7 @@ private IResourceWriter Writer } /// - /// The component serializer supports caching serialized outputs for speed. It holds both a collection of statements as well as an opaque blob for resources. This function adds data to that blob. The parameters to this function are the same as those to SetValue, or SetMetadata (when isMetadata is true). + /// The component serializer supports caching serialized outputs for speed. It holds both a collection of statements as well as an opaque blob for resources. This function adds data to that blob. The parameters to this function are the same as those to SetValue, or SetMetadata (when isMetadata is true). /// private void AddCacheEntry(IDesignerSerializationManager manager, string name, object value, bool isMetadata, bool forceInvariant, bool shouldSerializeValue, bool ensureInvariant) { @@ -630,7 +630,7 @@ private void AddCacheEntry(IDesignerSerializationManager manager, string name, o } /// - /// Returns true if the caller should add a property fill statement for the given object. A property fill is required for the component only once, so this remembers the value. + /// Returns true if the caller should add a property fill statement for the given object. A property fill is required for the component only once, so this remembers the value. /// public bool AddPropertyFill(object value) { @@ -651,7 +651,7 @@ public bool AddPropertyFill(object value) } /// - /// This method examines all the resources for the provided culture. When it finds a resource with a key in the format of "[objectName].[property name]" it will apply that resources value to the corresponding property on the object. + /// This method examines all the resources for the provided culture. When it finds a resource with a key in the format of "[objectName].[property name]" it will apply that resources value to the corresponding property on the object. /// public override void ApplyResources(object value, string objectName, CultureInfo culture) { @@ -677,7 +677,7 @@ public override void ApplyResources(object value, string objectName, CultureInfo } /// - /// This determines if the given resource name/value pair can be retrieved from a parent culture. We don't want to write duplicate resources for each language, so we do a check of the parent culture. + /// This determines if the given resource name/value pair can be retrieved from a parent culture. We don't want to write duplicate resources for each language, so we do a check of the parent culture. /// private CompareValue CompareWithParentValue(string name, object value) { @@ -726,7 +726,7 @@ private CompareValue CompareWithParentValue(string name, object value) } /// - /// Creates a resource set hashtable for the given resource reader. + /// Creates a resource set hashtable for the given resource reader. /// private Hashtable CreateResourceSet(IResourceReader reader, CultureInfo culture) { @@ -771,7 +771,7 @@ private Hashtable CreateResourceSet(IResourceReader reader, CultureInfo culture) } /// - /// This returns a dictionary enumerator for metadata on the invariant culture. If no metadata can be found this will return null.. + /// This returns a dictionary enumerator for metadata on the invariant culture. If no metadata can be found this will return null.. /// public IDictionaryEnumerator GetMetadataEnumerator() { @@ -803,7 +803,7 @@ public IDictionaryEnumerator GetMetadataEnumerator() } /// - /// This returns a dictionary enumerator for the given culture. If no such resource file exists for the culture this will return null. + /// This returns a dictionary enumerator for the given culture. If no such resource file exists for the culture this will return null. /// public IDictionaryEnumerator GetEnumerator(CultureInfo culture) { @@ -817,7 +817,7 @@ public IDictionaryEnumerator GetEnumerator(CultureInfo culture) } /// - /// Loads the metadata table + /// Loads the metadata table /// private Hashtable GetMetadata() { @@ -852,7 +852,7 @@ private Hashtable GetMetadata() } /// - /// Overrides ResourceManager.GetObject to return the requested object. Returns null if the object couldn't be found. + /// Overrides ResourceManager.GetObject to return the requested object. Returns null if the object couldn't be found. /// public override object GetObject(string resourceName) { @@ -860,7 +860,7 @@ public override object GetObject(string resourceName) } /// - /// Retrieves the object of the given name from our resource bundle. If forceInvariant is true, this will always use the invariant resource, rather than using the current language. Returns null if the object couldn't be found. + /// Retrieves the object of the given name from our resource bundle. If forceInvariant is true, this will always use the invariant resource, rather than using the current language. Returns null if the object couldn't be found. /// public object GetObject(string resourceName, bool forceInvariant) { @@ -897,7 +897,7 @@ public object GetObject(string resourceName, bool forceInvariant) } /// - /// Looks up the resource set in the resourceSets hash table, loading the set if it hasn't been loaded already. Returns null if no resource that exists for that culture. + /// Looks up the resource set in the resourceSets hash table, loading the set if it hasn't been loaded already. Returns null if no resource that exists for that culture. /// private Hashtable GetResourceSet(CultureInfo culture) { @@ -952,7 +952,7 @@ private Hashtable GetResourceSet(CultureInfo culture) } /// - /// Override of GetResourceSet from ResourceManager. + /// Override of GetResourceSet from ResourceManager. /// public override ResourceSet GetResourceSet(CultureInfo culture, bool createIfNotExists, bool tryParents) { @@ -978,7 +978,7 @@ public override ResourceSet GetResourceSet(CultureInfo culture, bool createIfNot } /// - /// Overrides ResourceManager.GetString to return the requested string. Returns null if the string couldn't be found. + /// Overrides ResourceManager.GetString to return the requested string. Returns null if the string couldn't be found. /// public override string GetString(string resourceName) { @@ -986,7 +986,7 @@ public override string GetString(string resourceName) } /// - /// Event handler that gets called when serialization or deserialization is complete. Here we need to write any resources to disk. Sine we open resources for write on demand, this code handles the case of reading resources as well. + /// Event handler that gets called when serialization or deserialization is complete. Here we need to write any resources to disk. Sine we open resources for write on demand, this code handles the case of reading resources as well. /// private void OnSerializationComplete(object sender, EventArgs e) { @@ -1053,7 +1053,7 @@ private void OnSerializationComplete(object sender, EventArgs e) } /// - /// Writes a metadata tag to the resource, or writes a normal tag if the resource writer doesn't support metadata. + /// Writes a metadata tag to the resource, or writes a normal tag if the resource writer doesn't support metadata. /// public void SetMetadata(IDesignerSerializationManager manager, string resourceName, object value, bool shouldSerializeValue, bool applyingCachedResources) { @@ -1135,7 +1135,7 @@ public void SetMetadata(IDesignerSerializationManager manager, string resourceNa } /// - /// Writes the given resource value under the given name. This checks the parent resource to see if the values are the same. If they are, the resource is not written. If not, then the resource is written. We always write using the resource language we read in with, so we don't stomp on the wrong resource data in the event that someone changes the language. + /// Writes the given resource value under the given name. This checks the parent resource to see if the values are the same. If they are, the resource is not written. If not, then the resource is written. We always write using the resource language we read in with, so we don't stomp on the wrong resource data in the event that someone changes the language. /// public void SetValue(IDesignerSerializationManager manager, string resourceName, object value, bool forceInvariant, bool shouldSerializeInvariant, bool ensureInvariant, bool applyingCachedResources) { @@ -1238,7 +1238,7 @@ public void SetValue(IDesignerSerializationManager manager, string resourceName, } /// - /// Writes the given resource value under the given name. This checks the parent resource to see if the values are the same. If they are, the resource is not written. If not, then the resource is written. We always write using the resource language we read in with, so we don't stomp on the wrong resource data in the event that someone changes the language. + /// Writes the given resource value under the given name. This checks the parent resource to see if the values are the same. If they are, the resource is not written. If not, then the resource is written. We always write using the resource language we read in with, so we don't stomp on the wrong resource data in the event that someone changes the language. /// public string SetValue(IDesignerSerializationManager manager, ExpressionContext tree, object value, bool forceInvariant, bool shouldSerializeInvariant, bool ensureInvariant, bool applyingCachedResources) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/RootContext.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/RootContext.cs index 123c7f8096c..1cf00d7b8e4 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/RootContext.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/RootContext.cs @@ -7,16 +7,16 @@ namespace System.ComponentModel.Design.Serialization { /// - /// The root context is added by a type code dom serailizier to provide a - /// definiton of the "root" object. + /// The root context is added by a type code dom serailizier to provide a + /// definiton of the "root" object. /// public sealed class RootContext { /// - /// This object can be placed on the context stack to represent the - /// object that is the root of the serialization hierarchy. In addition - /// to this instance, the RootContext also contains an expression that - /// can be used to reference the RootContext. + /// This object can be placed on the context stack to represent the + /// object that is the root of the serialization hierarchy. In addition + /// to this instance, the RootContext also contains an expression that + /// can be used to reference the RootContext. /// public RootContext(CodeExpression expression, object value) { @@ -25,12 +25,12 @@ public RootContext(CodeExpression expression, object value) } /// - /// The expression representing the root object in the object graph. + /// The expression representing the root object in the object graph. /// public CodeExpression Expression { get; } /// - /// The root object of the object graph. + /// The root object of the object graph. /// public object Value { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/SerializeAbsoluteContext.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/SerializeAbsoluteContext.cs index 05ad465d3db..abb4cc141e9 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/SerializeAbsoluteContext.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/SerializeAbsoluteContext.cs @@ -5,30 +5,30 @@ namespace System.ComponentModel.Design.Serialization { /// - /// The ComponentSerializationService supports "absolute" serialization, - /// where instead of just serializing values that differ from an object's + /// The ComponentSerializationService supports "absolute" serialization, + /// where instead of just serializing values that differ from an object's // default values, all values are serialized in such a way as to be able - /// to reset values to their defaults for objects that may have already - /// been initialized. When a component serialization service wishes to - /// indicate this to CodeDomSerializer objects, it will place a - /// SerializeAbsoluteContext on the context stack. The member in this - /// context may be null, to indicate that all members are serialized, or - /// a member indicating that only a specific member is being serialized at - /// this time. + /// to reset values to their defaults for objects that may have already + /// been initialized. When a component serialization service wishes to + /// indicate this to CodeDomSerializer objects, it will place a + /// SerializeAbsoluteContext on the context stack. The member in this + /// context may be null, to indicate that all members are serialized, or + /// a member indicating that only a specific member is being serialized at + /// this time. /// public sealed class SerializeAbsoluteContext { /// - /// Creeates a new SerializeAbsoluteContext. Member can be null or - /// omitted to indicate this context should be used for all members. + /// Creeates a new SerializeAbsoluteContext. Member can be null or + /// omitted to indicate this context should be used for all members. /// public SerializeAbsoluteContext() { } /// - /// Creeates a new SerializeAbsoluteContext. Member can be null or - /// omitted to indicate this context should be used for all members. + /// Creeates a new SerializeAbsoluteContext. Member can be null or + /// omitted to indicate this context should be used for all members. /// public SerializeAbsoluteContext(MemberDescriptor member) { @@ -36,12 +36,12 @@ public SerializeAbsoluteContext(MemberDescriptor member) } /// - /// This property returns the member this context is bound to. It may be null to indicate the context is bound to all members of an object. + /// This property returns the member this context is bound to. It may be null to indicate the context is bound to all members of an object. /// public MemberDescriptor Member { get; } /// - /// Returns true if the given member should be serialized in this context. + /// Returns true if the given member should be serialized in this context. /// public bool ShouldSerialize(MemberDescriptor member) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/StatementContext.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/StatementContext.cs index f7722966942..1eb20490f13 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/StatementContext.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/StatementContext.cs @@ -9,23 +9,23 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This object can be placed on the context stack to provide a place for - /// statements to be serialized into. Normally, statements are serialized - /// into whatever statement collection that is on the context stack. You - /// can modify this behavior by creating a statement context and calling - /// Populate with a collection of objects whose statements you would like - /// stored in the statement table. As each object is serialized in - /// SerializeToExpression it will have its contents placed in the statement - /// table. saved in a table within the context. If you push this object on - /// the stack it is your responsibility to integrate the statements added - /// to it into your own collection of statements. + /// This object can be placed on the context stack to provide a place for + /// statements to be serialized into. Normally, statements are serialized + /// into whatever statement collection that is on the context stack. You + /// can modify this behavior by creating a statement context and calling + /// Populate with a collection of objects whose statements you would like + /// stored in the statement table. As each object is serialized in + /// SerializeToExpression it will have its contents placed in the statement + /// table. saved in a table within the context. If you push this object on + /// the stack it is your responsibility to integrate the statements added + /// to it into your own collection of statements. /// public sealed class StatementContext { private ObjectStatementCollection _statements; /// - /// This is a table of statements that is offered by the statement context. + /// This is a table of statements that is offered by the statement context. /// public ObjectStatementCollection StatementCollection { @@ -34,7 +34,7 @@ public ObjectStatementCollection StatementCollection } /// - /// This is a table of statements that is offered by the statement context. + /// This is a table of statements that is offered by the statement context. /// public sealed class ObjectStatementCollection : IEnumerable { @@ -42,14 +42,14 @@ public sealed class ObjectStatementCollection : IEnumerable private int _version; /// - /// Only creatable by the StatementContext. + /// Only creatable by the StatementContext. /// internal ObjectStatementCollection() { } /// - /// Adds an owner to the table. Statements can be null, in which case it will be demand created when fished out of the table. This will throw if there is already a valid collection for the owner. + /// Adds an owner to the table. Statements can be null, in which case it will be demand created when fished out of the table. This will throw if there is already a valid collection for the owner. /// private void AddOwner(object statementOwner, CodeStatementCollection statements) { @@ -83,8 +83,8 @@ private void AddOwner(object statementOwner, CodeStatementCollection statements) } /// - /// Indexer. This will return the statement collection for the given owner. - /// It will return null only if the owner is not in the table. + /// Indexer. This will return the statement collection for the given owner. + /// It will return null only if the owner is not in the table. /// public CodeStatementCollection this[object statementOwner] { @@ -121,7 +121,7 @@ public CodeStatementCollection this[object statementOwner] } /// - /// Returns true if the given statement owner is in the table. + /// Returns true if the given statement owner is in the table. /// public bool ContainsKey(object statementOwner) { @@ -138,7 +138,7 @@ public bool ContainsKey(object statementOwner) } /// - /// Returns an enumerator for this table. The keys of the enumerator are statement owner objects and the values are instances of CodeStatementCollection. + /// Returns an enumerator for this table. The keys of the enumerator are statement owner objects and the values are instances of CodeStatementCollection. /// public IDictionaryEnumerator GetEnumerator() { @@ -146,7 +146,7 @@ public IDictionaryEnumerator GetEnumerator() } /// - /// This method populates the statement table with a collection of statement owners. The creator of the statement context should do this if it wishes statement tables to be used to store values for certain objects. + /// This method populates the statement table with a collection of statement owners. The creator of the statement context should do this if it wishes statement tables to be used to store values for certain objects. /// public void Populate(ICollection statementOwners) { @@ -161,7 +161,7 @@ public void Populate(ICollection statementOwners) } /// - /// This method populates the statement table with a collection of statement owners. The creator of the statement context should do this if it wishes statement tables to be used to store values for certain objects. + /// This method populates the statement table with a collection of statement owners. The creator of the statement context should do this if it wishes statement tables to be used to store values for certain objects. /// public void Populate(object owner) { @@ -173,7 +173,7 @@ public void Populate(object owner) } /// - /// Returns an enumerator for this table. The value is a DictionaryEntry containing the statement owner and the statement collection. + /// Returns an enumerator for this table. The value is a DictionaryEntry containing the statement owner and the statement collection. /// IEnumerator IEnumerable.GetEnumerator() { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/TypeCodeDomSerializer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/TypeCodeDomSerializer.cs index 1b69743ff5e..ab0abb92782 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/TypeCodeDomSerializer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/TypeCodeDomSerializer.cs @@ -12,7 +12,7 @@ namespace System.ComponentModel.Design.Serialization { /// - /// This class performs the same tasks as a CodeDomSerializer only serializing an object through this class defines a new type. + /// This class performs the same tasks as a CodeDomSerializer only serializing an object through this class defines a new type. /// [DefaultSerializationProvider(typeof(CodeDomSerializationProvider))] public class TypeCodeDomSerializer : CodeDomSerializerBase @@ -39,10 +39,10 @@ internal static TypeCodeDomSerializer Default } /// - /// This method deserializes a previously serialized code type declaration. The default implementation performs the following tasks: - /// • Case Sensitivity Checks: It looks for a CodeDomProvider service to decide if it should treat members as case sensitive or case insensitive. - /// • Statement Sorting: All member variables and local variables from init methods are stored in a table. Then each statement in an init method is added to a statement collection grouped according to its left hand side. So all statements assigning or operating on a particular variable are grouped under that variable. Variables that have no statements are discarded. - /// • Deserialization: Finally, the statement collections for each variable are deserialized according to the variable. Deserialize returns an instance of the root object. + /// This method deserializes a previously serialized code type declaration. The default implementation performs the following tasks: + /// • Case Sensitivity Checks: It looks for a CodeDomProvider service to decide if it should treat members as case sensitive or case insensitive. + /// • Statement Sorting: All member variables and local variables from init methods are stored in a table. Then each statement in an init method is added to a statement collection grouped according to its left hand side. So all statements assigning or operating on a particular variable are grouped under that variable. Variables that have no statements are discarded. + /// • Deserialization: Finally, the statement collections for each variable are deserialized according to the variable. Deserialize returns an instance of the root object. /// public virtual object Deserialize(IDesignerSerializationManager manager, CodeTypeDeclaration declaration) { @@ -227,7 +227,7 @@ public virtual object Deserialize(IDesignerSerializationManager manager, CodeTyp } /// - /// This takes the given name and deserializes it from our name table. Before blindly deserializing it checks the contents of the name table to see if the object already exists within it. We do this because deserializing one object may call back into us through OnResolveName and deserialize another. + /// This takes the given name and deserializes it from our name table. Before blindly deserializing it checks the contents of the name table to see if the object already exists within it. We do this because deserializing one object may call back into us through OnResolveName and deserialize another. /// private object DeserializeName(IDesignerSerializationManager manager, string name, CodeStatementCollection statements) { @@ -349,7 +349,7 @@ private object DeserializeName(IDesignerSerializationManager manager, string nam } /// - /// This method returns the method to emit all of the initialization code to for the given member. The default implementation returns an empty constructor. + /// This method returns the method to emit all of the initialization code to for the given member. The default implementation returns an empty constructor. /// protected virtual CodeMemberMethod GetInitializeMethod(IDesignerSerializationManager manager, CodeTypeDeclaration declaration, object value) { @@ -374,7 +374,7 @@ protected virtual CodeMemberMethod GetInitializeMethod(IDesignerSerializationMan } /// - /// This method returns an array of methods that need to be interpreted during deserialization. The default implementation returns a single element array with the constructor in it. + /// This method returns an array of methods that need to be interpreted during deserialization. The default implementation returns a single element array with the constructor in it. /// protected virtual CodeMemberMethod[] GetInitializeMethods(IDesignerSerializationManager manager, CodeTypeDeclaration declaration) { @@ -397,7 +397,7 @@ protected virtual CodeMemberMethod[] GetInitializeMethods(IDesignerSerialization } /// - /// Called by the serialization manager to resolve a name to an object. + /// Called by the serialization manager to resolve a name to an object. /// private void OnResolveName(object sender, ResolveNameEventArgs e) { @@ -419,12 +419,12 @@ private void OnResolveName(object sender, ResolveNameEventArgs e) } /// - /// This method serializes the given root object and optional collection of members to create a new type definition. The members collection can be null or empty. If it contains values, these values will be serialized. Values themselves may decide to serialize as either member variables or local variables. This determination is done by looking for an extender property on the object called GenerateMember. If true, a member is generated. Otherwise, a local variable is generated. For convenience, the members collection can contain the root object. In this case the root object will not also be added as a member or local variable. The return value is a CodeTypeDeclaration that defines the root object. The name of the type will be taken from the root object’s name, if it was a named object. If not, a name will be fabricated from the simple type name of the root class. - /// The default implementation of Serialize performs the following tasks: - /// • Context Seeding. The serialization context will be “seeded” with data including the RootContext, and CodeTypeDeclaration. - /// • Member Serialization. Next Serialize will walk all of the members and call SerializeToExpression. Because serialization is done opportunistically in SerializeToExpression, this ensures that we do not serialize twice. - /// • Root Seralization. Finally, the root object is serialized and its statements are added to the statement collection. - /// • Statement Integration. After all objects have been serialized the Serialize method orders the statements and adds them to a method returned from GetInitializeMethod. Finally, a constructor is fabricated that calls all of the methods returned from GetInitializeMethod (this step is skipped for cases when GetInitializeMethod returns a constructor. + /// This method serializes the given root object and optional collection of members to create a new type definition. The members collection can be null or empty. If it contains values, these values will be serialized. Values themselves may decide to serialize as either member variables or local variables. This determination is done by looking for an extender property on the object called GenerateMember. If true, a member is generated. Otherwise, a local variable is generated. For convenience, the members collection can contain the root object. In this case the root object will not also be added as a member or local variable. The return value is a CodeTypeDeclaration that defines the root object. The name of the type will be taken from the root object’s name, if it was a named object. If not, a name will be fabricated from the simple type name of the root class. + /// The default implementation of Serialize performs the following tasks: + /// • Context Seeding. The serialization context will be “seeded” with data including the RootContext, and CodeTypeDeclaration. + /// • Member Serialization. Next Serialize will walk all of the members and call SerializeToExpression. Because serialization is done opportunistically in SerializeToExpression, this ensures that we do not serialize twice. + /// • Root Seralization. Finally, the root object is serialized and its statements are added to the statement collection. + /// • Statement Integration. After all objects have been serialized the Serialize method orders the statements and adds them to a method returned from GetInitializeMethod. Finally, a constructor is fabricated that calls all of the methods returned from GetInitializeMethod (this step is skipped for cases when GetInitializeMethod returns a constructor. /// public virtual CodeTypeDeclaration Serialize(IDesignerSerializationManager manager, object root, ICollection members) { @@ -511,7 +511,7 @@ public virtual CodeTypeDeclaration Serialize(IDesignerSerializationManager manag } /// - /// Takes the statement context and integrates all the statements into the correct methods. Then, those methods are added to the code type declaration. + /// Takes the statement context and integrates all the statements into the correct methods. Then, those methods are added to the code type declaration. /// private void IntegrateStatements(IDesignerSerializationManager manager, object root, ICollection members, StatementContext statementCxt, CodeTypeDeclaration typeDecl) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SiteNestedContainer.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SiteNestedContainer.cs index be2d4e3824d..fc6ba43f7d5 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SiteNestedContainer.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/SiteNestedContainer.cs @@ -8,8 +8,8 @@ namespace System.ComponentModel.Design { /// - /// This is a nested container.static Anything added to the nested container - /// will be hostable in a designer. + /// This is a nested container.static Anything added to the nested container + /// will be hostable in a designer. /// internal sealed class SiteNestedContainer : NestedContainer { @@ -26,7 +26,7 @@ internal SiteNestedContainer(IComponent owner, string containerName, DesignerHos } /// - /// Override to support named containers. + /// Override to support named containers. /// protected override string OwnerName { @@ -43,7 +43,7 @@ protected override string OwnerName } /// - /// Called to add a component to its container. + /// Called to add a component to its container. /// public override void Add(IComponent component, string name) { @@ -70,7 +70,7 @@ public override void Add(IComponent component, string name) } /// - /// Creates a site for the component within the container. + /// Creates a site for the component within the container. /// protected override ISite CreateSite(IComponent component, string name) { @@ -83,7 +83,7 @@ protected override ISite CreateSite(IComponent component, string name) } /// - /// Called to remove a component from its container. + /// Called to remove a component from its container. /// public override void Remove(IComponent component) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/StatusCommandUI.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/StatusCommandUI.cs index a7707fdaf7b..6ac9405cd49 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/StatusCommandUI.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/StatusCommandUI.cs @@ -9,7 +9,7 @@ namespace System.ComponentModel.Design { /// - /// This class provides a single entrypoint used by the Behaviors, KeySize and KeyMoves (in CommandSets) and SelectionService to update the StatusBar Information. + /// This class provides a single entrypoint used by the Behaviors, KeySize and KeyMoves (in CommandSets) and SelectionService to update the StatusBar Information. /// internal class StatusCommandUI { @@ -23,7 +23,7 @@ public StatusCommandUI(IServiceProvider provider) } /// - /// Retrieves the menu editor service, which we cache for speed. + /// Retrieves the menu editor service, which we cache for speed. /// private IMenuCommandService MenuService { @@ -38,7 +38,7 @@ private IMenuCommandService MenuService } /// - /// Retrieves the actual StatusRectCommand, which we cache for speed. + /// Retrieves the actual StatusRectCommand, which we cache for speed. /// private MenuCommand StatusRectCommand { @@ -56,7 +56,7 @@ private MenuCommand StatusRectCommand } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Component selectedComponent, Point location) { @@ -89,7 +89,7 @@ public void SetStatusInformation(Component selectedComponent, Point location) } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Component selectedComponent) { @@ -117,7 +117,7 @@ public void SetStatusInformation(Component selectedComponent) } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Rectangle bounds) { diff --git a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/TypeDescriptorFilterService.cs b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/TypeDescriptorFilterService.cs index ec9d8ee2629..93c17002196 100644 --- a/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/TypeDescriptorFilterService.cs +++ b/src/System.Windows.Forms.Design/src/System/ComponentModel/Design/TypeDescriptorFilterService.cs @@ -7,19 +7,19 @@ namespace System.ComponentModel.Design { /// - /// This service is requested by TypeDescriptor when asking for type information for a component. Our implementation forwards this filter onto IDesignerFilter on the component's designer, should one exist. + /// This service is requested by TypeDescriptor when asking for type information for a component. Our implementation forwards this filter onto IDesignerFilter on the component's designer, should one exist. /// internal sealed class TypeDescriptorFilterService : ITypeDescriptorFilterService { /// - /// Internal ctor to prevent semitrust from creating us. + /// Internal ctor to prevent semitrust from creating us. /// internal TypeDescriptorFilterService() { } /// - /// Helper method to return the designer for a given component. + /// Helper method to return the designer for a given component. /// private IDesigner GetDesigner(IComponent component) { @@ -35,7 +35,7 @@ private IDesigner GetDesigner(IComponent component) } /// - /// Provides a way to filter the attributes from a component that are displayed to the user. + /// Provides a way to filter the attributes from a component that are displayed to the user. /// bool ITypeDescriptorFilterService.FilterAttributes(IComponent component, IDictionary attributes) { @@ -59,7 +59,7 @@ bool ITypeDescriptorFilterService.FilterAttributes(IComponent component, IDictio } /// - /// Provides a way to filter the events from a component that are displayed to the user. + /// Provides a way to filter the events from a component that are displayed to the user. /// bool ITypeDescriptorFilterService.FilterEvents(IComponent component, IDictionary events) { @@ -83,7 +83,7 @@ bool ITypeDescriptorFilterService.FilterEvents(IComponent component, IDictionary } /// - /// Provides a way to filter the properties from a component that are displayed to the user. + /// Provides a way to filter the properties from a component that are displayed to the user. /// bool ITypeDescriptorFilterService.FilterProperties(IComponent component, IDictionary properties) { diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxService.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxService.cs index cc45d0f2bff..8cbf2827782 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxService.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxService.cs @@ -9,7 +9,7 @@ namespace System.Drawing.Design { /// - /// Provides access to the toolbox in the development environment. + /// Provides access to the toolbox in the development environment. /// [ComImport] [Guid("4BACD258-DE64-4048-BC4E-FEDBEF9ACB76")] @@ -17,154 +17,154 @@ namespace System.Drawing.Design public interface IToolboxService { /// - /// Gets the names of all the tool categories currently on the toolbox. + /// Gets the names of all the tool categories currently on the toolbox. /// CategoryNameCollection CategoryNames { get; } /// - /// Gets the name of the currently selected tool category from the toolbox. + /// Gets the name of the currently selected tool category from the toolbox. /// string SelectedCategory { get; set; } /// - /// Adds a new toolbox item creator. + /// Adds a new toolbox item creator. /// void AddCreator(ToolboxItemCreatorCallback creator, string format); /// - /// Adds a new toolbox item creator. + /// Adds a new toolbox item creator. /// void AddCreator(ToolboxItemCreatorCallback creator, string format, IDesignerHost host); /// - /// Adds a new tool to the toolbox under the default category. + /// Adds a new tool to the toolbox under the default category. /// void AddLinkedToolboxItem(ToolboxItem toolboxItem, IDesignerHost host); /// - /// Adds a new tool to the toolbox under the specified category. + /// Adds a new tool to the toolbox under the specified category. /// void AddLinkedToolboxItem(ToolboxItem toolboxItem, string category, IDesignerHost host); /// - /// Adds a new tool to the toolbox under the default category. + /// Adds a new tool to the toolbox under the default category. /// void AddToolboxItem(ToolboxItem toolboxItem); /// - /// Adds a new tool to the toolbox under the specified category. + /// Adds a new tool to the toolbox under the specified category. /// void AddToolboxItem(ToolboxItem toolboxItem, string category); /// - /// Gets a toolbox item from a previously serialized object. + /// Gets a toolbox item from a previously serialized object. /// ToolboxItem DeserializeToolboxItem(object serializedObject); /// - /// Gets a toolbox item from a previously serialized object. + /// Gets a toolbox item from a previously serialized object. /// ToolboxItem DeserializeToolboxItem(object serializedObject, IDesignerHost host); /// - /// Get the currently selected tool. + /// Get the currently selected tool. /// ToolboxItem GetSelectedToolboxItem(); /// - /// Get the currently selected tool. + /// Get the currently selected tool. /// ToolboxItem GetSelectedToolboxItem(IDesignerHost host); /// - /// Gets all .NET tools on the toolbox. + /// Gets all .NET tools on the toolbox. /// ToolboxItemCollection GetToolboxItems(); /// - /// Gets all .NET tools on the toolbox. + /// Gets all .NET tools on the toolbox. /// ToolboxItemCollection GetToolboxItems(IDesignerHost host); /// - /// Gets all .NET tools on the toolbox fopr specific category. + /// Gets all .NET tools on the toolbox fopr specific category. /// ToolboxItemCollection GetToolboxItems(string category); /// - /// Gets all .NET tools on the toolbox for specific category. + /// Gets all .NET tools on the toolbox for specific category. /// ToolboxItemCollection GetToolboxItems(string category, IDesignerHost host); /// - /// Determines if the given designer host contains a designer that supports the serialized - /// toolbox item. This will return false if the designer doesn't support the item, or if the - /// serializedObject parameter does not contain a toolbox item. + /// Determines if the given designer host contains a designer that supports the serialized + /// toolbox item. This will return false if the designer doesn't support the item, or if the + /// serializedObject parameter does not contain a toolbox item. /// bool IsSupported(object serializedObject, IDesignerHost host); /// - /// Determines if the serialized toolbox item contains a matching collection of filter attributes. - /// This will return false if the serializedObject parameter doesn't contain a toolbox item, - /// or if the collection of filter attributes does not match. + /// Determines if the serialized toolbox item contains a matching collection of filter attributes. + /// This will return false if the serializedObject parameter doesn't contain a toolbox item, + /// or if the collection of filter attributes does not match. /// bool IsSupported(object serializedObject, ICollection filterAttributes); /// - /// Gets a value indicating whether the specified object contains a serialized toolbox item. + /// Gets a value indicating whether the specified object contains a serialized toolbox item. /// bool IsToolboxItem(object serializedObject); /// - /// Gets a value indicating whether the specified object contains a serialized toolbox item. + /// Gets a value indicating whether the specified object contains a serialized toolbox item. /// bool IsToolboxItem(object serializedObject, IDesignerHost host); /// - /// Refreshes the state of the toolbox items. + /// Refreshes the state of the toolbox items. /// void Refresh(); /// - /// Removes a previously added toolbox creator. + /// Removes a previously added toolbox creator. /// void RemoveCreator(string format); /// - /// Removes a previously added toolbox creator. + /// Removes a previously added toolbox creator. /// void RemoveCreator(string format, IDesignerHost host); /// - /// Removes the specified tool from the toolbox. + /// Removes the specified tool from the toolbox. /// void RemoveToolboxItem(ToolboxItem toolboxItem); /// - /// Removes the specified tool from the toolbox. + /// Removes the specified tool from the toolbox. /// void RemoveToolboxItem(ToolboxItem toolboxItem, string category); /// - /// Notifies the toolbox that the selected tool has been used. + /// Notifies the toolbox that the selected tool has been used. /// void SelectedToolboxItemUsed(); /// - /// Takes the given toolbox item and serializes it to a persistent object. This object can then - /// be stored in a stream or passed around in a drag and drop or clipboard operation. + /// Takes the given toolbox item and serializes it to a persistent object. This object can then + /// be stored in a stream or passed around in a drag and drop or clipboard operation. /// object SerializeToolboxItem(ToolboxItem toolboxItem); /// - /// Sets the current application's cursor to a cursor that represents the - /// currently selected tool. + /// Sets the current application's cursor to a cursor that represents the + /// currently selected tool. /// /// bool bool SetCursor(); /// - /// Sets the currently selected tool in the toolbox. + /// Sets the currently selected tool in the toolbox. /// void SetSelectedToolboxItem(ToolboxItem toolboxItem); } diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxUser.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxUser.cs index 9ecc48c7cfe..10dbc05e0e6 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxUser.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/IToolboxUser.cs @@ -5,17 +5,17 @@ namespace System.Drawing.Design { /// - /// Provides notifications of toolbox actions to designers which implement this interface. + /// Provides notifications of toolbox actions to designers which implement this interface. /// public interface IToolboxUser { /// - /// Gets a value indicating whether the specified tool is supported by the current designer + /// Gets a value indicating whether the specified tool is supported by the current designer /// bool GetToolSupported(ToolboxItem tool); /// - /// Selects the specified tool. + /// Selects the specified tool. /// /// toolbox item void ToolPicked(ToolboxItem tool); diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventArgs.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventArgs.cs index 0aab37716f3..407fcfc4ce2 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventArgs.cs @@ -7,15 +7,15 @@ namespace System.Drawing.Design { /// - /// Provides data for the 'ToolboxComponentsCreatedEventArgs' event that occurs - /// when components are added to the toolbox. + /// Provides data for the 'ToolboxComponentsCreatedEventArgs' event that occurs + /// when components are added to the toolbox. /// public class ToolboxComponentsCreatedEventArgs : EventArgs { private readonly IComponent[] _components; /// - /// Initializes a new instance of the public ToolboxComponentsCreatedEventArgs(IComponent[] components) { @@ -23,7 +23,7 @@ public ToolboxComponentsCreatedEventArgs(IComponent[] components) } /// - /// An array storing the toolbox components. + /// An array storing the toolbox components. /// public IComponent[] Components => (IComponent[])_components?.Clone(); } diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventHandler.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventHandler.cs index 40f33be6e1a..1ab4b01e35c 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Drawing.Design { /// - /// Represents the method that will handle the event. + /// Represents the method that will handle the event. /// public delegate void ToolboxComponentsCreatedEventHandler(object sender, ToolboxComponentsCreatedEventArgs e); } diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventArgs.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventArgs.cs index 85fad735070..7473e1fb7b1 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Drawing.Design { /// - /// Provides data for the 'ToolboxComponentsCreatingEventArgs' event that occurs - /// when components are added to the toolbox. + /// Provides data for the 'ToolboxComponentsCreatingEventArgs' event that occurs + /// when components are added to the toolbox. /// public class ToolboxComponentsCreatingEventArgs : EventArgs { /// - /// Initializes a new instance of the object. + /// Initializes a new instance of the object. /// public ToolboxComponentsCreatingEventArgs(IDesignerHost host) { @@ -21,8 +21,8 @@ public ToolboxComponentsCreatingEventArgs(IDesignerHost host) } /// - /// An instance of IDesignerHost that has made the creat request. - /// This can be null if no designer host was provided to the toolbox item. + /// An instance of IDesignerHost that has made the creat request. + /// This can be null if no designer host was provided to the toolbox item. /// public IDesignerHost DesignerHost { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventHandler.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventHandler.cs index 3e956f9963c..9f78afcc668 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxComponentsCreatingEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Drawing.Design { /// - /// Represents the method that will handle the event. + /// Represents the method that will handle the event. /// public delegate void ToolboxComponentsCreatingEventHandler(object sender, ToolboxComponentsCreatingEventArgs e); } diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItem.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItem.cs index 12737a940f0..3e7eba32642 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItem.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItem.cs @@ -15,7 +15,7 @@ namespace System.Drawing.Design { /// - /// Provides a base implementation of a toolbox item. + /// Provides a base implementation of a toolbox item. /// public class ToolboxItem : ISerializable { @@ -35,7 +35,7 @@ public class ToolboxItem : ISerializable private ToolboxComponentsCreatingEventHandler _componentsCreatingEvent; /// - /// Initializes a new instance of the ToolboxItem class. + /// Initializes a new instance of the ToolboxItem class. /// public ToolboxItem() { @@ -51,7 +51,7 @@ public ToolboxItem() } /// - /// Initializes a new instance of the ToolboxItem class using the specified type. + /// Initializes a new instance of the ToolboxItem class using the specified type. /// public ToolboxItem(Type toolType) : this() { @@ -59,8 +59,8 @@ public ToolboxItem(Type toolType) : this() } /// - /// The assembly name for this toolbox item. The assembly name describes the assembly - /// information needed to load the toolbox item's type. + /// The assembly name for this toolbox item. The assembly name describes the assembly + /// information needed to load the toolbox item's type. /// public AssemblyName AssemblyName { @@ -75,8 +75,8 @@ public AssemblyName AssemblyName } /// - /// The assembly name for this toolbox item. The assembly name describes the assembly - /// information needed to load the toolbox item's type. + /// The assembly name for this toolbox item. The assembly name describes the assembly + /// information needed to load the toolbox item's type. /// public AssemblyName[] DependentAssemblies { @@ -96,8 +96,8 @@ public AssemblyName[] DependentAssemblies } /// - /// Gets or sets the bitmap that will be used on the toolbox for this item. - /// Use this property on the design surface as this bitmap is scaled according to the current the DPI setting. + /// Gets or sets the bitmap that will be used on the toolbox for this item. + /// Use this property on the design surface as this bitmap is scaled according to the current the DPI setting. /// public Bitmap Bitmap { @@ -112,8 +112,8 @@ public Bitmap Bitmap } /// - /// Gets or sets the original bitmap that will be used on the toolbox for this item. - /// This bitmap should be 16x16 pixel and should be used in the Visual Studio toolbox, not on the design surface. + /// Gets or sets the original bitmap that will be used on the toolbox for this item. + /// This bitmap should be 16x16 pixel and should be used in the Visual Studio toolbox, not on the design surface. /// public Bitmap OriginalBitmap { @@ -128,8 +128,8 @@ public Bitmap OriginalBitmap } /// - /// Gets or sets the company name for this . - /// This defaults to the companyname attribute retrieved from type.Assembly, if set. + /// Gets or sets the company name for this . + /// This defaults to the companyname attribute retrieved from type.Assembly, if set. /// public string Company { @@ -144,7 +144,7 @@ public string Company } /// - /// The Component Type is ".Net Component" -- unless otherwise specified by a derived toolboxitem + /// The Component Type is ".Net Component" -- unless otherwise specified by a derived toolboxitem /// public virtual string ComponentType { @@ -155,8 +155,8 @@ public virtual string ComponentType } /// - /// Description is a free-form, multiline capable text description that will be displayed in the tooltip - /// for the toolboxItem. It defaults to the path of the assembly that contains the item, but can be overridden. + /// Description is a free-form, multiline capable text description that will be displayed in the tooltip + /// for the toolboxItem. It defaults to the path of the assembly that contains the item, but can be overridden. /// public string Description { @@ -171,7 +171,7 @@ public string Description } /// - /// Gets or sets the display name for this . + /// Gets or sets the display name for this . /// public string DisplayName { @@ -186,8 +186,8 @@ public string DisplayName } /// - /// Gets or sets the filter for this toolbox item. The filter is a collection of - /// ToolboxItemFilterAttribute objects. + /// Gets or sets the filter for this toolbox item. The filter is a collection of + /// ToolboxItemFilterAttribute objects. /// public ICollection Filter { @@ -202,9 +202,9 @@ public ICollection Filter } /// - /// If true, it indicates that this toolbox item should not be stored in - /// any toolbox database when an application that is providing a toolbox - /// closes down. This property defaults to false. + /// If true, it indicates that this toolbox item should not be stored in + /// any toolbox database when an application that is providing a toolbox + /// closes down. This property defaults to false. /// public bool IsTransient { @@ -219,8 +219,8 @@ public bool IsTransient } /// - /// Determines if this toolbox item is locked. Once locked, a toolbox item will - /// not accept any changes to its properties. + /// Determines if this toolbox item is locked. Once locked, a toolbox item will + /// not accept any changes to its properties. /// public virtual bool Locked { @@ -231,11 +231,11 @@ public virtual bool Locked } /// - /// The properties dictionary is a set of name/value pairs. The keys are property - /// names and the values are property values. This dictionary becomes read-only - /// after the toolbox item has been locked. - /// Values in the properties dictionary are validated through ValidateProperty - /// and default values are obtained from GetDefalutProperty. + /// The properties dictionary is a set of name/value pairs. The keys are property + /// names and the values are property values. This dictionary becomes read-only + /// after the toolbox item has been locked. + /// Values in the properties dictionary are validated through ValidateProperty + /// and default values are obtained from GetDefalutProperty. /// public IDictionary Properties { @@ -251,7 +251,7 @@ public IDictionary Properties } /// - /// Gets or sets the fully qualified name of the type this toolbox item will create. + /// Gets or sets the fully qualified name of the type this toolbox item will create. /// public string TypeName { @@ -266,9 +266,9 @@ public string TypeName } /// - /// Gets the version for this toolboxitem. It defaults to AssemblyName.Version unless - /// overridden in a derived toolboxitem. This can be overridden to - /// return an empty string to suppress its display in the toolbox tooltip. + /// Gets the version for this toolboxitem. It defaults to AssemblyName.Version unless + /// overridden in a derived toolboxitem. This can be overridden to + /// return an empty string to suppress its display in the toolbox tooltip. /// public virtual string Version { @@ -276,7 +276,7 @@ public virtual string Version } /// - /// Occurs when components are created. + /// Occurs when components are created. /// public event ToolboxComponentsCreatedEventHandler ComponentsCreated { @@ -285,7 +285,7 @@ public event ToolboxComponentsCreatedEventHandler ComponentsCreated } /// - /// Occurs before components are created. + /// Occurs before components are created. /// public event ToolboxComponentsCreatingEventHandler ComponentsCreating { @@ -294,8 +294,8 @@ public event ToolboxComponentsCreatingEventHandler ComponentsCreating } /// - /// This method checks that the toolbox item is currently unlocked (read-write) and - /// throws an appropriate exception if it isn't. + /// This method checks that the toolbox item is currently unlocked (read-write) and + /// throws an appropriate exception if it isn't. /// protected void CheckUnlocked() { @@ -306,7 +306,7 @@ protected void CheckUnlocked() } /// - /// Creates objects from the type contained in this toolbox item. + /// Creates objects from the type contained in this toolbox item. /// /// public IComponent[] CreateComponents() @@ -315,8 +315,8 @@ public IComponent[] CreateComponents() } /// - /// Creates objects from the type contained in this toolbox item. If designerHost is non-null - /// this will also add them to the designer. + /// Creates objects from the type contained in this toolbox item. If designerHost is non-null + /// this will also add them to the designer. /// public IComponent[] CreateComponents(IDesignerHost host) { @@ -330,8 +330,8 @@ public IComponent[] CreateComponents(IDesignerHost host) } /// - /// Creates objects from the type contained in this toolbox item. If designerHost is non-null - /// this will also add them to the designer. + /// Creates objects from the type contained in this toolbox item. If designerHost is non-null + /// this will also add them to the designer. /// /// public IComponent[] CreateComponents(IDesignerHost host, IDictionary defaultValues) @@ -346,8 +346,8 @@ public IComponent[] CreateComponents(IDesignerHost host, IDictionary defaultValu } /// - /// Creates objects from the type contained in this toolbox item. If designerHost is non-null - /// this will also add them to the designer. + /// Creates objects from the type contained in this toolbox item. If designerHost is non-null + /// this will also add them to the designer. /// protected virtual IComponent[] CreateComponentsCore(IDesignerHost host) { @@ -372,8 +372,8 @@ protected virtual IComponent[] CreateComponentsCore(IDesignerHost host) } /// - /// Creates objects from the type contained in this toolbox item. If designerHost is non-null - /// this will also add them to the designer. + /// Creates objects from the type contained in this toolbox item. If designerHost is non-null + /// this will also add them to the designer. /// protected virtual IComponent[] CreateComponentsCore(IDesignerHost host, IDictionary defaultValues) { @@ -499,7 +499,7 @@ private static bool AreAssemblyNamesEqual(AssemblyName name1, AssemblyName name2 public override int GetHashCode() => HashCode.Combine(TypeName, DisplayName); /// - /// Filters a property value before returning it. This allows a property to always clone values, + /// Filters a property value before returning it. This allows a property to always clone values, /// or to provide a default value when none exists. /// protected virtual object FilterPropertyValue(string propertyName, object value) @@ -543,9 +543,9 @@ protected virtual object FilterPropertyValue(string propertyName, object value) } /// - /// Allows access to the type associated with the toolbox item. - /// The designer host is used to access an implementation of ITypeResolutionService. - /// However, the loaded type is not added to the list of references in the designer host. + /// Allows access to the type associated with the toolbox item. + /// The designer host is used to access an implementation of ITypeResolutionService. + /// However, the loaded type is not added to the list of references in the designer host. /// public Type GetType(IDesignerHost host) { @@ -553,7 +553,7 @@ public Type GetType(IDesignerHost host) } /// - /// This utility function can be used to load a type given a name. AssemblyName and + /// This utility function can be used to load a type given a name. AssemblyName and /// designer host can be null, but if they are present they will be used to help /// locate the type. If reference is true, the given assembly name will be added /// to the designer host's set of references. @@ -670,7 +670,7 @@ protected virtual Type GetType(IDesignerHost host, AssemblyName assemblyName, st } /// - /// Initializes a toolbox item with a given type. A locked toolbox item cannot be initialized. + /// Initializes a toolbox item with a given type. A locked toolbox item cannot be initialized. /// public virtual void Initialize(Type type) { @@ -826,8 +826,8 @@ private AssemblyName GetNonRetargetedAssemblyName(Type type, AssemblyName polici } /// - /// Locks this toolbox item. Locking a toolbox item makes it read-only and - /// prevents any changes to its properties. + /// Locks this toolbox item. Locking a toolbox item makes it read-only and + /// prevents any changes to its properties. /// public virtual void Lock() { @@ -855,8 +855,8 @@ protected virtual void Serialize(SerializationInfo info, StreamingContext contex info.AddValue("PropertyNames", (string[])propertyNames.ToArray(typeof(string))); } /// - /// Raises the OnComponentsCreated event. This - /// will be called when this creates a component. + /// Raises the OnComponentsCreated event. This + /// will be called when this creates a component. /// protected virtual void OnComponentsCreated(ToolboxComponentsCreatedEventArgs args) { @@ -864,8 +864,8 @@ protected virtual void OnComponentsCreated(ToolboxComponentsCreatedEventArgs arg } /// - /// Raises the OnCreateComponentsInvoked event. This - /// will be called before this creates a component. + /// Raises the OnCreateComponentsInvoked event. This + /// will be called before this creates a component. /// protected virtual void OnComponentsCreating(ToolboxComponentsCreatingEventArgs args) { @@ -875,7 +875,7 @@ protected virtual void OnComponentsCreating(ToolboxComponentsCreatingEventArgs a public override string ToString() => DisplayName ?? string.Empty; /// - /// Called as a helper to ValidatePropertyValue to validate that an object + /// Called as a helper to ValidatePropertyValue to validate that an object /// is of a given type. /// protected void ValidatePropertyType(string propertyName, object value, Type expectedType, bool allowNull) @@ -897,9 +897,9 @@ protected void ValidatePropertyType(string propertyName, object value, Type expe } /// - /// This is called whenever a value is set in the property dictionary. It gives you a chance - /// to change the value of an object before comitting it, our reject it by throwing an - /// exception. + /// This is called whenever a value is set in the property dictionary. It gives you a chance + /// to change the value of an object before comitting it, our reject it by throwing an + /// exception. /// protected virtual object ValidatePropertyValue(string propertyName, object value) { diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCollection.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCollection.cs index 31847c588e5..f2bab8b4bd6 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCollection.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCollection.cs @@ -7,12 +7,12 @@ namespace System.Drawing.Design { /// - /// A collection that stores objects. + /// A collection that stores objects. /// public sealed class ToolboxItemCollection : ReadOnlyCollectionBase { /// - /// Initializes a new instance of based on another . + /// Initializes a new instance of based on another . /// public ToolboxItemCollection(ToolboxItemCollection value) { @@ -20,7 +20,7 @@ public ToolboxItemCollection(ToolboxItemCollection value) } /// - /// Initializes a new instance of containing any array of objects. + /// Initializes a new instance of containing any array of objects. /// public ToolboxItemCollection(ToolboxItem[] value) { @@ -28,7 +28,7 @@ public ToolboxItemCollection(ToolboxItem[] value) } /// - /// Represents the entry at the specified index of the . + /// Represents the entry at the specified index of the . /// public ToolboxItem this[int index] { @@ -39,7 +39,7 @@ public ToolboxItem this[int index] } /// - /// Gets a value indicating whether the + /// Gets a value indicating whether the /// contains the specified . /// public bool Contains(ToolboxItem value) @@ -48,7 +48,7 @@ public bool Contains(ToolboxItem value) } /// - /// Copies the values to a one-dimensional instance at the + /// Copies the values to a one-dimensional instance at the /// specified index. /// public void CopyTo(ToolboxItem[] array, int index) @@ -57,8 +57,8 @@ public void CopyTo(ToolboxItem[] array, int index) } /// - /// Returns the index of a in - /// the . + /// Returns the index of a in + /// the . /// public int IndexOf(ToolboxItem value) { diff --git a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCreatorCallback.cs b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCreatorCallback.cs index abca689e9e5..952e80e8a60 100644 --- a/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCreatorCallback.cs +++ b/src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItemCreatorCallback.cs @@ -5,7 +5,7 @@ namespace System.Drawing.Design { /// - /// method that will handle the ToolboxItemCreatorCallback event. + /// method that will handle the ToolboxItemCreatorCallback event. /// public delegate ToolboxItem ToolboxItemCreatorCallback(object serializedObject, string format); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AdornmentType.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AdornmentType.cs index bbcf7cebd91..5d10f94b761 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AdornmentType.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AdornmentType.cs @@ -5,20 +5,20 @@ namespace System.Windows.Forms.Design { /// - /// Specifies numeric IDs for different types of adornments on a component. + /// Specifies numeric IDs for different types of adornments on a component. /// internal enum AdornmentType { /// - /// Specifies the type as grab handle adornments. + /// Specifies the type as grab handle adornments. /// GrabHandle = 1, /// - /// Specifies the type as container selector adornments. + /// Specifies the type as container selector adornments. /// ContainerSelector = 2, /// - /// Specifies the type as the maximum size of any adornment. + /// Specifies the type as the maximum size of any adornment. /// Maximum = 3, } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AxImporter.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AxImporter.cs index c39c085d947..0d27fb4d07f 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AxImporter.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/AxImporter.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms.Design { /// - /// Imports ActiveX controls and generates a wrapper that can be accessed by a designer. + /// Imports ActiveX controls and generates a wrapper that can be accessed by a designer. /// public class AxImporter { @@ -22,86 +22,86 @@ public AxImporter(Options options) public sealed class Options { /// - /// The flag that controls when we sign the generated assemblies. + /// The flag that controls when we sign the generated assemblies. /// public bool delaySign = false; /// - /// Flag that controls whether we are to generate sources for the ActiveX control wrapper. + /// Flag that controls whether we are to generate sources for the ActiveX control wrapper. /// public bool genSources = false; /// - /// Regardless of which version of the library is registered, if at all, use the - /// path supplied on the command line for AxImp to generate the Windows Forms wrappers. + /// Regardless of which version of the library is registered, if at all, use the + /// path supplied on the command line for AxImp to generate the Windows Forms wrappers. /// public bool ignoreRegisteredOcx; /// - /// The file containing the strong name key container for the generated assemblies. + /// The file containing the strong name key container for the generated assemblies. /// public string keyContainer = null; /// - /// The file containing the strong name key for the generated assemblies. + /// The file containing the strong name key for the generated assemblies. /// public string keyFile = null; /// - /// The strong name used for the generated assemblies. + /// The strong name used for the generated assemblies. /// public StrongNameKeyPair keyPair = null; /// - /// Flag that controls whether we should output errors in the MSBuild format. + /// Flag that controls whether we should output errors in the MSBuild format. /// public bool msBuildErrors = false; /// - /// Flag that controls whether we should show the logo. + /// Flag that controls whether we should show the logo. /// public bool noLogo = false; /// - /// The output directory for all the generated assemblies. + /// The output directory for all the generated assemblies. /// public string outputDirectory = null; /// - /// The path-included filename of type library containing the definition of the ActiveX control. + /// The path-included filename of type library containing the definition of the ActiveX control. /// public string outputName = null; /// - /// The flag that controls whether we try to overwrite existing generated assemblies. + /// The flag that controls whether we try to overwrite existing generated assemblies. /// public bool overwriteRCW = false; /// - /// The public key used to sign the generated assemblies. + /// The public key used to sign the generated assemblies. /// public byte[] publicKey = null; /// - /// The object that allows us to resolve types and references needed to generate assemblies. + /// The object that allows us to resolve types and references needed to generate assemblies. /// public IReferenceResolver references = null; /// - /// Flag that controls the output generated. + /// Flag that controls the output generated. /// public bool silentMode = false; /// - /// Flag that controls the output generated. + /// Flag that controls the output generated. /// public bool verboseMode = false; } /// - /// The Reference Resolver service will try to look through the references it can obtain, - /// for a reference that matches the given criterion. For now, the only kind of references - /// it can look for are COM (RCW) references and ActiveX wrapper references. + /// The Reference Resolver service will try to look through the references it can obtain, + /// for a reference that matches the given criterion. For now, the only kind of references + /// it can look for are COM (RCW) references and ActiveX wrapper references. /// public interface IReferenceResolver { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/BaseContextMenuStrip.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/BaseContextMenuStrip.cs index 0bba4d83a73..c235979b03e 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/BaseContextMenuStrip.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/BaseContextMenuStrip.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design { /// - /// This class is going to replace the shell contextMenu and uses the ContextMenuStrip. The ContextMenuStrip contains groups and groupOrder which it uses to add items to itself. ControlDesigners can add custom items to the contextMenu, using the new member to the group and add the groupOrder to the ContextMenu. + /// This class is going to replace the shell contextMenu and uses the ContextMenuStrip. The ContextMenuStrip contains groups and groupOrder which it uses to add items to itself. ControlDesigners can add custom items to the contextMenu, using the new member to the group and add the groupOrder to the ContextMenu. /// internal class BaseContextMenuStrip : GroupedContextMenuStrip { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorDragDropEventArgs.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorDragDropEventArgs.cs index ddfa7e6fd36..b6e0a12f11e 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorDragDropEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorDragDropEventArgs.cs @@ -7,8 +7,8 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This class represents the arguments describing a BehaviorDragDrop event - /// fired by the BehaviorService. + /// This class represents the arguments describing a BehaviorDragDrop event + /// fired by the BehaviorService. /// public class BehaviorDragDropEventArgs : EventArgs { @@ -18,7 +18,7 @@ public BehaviorDragDropEventArgs(ICollection dragComponents) } /// - /// Returns the list of IComponents currently being dragged. + /// Returns the list of IComponents currently being dragged. /// public ICollection DragComponents { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorService.cs index fc344337962..99a08b6bcd5 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/BehaviorService.cs @@ -136,7 +136,7 @@ internal bool HasCapture } /// - /// Returns the LayoutMode setting of the current designer session. Either SnapLines or SnapToGrid. + /// Returns the LayoutMode setting of the current designer session. Either SnapLines or SnapToGrid. /// internal bool UseSnapLines { @@ -198,7 +198,7 @@ internal DesignerActionUI DesignerActionUI set => _actionPointer = value; } /// - /// Called by the DragAssistanceManager after a snapline/drag op has completed - we store this data for testing purposes. See TestHook_GetRecentSnapLines method. + /// Called by the DragAssistanceManager after a snapline/drag op has completed - we store this data for testing purposes. See TestHook_GetRecentSnapLines method. /// internal string[] RecentSnapLines { @@ -577,7 +577,7 @@ internal void OnLoseCapture() } /// - /// The AdornerWindow is a transparent window that resides ontop of the Designer's Frame. This window is used by the BehaviorService to intercept all messages. It also serves as a unified canvas on which to paint Glyphs. + /// The AdornerWindow is a transparent window that resides ontop of the Designer's Frame. This window is used by the BehaviorService to intercept all messages. It also serves as a unified canvas on which to paint Glyphs. /// private class AdornerWindow : Control { @@ -622,7 +622,7 @@ internal bool ProcessingDrag } /// - /// We'll use CreateHandle as our notification for creating our mouse attacher. + /// We'll use CreateHandle as our notification for creating our mouse attacher. /// protected override void OnHandleCreated(EventArgs e) { @@ -635,7 +635,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Unhook and null out our mouseHook. + /// Unhook and null out our mouseHook. /// protected override void OnHandleDestroyed(EventArgs e) { @@ -650,7 +650,7 @@ protected override void OnHandleDestroyed(EventArgs e) } /// - /// Null out our mouseHook and unhook any events. + /// Null out our mouseHook and unhook any events. /// protected override void Dispose(bool disposing) { @@ -665,7 +665,7 @@ protected override void Dispose(bool disposing) } /// - /// Returns true if the DesignerFrame is created & not being disposed. + /// Returns true if the DesignerFrame is created & not being disposed. /// internal Control DesignerFrame { @@ -673,7 +673,7 @@ internal Control DesignerFrame } /// - /// Returns the display rectangle for the adorner window + /// Returns the display rectangle for the adorner window /// internal Rectangle DesignerFrameDisplayRectangle { @@ -691,7 +691,7 @@ internal Rectangle DesignerFrameDisplayRectangle } /// - /// Returns true if the DesignerFrame is created & not being disposed. + /// Returns true if the DesignerFrame is created & not being disposed. /// internal bool DesignerFrameValid { @@ -708,7 +708,7 @@ internal bool DesignerFrameValid public IEnumerable Adorners { get; private set; } /// - /// Ultimately called by ControlDesigner when it receives a DragDrop message - here, we'll exit from 'drag mode'. + /// Ultimately called by ControlDesigner when it receives a DragDrop message - here, we'll exit from 'drag mode'. /// internal void EndDragNotification() { @@ -716,7 +716,7 @@ internal void EndDragNotification() } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow() { @@ -728,7 +728,7 @@ internal void InvalidateAdornerWindow() } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow(Region region) { @@ -744,7 +744,7 @@ internal void InvalidateAdornerWindow(Region region) } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow(Rectangle rectangle) { @@ -760,7 +760,7 @@ internal void InvalidateAdornerWindow(Rectangle rectangle) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnDragDrop(DragEventArgs e) { @@ -807,7 +807,7 @@ private static bool IsLocalDrag(DragEventArgs e) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnDragEnter(DragEventArgs e) { @@ -826,7 +826,7 @@ protected override void OnDragEnter(DragEventArgs e) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnDragLeave(EventArgs e) { @@ -843,7 +843,7 @@ protected override void OnDragLeave(EventArgs e) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnDragOver(DragEventArgs e) { @@ -860,7 +860,7 @@ protected override void OnDragOver(DragEventArgs e) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnGiveFeedback(GiveFeedbackEventArgs e) { @@ -868,7 +868,7 @@ protected override void OnGiveFeedback(GiveFeedbackEventArgs e) } /// - /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. + /// The AdornerWindow hooks all Drag/Drop notification so they can be forwarded to the appropriate Behavior via the BehaviorService. /// protected override void OnQueryContinueDrag(QueryContinueDragEventArgs e) { @@ -876,7 +876,7 @@ protected override void OnQueryContinueDrag(QueryContinueDragEventArgs e) } /// - /// Called by ControlDesigner when it receives a DragEnter message - we'll let listen to all Mouse Messages so we can send drag notifcations. + /// Called by ControlDesigner when it receives a DragEnter message - we'll let listen to all Mouse Messages so we can send drag notifcations. /// internal void StartDragNotification() { @@ -884,7 +884,7 @@ internal void StartDragNotification() } /// - /// The AdornerWindow intercepts all designer-related messages and forwards them to the BehaviorService for appropriate actions. Note that Paint and HitTest messages are correctly parsed and translated to AdornerWindow coords. + /// The AdornerWindow intercepts all designer-related messages and forwards them to the BehaviorService for appropriate actions. Note that Paint and HitTest messages are correctly parsed and translated to AdornerWindow coords. /// protected override void WndProc(ref Message m) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorBehavior.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorBehavior.cs index 9377cf780cc..aadc6ad96f6 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorBehavior.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorBehavior.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This behavior is associated with the ContainerGlyph offered up by ParentControlDesigner. This Behavior simply starts a new dragdrop behavior. + /// This behavior is associated with the ContainerGlyph offered up by ParentControlDesigner. This Behavior simply starts a new dragdrop behavior. /// internal sealed class ContainerSelectorBehavior : Behavior { @@ -25,7 +25,7 @@ internal sealed class ContainerSelectorBehavior : Behavior private readonly bool _setInitialDragPoint; /// - /// Constructor, here we cache off all of our member vars and sync location & size changes. + /// Constructor, here we cache off all of our member vars and sync location & size changes. /// internal ContainerSelectorBehavior(Control containerControl, IServiceProvider serviceProvider) { @@ -34,7 +34,7 @@ internal ContainerSelectorBehavior(Control containerControl, IServiceProvider se } /// - /// Constructor, here we cache off all of our member vars and sync location & size changes. + /// Constructor, here we cache off all of our member vars and sync location & size changes. /// internal ContainerSelectorBehavior(Control containerControl, IServiceProvider serviceProvider, bool setInitialDragPoint) { @@ -63,7 +63,7 @@ public Control ContainerControl } /// - /// This will be true when we detect a mousedown on our glyph. The Glyph can use this state to always return 'true' from hittesting indicating that it would like all messages (like mousemove). + /// This will be true when we detect a mousedown on our glyph. The Glyph can use this state to always return 'true' from hittesting indicating that it would like all messages (like mousemove). /// public bool OkToMove { @@ -78,7 +78,7 @@ public Point InitialDragPoint } /// - /// If the user selects the containerglyph - select our related component. + /// If the user selects the containerglyph - select our related component. /// public override bool OnMouseDown(Glyph g, MouseButtons button, Point mouseLoc) { @@ -151,7 +151,7 @@ private Point DetermineInitialDragPoint(Point mouseLoc) } /// - /// We will compare the mouse loc to the initial point (set in onmousedown) and if we're far enough, we'll create a dropsourcebehavior object and start out drag operation! + /// We will compare the mouse loc to the initial point (set in onmousedown) and if we're far enough, we'll create a dropsourcebehavior object and start out drag operation! /// public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) { @@ -174,7 +174,7 @@ public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) } /// - /// Simply clear the initial drag point, so we can start again on the next mouse down. + /// Simply clear the initial drag point, so we can start again on the next mouse down. /// public override bool OnMouseUp(Glyph g, MouseButtons button) { @@ -184,7 +184,7 @@ public override bool OnMouseUp(Glyph g, MouseButtons button) } /// - /// Called when we've identified that we want to start a drag operation with our data container. + /// Called when we've identified that we want to start a drag operation with our data container. /// private void StartDragOperation(Point initialMouseLocation) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorGlyph.cs index 0d6cd394a4d..dd022d0b767 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ContainerSelectorGlyph.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This is the glyph used to drag container controls around the designer. This glyph (and associated behavior) is created by the ParentControlDesigner. + /// This is the glyph used to drag container controls around the designer. This glyph (and associated behavior) is created by the ParentControlDesigner. /// internal sealed class ContainerSelectorGlyph : Glyph { @@ -15,7 +15,7 @@ internal sealed class ContainerSelectorGlyph : Glyph private readonly ContainerSelectorBehavior _relatedBehavior; /// - /// ContainerSelectorGlyph constructor. + /// ContainerSelectorGlyph constructor. /// internal ContainerSelectorGlyph(Rectangle containerBounds, int glyphSize, int glyphOffset, ContainerSelectorBehavior behavior) : base(behavior) { @@ -24,7 +24,7 @@ internal ContainerSelectorGlyph(Rectangle containerBounds, int glyphSize, int gl } /// - /// The bounds of this Glyph. + /// The bounds of this Glyph. /// public override Rectangle Bounds { @@ -37,7 +37,7 @@ public Behavior RelatedBehavior } /// - /// Simple hit test rule: if the point is contained within the bounds - then it is a positive hit test. + /// Simple hit test rule: if the point is contained within the bounds - then it is a positive hit test. /// public override Cursor GetHitTest(Point p) { @@ -62,7 +62,7 @@ private Bitmap MoveGlyph } /// - /// Very simple paint logic. + /// Very simple paint logic. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionBehavior.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionBehavior.cs index e4e33bd3513..55399cf415d 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionBehavior.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionBehavior.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This is the Behavior that represents DesignerActions for a particular control. The DesignerActionBehavior is responsible for responding to the MouseDown message and either 1) selecting the control and changing the DesignerActionGlyph's image or 2) building up a chrome menu and requesting it to be shown. Also, this Behavior acts as a proxy between "clicked" context menu items and the actual DesignerActions that they represent. + /// This is the Behavior that represents DesignerActions for a particular control. The DesignerActionBehavior is responsible for responding to the MouseDown message and either 1) selecting the control and changing the DesignerActionGlyph's image or 2) building up a chrome menu and requesting it to be shown. Also, this Behavior acts as a proxy between "clicked" context menu items and the actual DesignerActions that they represent. /// internal sealed class DesignerActionBehavior : Behavior { @@ -23,7 +23,7 @@ internal sealed class DesignerActionBehavior : Behavior private bool _ignoreNextMouseUp = false; /// - /// Constructor that calls base and caches off the action lists. + /// Constructor that calls base and caches off the action lists. /// internal DesignerActionBehavior(IServiceProvider serviceProvider, IComponent relatedComponent, DesignerActionListCollection actionLists, DesignerActionUI parentUI) { @@ -34,7 +34,7 @@ internal DesignerActionBehavior(IServiceProvider serviceProvider, IComponent rel } /// - /// Returns the collection of DesignerActionLists this Behavior is managing. These will be dynamically updated (some can be removed, new ones can be added, etc...). + /// Returns the collection of DesignerActionLists this Behavior is managing. These will be dynamically updated (some can be removed, new ones can be added, etc...). /// internal DesignerActionListCollection ActionLists { @@ -43,7 +43,7 @@ internal DesignerActionListCollection ActionLists } /// - /// Returns the parenting UI (a DesignerActionUI) + /// Returns the parenting UI (a DesignerActionUI) /// internal DesignerActionUI ParentUI { @@ -51,7 +51,7 @@ internal DesignerActionUI ParentUI } /// - /// Returns the Component that this glyph is attached to. + /// Returns the Component that this glyph is attached to. /// internal IComponent RelatedComponent { @@ -59,7 +59,7 @@ internal IComponent RelatedComponent } /// - /// Hides the designer action panel UI. + /// Hides the designer action panel UI. /// internal void HideUI() { @@ -77,7 +77,7 @@ internal DesignerActionPanel CreateDesignerActionPanel(IComponent relatedCompone } /// - /// Shows the designer action panel UI associated with this glyph. + /// Shows the designer action panel UI associated with this glyph. /// internal void ShowUI(Glyph g) { @@ -110,7 +110,7 @@ public override bool OnMouseDown(Glyph g, MouseButtons button, Point mouseLoc) } /// - /// In response to a MouseUp, we will either 1) select the Glyph and control if not selected, or 2) Build up our context menu representing our DesignerActions and show it. + /// In response to a MouseUp, we will either 1) select the Glyph and control if not selected, or 2) Build up our context menu representing our DesignerActions and show it. /// public override bool OnMouseUp(Glyph g, MouseButtons button) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionGlyph.cs index 67df4dcf18d..a4eb991d3e6 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DesignerActionGlyph.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This Glyph represents the UI appended to a control when DesignerActions are available. Each image that represents these states are demand created. This is done because it is entirely possible that a DesignerActionGlyph will only ever be in one of these states during its lifetime... kind of sad really. + /// This Glyph represents the UI appended to a control when DesignerActions are available. Each image that represents these states are demand created. This is done because it is entirely possible that a DesignerActionGlyph will only ever be in one of these states during its lifetime... kind of sad really. /// internal sealed class DesignerActionGlyph : Glyph { @@ -27,7 +27,7 @@ internal sealed class DesignerActionGlyph : Glyph private Bitmap _glyphImageOpened; /// - /// Constructor that passes empty alternative bounds and parents. Typically this is done for control on the designer's surface since component tray glyphs will have these alternative values. + /// Constructor that passes empty alternative bounds and parents. Typically this is done for control on the designer's surface since component tray glyphs will have these alternative values. /// public DesignerActionGlyph(DesignerActionBehavior behavior, Adorner adorner) : this(behavior, adorner, Rectangle.Empty, null) { } @@ -35,7 +35,7 @@ public DesignerActionGlyph(DesignerActionBehavior behavior, Rectangle alternativ { } /// - /// Constructor that sets the dropdownbox size, creates a our hottrack brush and invalidates the glyph (to configure location). + /// Constructor that sets the dropdownbox size, creates a our hottrack brush and invalidates the glyph (to configure location). /// private DesignerActionGlyph(DesignerActionBehavior behavior, Adorner adorner, Rectangle alternativeBounds, Control alternativeParent) : base(behavior) { @@ -46,7 +46,7 @@ private DesignerActionGlyph(DesignerActionBehavior behavior, Adorner adorner, Re } /// - /// Returns the bounds of our glyph. This is used by the related Behavior to determine where to show the contextmenu (list of actions). + /// Returns the bounds of our glyph. This is used by the related Behavior to determine where to show the contextmenu (list of actions). /// public override Rectangle Bounds { @@ -71,7 +71,7 @@ public bool IsInComponentTray } /// - /// Standard hit test logic that returns true if the point is contained within our bounds. This is also used to manage out mouse over state. + /// Standard hit test logic that returns true if the point is contained within our bounds. This is also used to manage out mouse over state. /// public override Cursor GetHitTest(Point p) { @@ -85,7 +85,7 @@ public override Cursor GetHitTest(Point p) } /// - /// Returns an image representing the + /// Returns an image representing the /// private Image GlyphImageClosed { @@ -134,7 +134,7 @@ internal void InvalidateOwnerLocation() } /// - /// Called when the state for this DesignerActionGlyph changes. Or when the related component's size or location change. Here, we re-calculate the Glyph's bounds and change our image. + /// Called when the state for this DesignerActionGlyph changes. Or when the related component's size or location change. Here, we re-calculate the Glyph's bounds and change our image. /// internal void Invalidate() { @@ -168,7 +168,7 @@ internal void Invalidate() } /// - /// Used to manage the mouse-pointer-is-over-glyph state. If this is true, then we will shade our BoxImage in the Paint logic. + /// Used to manage the mouse-pointer-is-over-glyph state. If this is true, then we will shade our BoxImage in the Paint logic. /// private bool MouseOver { @@ -185,7 +185,7 @@ private bool MouseOver } /// - /// Responds to a paint event. This Glyph will paint its current image and, if MouseHover is true, we'll paint over the image with the 'hoverBrush'. + /// Responds to a paint event. This Glyph will paint its current image and, if MouseHover is true, we'll paint over the image with the 'hoverBrush'. /// public override void Paint(PaintEventArgs pe) { @@ -223,7 +223,7 @@ public override void Paint(PaintEventArgs pe) } /// - /// Called by the ComponentTray when a tray control changes location. + /// Called by the ComponentTray when a tray control changes location. /// internal void UpdateAlternativeBounds(Rectangle newBounds) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DragAssistanceManager.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DragAssistanceManager.cs index e91e673c1d5..6caa9e3441c 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DragAssistanceManager.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DragAssistanceManager.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The DragAssistanceManager, for lack of a better name, is responsible for integrating SnapLines into the DragBehavior. At the beginning of a DragBehavior this class is instantiated and at every mouse move this class is called and given the opportunity to adjust the position of the drag. The DragAssistanceManager needs to work as fast as possible - so not to interupt a drag operation. Because of this, this class has many global variables that are re-used, in hopes to limit the # of allocations per mouse move / drag operation. Also, for loops are used extensively (instead of foreach calls) to eliminate the creation of an enumerator. + /// The DragAssistanceManager, for lack of a better name, is responsible for integrating SnapLines into the DragBehavior. At the beginning of a DragBehavior this class is instantiated and at every mouse move this class is called and given the opportunity to adjust the position of the drag. The DragAssistanceManager needs to work as fast as possible - so not to interupt a drag operation. Because of this, this class has many global variables that are re-used, in hopes to limit the # of allocations per mouse move / drag operation. Also, for loops are used extensively (instead of foreach calls) to eliminate the creation of an enumerator. /// internal sealed class DragAssistanceManager { @@ -53,36 +53,36 @@ internal sealed class DragAssistanceManager private readonly bool _ctrlDrag; // Are we in a ctrl-drag? /// - /// Internal constructor called that only takes a service provider. Here it is assumed that all painting will be done to the AdornerWindow and that there are no target controsl to exclude from snapping. + /// Internal constructor called that only takes a service provider. Here it is assumed that all painting will be done to the AdornerWindow and that there are no target controsl to exclude from snapping. /// internal DragAssistanceManager(IServiceProvider serviceProvider) : this(serviceProvider, null, null, null, false, false) { } /// - /// Internal constructor that takes the service provider and the list of dragCompoents. + /// Internal constructor that takes the service provider and the list of dragCompoents. /// internal DragAssistanceManager(IServiceProvider serviceProvider, ArrayList dragComponents) : this(serviceProvider, null, dragComponents, null, false, false) { } /// - /// Internal constructor that takes the service provider, the list of dragCompoents, and a boolean - /// indicating that we are resizing. + /// Internal constructor that takes the service provider, the list of dragCompoents, and a boolean + /// indicating that we are resizing. /// internal DragAssistanceManager(IServiceProvider serviceProvider, ArrayList dragComponents, bool resizing) : this(serviceProvider, null, dragComponents, null, resizing, false) { } /// - /// Internal constructor called by DragBehavior. + /// Internal constructor called by DragBehavior. /// internal DragAssistanceManager(IServiceProvider serviceProvider, Graphics graphics, ArrayList dragComponents, Image backgroundImage, bool ctrlDrag) : this(serviceProvider, graphics, dragComponents, backgroundImage, false, ctrlDrag) { } /// - /// Internal constructor called by DragBehavior. + /// Internal constructor called by DragBehavior. /// internal DragAssistanceManager(IServiceProvider serviceProvider, Graphics graphics, ArrayList dragComponents, Image backgroundImage, bool resizing, bool ctrlDrag) { @@ -126,7 +126,7 @@ internal DragAssistanceManager(IServiceProvider serviceProvider, Graphics graphi } /// - /// Adjusts then adds each snap line the designer has to offer to either our global horizontal and vertical lists or our target lists. Note that we also keep track of our target snapline types - 'cause we can safely ignore all other types. If valid target is false- then we don't yet know what we're snapping against - so we'll exclude the check below to skip unwanted snap line types. + /// Adjusts then adds each snap line the designer has to offer to either our global horizontal and vertical lists or our target lists. Note that we also keep track of our target snapline types - 'cause we can safely ignore all other types. If valid target is false- then we don't yet know what we're snapping against - so we'll exclude the check below to skip unwanted snap line types. /// private void AddSnapLines(ControlDesigner controlDesigner, ArrayList horizontalList, ArrayList verticalList, bool isTarget, bool validTarget) { @@ -194,7 +194,7 @@ private void AddSnapLines(ControlDesigner controlDesigner, ArrayList horizontalL } /// - /// Build up a distance array of all same-type-alignment pts to the closest point on our targetControl. Also, keep track of the smallest distance overall. + /// Build up a distance array of all same-type-alignment pts to the closest point on our targetControl. Also, keep track of the smallest distance overall. /// private int BuildDistanceArray(ArrayList snapLines, ArrayList targetSnapLines, int[] distances, Rectangle dragBounds) { @@ -246,7 +246,7 @@ private int BuildDistanceArray(ArrayList snapLines, ArrayList targetSnapLines, i } /// - /// Here, we erase all of our old horizontal and vertical snaplines UNLESS they are also contained in our tempHorzLines or tempVertLines arrays - if they are - then erasing them would be redundant (since we know we want to draw them on this mousemove) + /// Here, we erase all of our old horizontal and vertical snaplines UNLESS they are also contained in our tempHorzLines or tempVertLines arrays - if they are - then erasing them would be redundant (since we know we want to draw them on this mousemove) /// private Line[] EraseOldSnapLines(Line[] lines, ArrayList tempLines) { @@ -325,7 +325,7 @@ internal void EraseSnapLines() } /// - /// This internal method returns a snap line[] representing the last SnapLines that were rendered before this algorithm was stopped (usually by an OnMouseUp). This is used for storing additional toolbox drag/drop info and testing hooks. + /// This internal method returns a snap line[] representing the last SnapLines that were rendered before this algorithm was stopped (usually by an OnMouseUp). This is used for storing additional toolbox drag/drop info and testing hooks. /// internal Line[] GetRecentLines() { @@ -408,7 +408,7 @@ private bool AddControlSnaplinesWhenResizing(ControlDesigner designer, Control c } /// - /// Initializes our class - we cache all snap lines for every control we can find. This is done for perf. reasons. + /// Initializes our class - we cache all snap lines for every control we can find. This is done for perf. reasons. /// private void Initialize(ArrayList dragComponents, IDesignerHost host) { @@ -494,7 +494,7 @@ private void Initialize(ArrayList dragComponents, IDesignerHost host) } /// - /// Helper function that determines if the child control is related to the parent. + /// Helper function that determines if the child control is related to the parent. /// private static bool IsChildOfParent(Control child, Control parent) { @@ -515,7 +515,7 @@ private static bool IsChildOfParent(Control child, Control parent) } /// - /// Helper function that identifies margin or padding snaplines + /// Helper function that identifies margin or padding snaplines /// private static bool IsMarginOrPaddingSnapLine(SnapLine snapLine) { @@ -523,7 +523,7 @@ private static bool IsMarginOrPaddingSnapLine(SnapLine snapLine) } /// - /// Returns the offset in which the targetControl's rect needs to be re-positioned (given the direction by 'directionOffset') in order to align with the nearest possible snapline. This is called by commandSet during keyboard movements to auto-snap the control around the designer. + /// Returns the offset in which the targetControl's rect needs to be re-positioned (given the direction by 'directionOffset') in order to align with the nearest possible snapline. This is called by commandSet during keyboard movements to auto-snap the control around the designer. /// internal Point OffsetToNearestSnapLocation(Control targetControl, IList targetSnaplines, Point directionOffset) { @@ -545,7 +545,7 @@ internal Point OffsetToNearestSnapLocation(Control targetControl, IList targetSn } /// - /// Returns the offset in which the targetControl's rect needs to be re-positioned (given the direction by 'directionOffset') in order to align with the nearest possible snapline. This is called by commandSet during keyboard movements to auto-snap the control around the designer. + /// Returns the offset in which the targetControl's rect needs to be re-positioned (given the direction by 'directionOffset') in order to align with the nearest possible snapline. This is called by commandSet during keyboard movements to auto-snap the control around the designer. /// internal Point OffsetToNearestSnapLocation(Control targetControl, Point directionOffset) { @@ -672,7 +672,7 @@ private static int SmallestDistanceIndex(int[] distances, int direction, out int } /// - /// Actually draws the snaplines based on type, location, and specified pen + /// Actually draws the snaplines based on type, location, and specified pen /// private void RenderSnapLines(Line[] lines, Rectangle dragRect) { @@ -752,7 +752,7 @@ private void RenderSnapLines(Line[] lines, Rectangle dragRect) } /// - /// Performance improvement: Given an snapline we will render, check if it overlaps with an existing snapline. If so, combine the two. + /// Performance improvement: Given an snapline we will render, check if it overlaps with an existing snapline. If so, combine the two. /// private static void CombineSnaplines(Line snapLine, ArrayList currentLines) { @@ -774,7 +774,7 @@ private static void CombineSnaplines(Line snapLine, ArrayList currentLines) } /// - /// Here, we store all the SnapLines we will render. This way we can erase them when they are no longer needed. + /// Here, we store all the SnapLines we will render. This way we can erase them when they are no longer needed. /// private void StoreSnapLine(SnapLine snapLine, Rectangle dragBounds) { @@ -842,7 +842,7 @@ private void StoreSnapLine(SnapLine snapLine, Rectangle dragBounds) } /// - /// This function validates a Margin or Padding SnapLine. A valid Margin SnapLine is one that will be drawn only if the target control being dragged somehow intersects (vertically or horizontally) the coords of the given snapLine. This is done so we don't start drawing margin lines when controls are large distances apart (too much mess); + /// This function validates a Margin or Padding SnapLine. A valid Margin SnapLine is one that will be drawn only if the target control being dragged somehow intersects (vertically or horizontally) the coords of the given snapLine. This is done so we don't start drawing margin lines when controls are large distances apart (too much mess); /// private bool ValidateMarginOrPaddingLine(SnapLine snapLine, Rectangle dragBounds) { @@ -886,7 +886,7 @@ internal Point OnMouseMove(Rectangle dragBounds, SnapLine[] snapLines) } /// - /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. + /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. /// internal Point OnMouseMove(Rectangle dragBounds, SnapLine[] snapLines, ref bool didSnap, bool shouldSnapHorizontally) { @@ -912,7 +912,7 @@ internal Point OnMouseMove(Rectangle dragBounds, SnapLine[] snapLines, ref bool } /// - /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. + /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. /// internal Point OnMouseMove(Rectangle dragBounds) { @@ -921,7 +921,7 @@ internal Point OnMouseMove(Rectangle dragBounds) } /// - /// Called by the resizebehavior. It needs to know whether we really snapped or not. The snapPoint could be (0,0) even though we snapped. + /// Called by the resizebehavior. It needs to know whether we really snapped or not. The snapPoint could be (0,0) even though we snapped. /// internal Point OnMouseMove(Control targetControl, SnapLine[] snapLines, ref bool didSnap, bool shouldSnapHorizontally) { @@ -931,7 +931,7 @@ internal Point OnMouseMove(Control targetControl, SnapLine[] snapLines, ref bool } /// - /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. + /// Called by the DragBehavior on every mouse move. We first offset all of our drag-control's snap lines by the amount of the mouse move then follow our 2-pass heuristic to determine which SnapLines to render. /// private Point OnMouseMove(Rectangle dragBounds, bool offsetSnapLines, ref bool didSnap, bool shouldSnapHorizontally) { @@ -992,7 +992,7 @@ private Point OnMouseMove(Rectangle dragBounds, bool offsetSnapLines, ref bool d //NOTE NOTE NOTE: If OnMouseMove is called during a resize operation, then cachedDragRect is not guaranteed to work. That is why I introduced RenderSnapLinesInternal(dragRect) /// - /// Called by the ResizeBehavior after it has finished drawing + /// Called by the ResizeBehavior after it has finished drawing /// internal void RenderSnapLinesInternal(Rectangle dragRect) { @@ -1001,7 +1001,7 @@ internal void RenderSnapLinesInternal(Rectangle dragRect) } /// - /// Called by the DropSourceBehavior after it finished drawing its' draging images so that we can draw our lines on top of everything. + /// Called by the DropSourceBehavior after it finished drawing its' draging images so that we can draw our lines on top of everything. /// internal void RenderSnapLinesInternal() { @@ -1013,7 +1013,7 @@ internal void RenderSnapLinesInternal() } /// - /// Clean up all of our references. + /// Clean up all of our references. /// internal void OnMouseUp() { @@ -1047,7 +1047,7 @@ internal void OnMouseUp() } /// - /// Our 'line' class - used to manage two points and calculate the difference between any two lines. + /// Our 'line' class - used to manage two points and calculate the difference between any two lines. /// internal class Line { @@ -1145,7 +1145,7 @@ public override string ToString() } /// - /// Describes different types of lines (used for margins, etc..) + /// Describes different types of lines (used for margins, etc..) /// internal enum LineType { @@ -1153,7 +1153,7 @@ internal enum LineType } /// - /// Describes what kind of padding line we have + /// Describes what kind of padding line we have /// internal enum PaddingLineType { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DropSourceBehavior.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DropSourceBehavior.cs index b7e0373388a..962cb1a3ebd 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DropSourceBehavior.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/DropSourceBehavior.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The DropSourceBehavior is created by ControlDesigner when it detects that a drag operation has started. This object is passed to the BehaviorService and is used to route GiveFeedback and QueryContinueDrag drag/drop messages. In response to GiveFeedback messages, this class will render the dragging controls in real-time with the help of the DragAssistanceManager (Snaplines) object or by simply snapping to grid dots. + /// The DropSourceBehavior is created by ControlDesigner when it detects that a drag operation has started. This object is passed to the BehaviorService and is used to route GiveFeedback and QueryContinueDrag drag/drop messages. In response to GiveFeedback messages, this class will render the dragging controls in real-time with the help of the DragAssistanceManager (Snaplines) object or by simply snapping to grid dots. /// internal sealed class DropSourceBehavior : Behavior, IComparer { @@ -70,7 +70,7 @@ private struct DragComponent private int primaryComponentIndex = -1; // Index of the primary component (control) in dragComponents /// - /// Constuctor that caches all needed vars for perf reasons. + /// Constuctor that caches all needed vars for perf reasons. /// internal DropSourceBehavior(ICollection dragComponents, Control source, Point initialMouseLocation) { @@ -115,7 +115,7 @@ internal DropSourceBehavior(ICollection dragComponents, Control source, Point in } /// - /// This is the initial allowed Effect to start the drag operation with. + /// This is the initial allowed Effect to start the drag operation with. /// internal DragDropEffects AllowedEffects { @@ -123,7 +123,7 @@ internal DragDropEffects AllowedEffects } /// - /// This is the DataObject this DropSourceBehavior represents. + /// This is the DataObject this DropSourceBehavior represents. /// internal DataObject DataObject { @@ -131,7 +131,7 @@ internal DataObject DataObject } /// - /// Here, during our drag operation, we need to determine the offset from the dragging control's position 'dragLoc' and the parent's grid. We'll return an offset for the image to 'snap to'. + /// Here, during our drag operation, we need to determine the offset from the dragging control's position 'dragLoc' and the parent's grid. We'll return an offset for the image to 'snap to'. /// private Point AdjustToGrid(Point dragLoc) { @@ -190,7 +190,7 @@ private Point MapPointFromTargetToSource(Point pt) } /// - /// This is used to clear the drag images. + /// This is used to clear the drag images. /// private void ClearAllDragImages() { @@ -287,7 +287,7 @@ private void SetLocationPropertyAndChildIndex(int dragComponentIndex, Control dr } /// - /// This is where we end the drag and commit the new control locations. To do this correctly, we loop through every control and find its propertyDescriptor for the Location. Then call SetValue(). After this we re-enable the adorners. Finally, we pop ourselves from the BehaviorStack. + /// This is where we end the drag and commit the new control locations. To do this correctly, we loop through every control and find its propertyDescriptor for the Location. Then call SetValue(). After this we re-enable the adorners. Finally, we pop ourselves from the BehaviorStack. /// private void EndDragDrop(bool allowSetChildIndexOnDrop) { @@ -589,7 +589,7 @@ private void EndDragDrop(bool allowSetChildIndexOnDrop) } /// - /// Called by the BehaviorService when the GiveFeedback event is fired. Here, we attempt to render all of our dragging control snapshots. *After, of course, we let the DragAssistanceManager adjust the position due to any SnapLine activity. + /// Called by the BehaviorService when the GiveFeedback event is fired. Here, we attempt to render all of our dragging control snapshots. *After, of course, we let the DragAssistanceManager adjust the position due to any SnapLine activity. /// internal void GiveFeedback(object sender, GiveFeedbackEventArgs e) { @@ -837,7 +837,7 @@ internal void GiveFeedback(object sender, GiveFeedbackEventArgs e) } /// - /// We want to sort the dragComponents in descending z-order. We want to make sure that we draw the control lowest in the z-order first, and drawing the control at the top of the z-order last. Remember that z-order indices are in reverse order. I.e. the control that is at the top of the z-order list has the lowest z-order index. + /// We want to sort the dragComponents in descending z-order. We want to make sure that we draw the control lowest in the z-order first, and drawing the control at the top of the z-order last. Remember that z-order indices are in reverse order. I.e. the control that is at the top of the z-order list has the lowest z-order index. /// int IComparer.Compare(object x, object y) { @@ -912,7 +912,7 @@ private void DisableAdorners(IServiceProvider serviceProvider, BehaviorService b } /// - /// Called when the ContolDesigner starts a drag operation. Here, all adorners are disabled, screen shots of all related controls are taken, and the DragAssistanceManager (for SnapLines) is created. + /// Called when the ContolDesigner starts a drag operation. Here, all adorners are disabled, screen shots of all related controls are taken, and the DragAssistanceManager (for SnapLines) is created. /// private void InitiateDrag(Point initialMouseLocation, ICollection dragComps) { @@ -1050,7 +1050,7 @@ internal ArrayList GetSortedDragControls(ref int primaryControlIndex) } /// - /// Called by the BehaviorService in response to QueryContinueDrag notifications. + /// Called by the BehaviorService in response to QueryContinueDrag notifications. /// internal void QueryContinueDrag(object sender, QueryContinueDragEventArgs e) { @@ -1077,7 +1077,7 @@ internal void QueryContinueDrag(object sender, QueryContinueDragEventArgs e) } /// - /// Changes the Visible state of the controls we are dragging. Returns whether we change state or not. + /// Changes the Visible state of the controls we are dragging. Returns whether we change state or not. /// internal bool ShowHideDragControls(bool show) { @@ -1174,7 +1174,7 @@ internal void CleanupDrag(bool clearImages) } /// - /// This class extends from DataObject and carries additional information such as: the list of Controls currently being dragged and the drag 'Source'. + /// This class extends from DataObject and carries additional information such as: the list of Controls currently being dragged and the drag 'Source'. /// internal class BehaviorDataObject : DataObject { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyph.cs index 9488a97f431..42be47501fe 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyph.cs @@ -8,14 +8,14 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The GrabHandleGlyph represents the 8 handles of our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. + /// The GrabHandleGlyph represents the 8 handles of our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. /// internal class GrabHandleGlyph : SelectionGlyphBase { private readonly bool _isPrimary = false; /// - /// GrabHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. + /// GrabHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. /// internal GrabHandleGlyph(Rectangle controlBounds, GrabHandleGlyphType type, Behavior behavior, bool primarySelection) : base(behavior) { @@ -91,7 +91,7 @@ internal GrabHandleGlyph(Rectangle controlBounds, GrabHandleGlyphType type, Beha } /// - /// Very simple paint logic. + /// Very simple paint logic. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyphType.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyphType.cs index 0999a86dacd..7f225924bbb 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyphType.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/GrabHandleGlyphType.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// Describes the type of GrabHandle the GrabHandleGlyph represents. + /// Describes the type of GrabHandle the GrabHandleGlyph represents. /// internal enum GrabHandleGlyphType { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedBorderGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedBorderGlyph.cs index 0198cfd8506..7386d1702cc 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedBorderGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedBorderGlyph.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The LockedBorderGlyph draws one side (depending on type) of a SelectionBorder in the 'Locked' mode The constructor will initialize and cache the pen and brush objects to avoid uneccessary recreations. + /// The LockedBorderGlyph draws one side (depending on type) of a SelectionBorder in the 'Locked' mode The constructor will initialize and cache the pen and brush objects to avoid uneccessary recreations. /// internal class LockedBorderGlyph : SelectionGlyphBase { /// - /// This constructor extends from the standard SelectionGlyphBase constructor. Note that a primarySelection flag is passed in - this will be used when determining the colors of the borders. + /// This constructor extends from the standard SelectionGlyphBase constructor. Note that a primarySelection flag is passed in - this will be used when determining the colors of the borders. /// internal LockedBorderGlyph(Rectangle controlBounds, SelectionBorderGlyphType type) : base(null) { @@ -20,7 +20,7 @@ internal LockedBorderGlyph(Rectangle controlBounds, SelectionBorderGlyphType typ } /// - /// Helper function that initializes the Glyph based on bounds, type, primary sel, and bordersize. + /// Helper function that initializes the Glyph based on bounds, type, primary sel, and bordersize. /// private void InitializeGlyph(Rectangle controlBounds, SelectionBorderGlyphType type) { @@ -33,7 +33,7 @@ private void InitializeGlyph(Rectangle controlBounds, SelectionBorderGlyphType t } /// - /// Simple painting logic for locked Glyphs. + /// Simple painting logic for locked Glyphs. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedHandleGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedHandleGlyph.cs index f5adc9e291f..394d1780b0e 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedHandleGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/LockedHandleGlyph.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The LockedHandleGlyph represents the handle for a non-resizeable control in our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. + /// The LockedHandleGlyph represents the handle for a non-resizeable control in our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. /// internal class LockedHandleGlyph : SelectionGlyphBase { private readonly bool _isPrimary = false; /// - /// LockedHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. + /// LockedHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. /// internal LockedHandleGlyph(Rectangle controlBounds, bool primarySelection) : base(null) { @@ -28,7 +28,7 @@ internal LockedHandleGlyph(Rectangle controlBounds, bool primarySelection) : bas } /// - /// Very simple paint logic. + /// Very simple paint logic. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/MiniLockedBorderGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/MiniLockedBorderGlyph.cs index 782e27253ee..43e9547c162 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/MiniLockedBorderGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/MiniLockedBorderGlyph.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The LockedBorderGlyph draws one side (depending on type) of a SelectionBorder in the 'Locked' mode. The constructor will initialize and cache the pen and brush objects to avoid uneccessary recreations. + /// The LockedBorderGlyph draws one side (depending on type) of a SelectionBorder in the 'Locked' mode. The constructor will initialize and cache the pen and brush objects to avoid uneccessary recreations. /// internal class MiniLockedBorderGlyph : SelectionGlyphBase { @@ -16,7 +16,7 @@ internal class MiniLockedBorderGlyph : SelectionGlyphBase internal SelectionBorderGlyphType Type { get => _type; set => _type = value; } /// - /// This constructor extends from the standard SelectionGlyphBase constructor. Note that a primarySelection flag is passed in - this will be used when determining the colors of the borders. + /// This constructor extends from the standard SelectionGlyphBase constructor. Note that a primarySelection flag is passed in - this will be used when determining the colors of the borders. /// internal MiniLockedBorderGlyph(Rectangle controlBounds, SelectionBorderGlyphType type, Behavior behavior, bool primarySelection) : base(behavior) { @@ -24,7 +24,7 @@ internal MiniLockedBorderGlyph(Rectangle controlBounds, SelectionBorderGlyphType } /// - /// Helper function that initializes the Glyph based on bounds, type, primary sel, and bordersize. + /// Helper function that initializes the Glyph based on bounds, type, primary sel, and bordersize. /// private void InitializeGlyph(Rectangle controlBounds, SelectionBorderGlyphType type) { @@ -38,7 +38,7 @@ private void InitializeGlyph(Rectangle controlBounds, SelectionBorderGlyphType t } /// - /// Simple painting logic for locked Glyphs. + /// Simple painting logic for locked Glyphs. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeHandleGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeHandleGlyph.cs index 59cb8546f1c..a7301aa40df 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeHandleGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeHandleGlyph.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The NoResizeHandleGlyph represents the handle for a non-resizeable control in our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. + /// The NoResizeHandleGlyph represents the handle for a non-resizeable control in our new seleciton model. Note that the pen and brush are created once per instance of this class and re-used in our painting logic for perf. reasonse. /// internal class NoResizeHandleGlyph : SelectionGlyphBase { private readonly bool _isPrimary = false; /// - /// NoResizeHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. + /// NoResizeHandleGlyph's constructor takes additional parameters: 'type' and 'primary selection'. Also, we create/cache our pen & brush here to avoid this action with every paint message. /// internal NoResizeHandleGlyph(Rectangle controlBounds, SelectionRules selRules, bool primarySelection, Behavior behavior) : base(behavior) { @@ -33,7 +33,7 @@ internal NoResizeHandleGlyph(Rectangle controlBounds, SelectionRules selRules, b } /// - /// Very simple paint logic. + /// Very simple paint logic. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeSelectionBorderGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeSelectionBorderGlyph.cs index d8e0f83a82d..67e6a2a70b6 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeSelectionBorderGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/NoResizeSelectionBorderGlyph.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The NoResizeSelectionBorderGlyph draws one side (depending on type) of a SelectionBorder. + /// The NoResizeSelectionBorderGlyph draws one side (depending on type) of a SelectionBorder. /// internal class NoResizeSelectionBorderGlyph : SelectionGlyphBase { /// - /// This constructor extends from the standard SelectionGlyphBase constructor. + /// This constructor extends from the standard SelectionGlyphBase constructor. /// internal NoResizeSelectionBorderGlyph(Rectangle controlBounds, SelectionRules rules, SelectionBorderGlyphType type, Behavior behavior) : base(behavior) { @@ -20,7 +20,7 @@ internal NoResizeSelectionBorderGlyph(Rectangle controlBounds, SelectionRules ru } /// - /// Helper function that initializes the Glyph based on bounds, type, and bordersize. + /// Helper function that initializes the Glyph based on bounds, type, and bordersize. /// private void InitializeGlyph(Rectangle controlBounds, SelectionRules selRules, SelectionBorderGlyphType type) { @@ -58,7 +58,7 @@ private void InitializeGlyph(Rectangle controlBounds, SelectionRules selRules, S } /// - /// Simple painting logic for selection Glyphs. + /// Simple painting logic for selection Glyphs. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ResizeBehavior.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ResizeBehavior.cs index cf4d29f3b10..8a0d733c425 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ResizeBehavior.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/ResizeBehavior.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The ResizeBehavior is pushed onto the BehaviorStack in response to a positively hit tested SelectionGlyph. The ResizeBehavior simply tracks the MouseMove messages and updates the bounds of the relatd control based on the new mouse location and the resize Rules. + /// The ResizeBehavior is pushed onto the BehaviorStack in response to a positively hit tested SelectionGlyph. The ResizeBehavior simply tracks the MouseMove messages and updates the bounds of the relatd control based on the new mouse location and the resize Rules. /// internal class ResizeBehavior : Behavior { @@ -50,7 +50,7 @@ private struct ResizeComponent private bool _captureLost; /// - /// Constructor that caches all values for perf. reasons. + /// Constructor that caches all values for perf. reasons. /// internal ResizeBehavior(IServiceProvider serviceProvider) { @@ -63,7 +63,7 @@ internal ResizeBehavior(IServiceProvider serviceProvider) } /// - /// Demand creates the BehaviorService. + /// Demand creates the BehaviorService. /// private BehaviorService BehaviorService { @@ -86,7 +86,7 @@ public override Cursor Cursor } /// - /// Called during the resize operation, we'll try to determine an offset so that the controls snap to the grid settings of the parent. + /// Called during the resize operation, we'll try to determine an offset so that the controls snap to the grid settings of the parent. /// private Rectangle AdjustToGrid(Rectangle controlBounds, SelectionRules rules) { @@ -154,7 +154,7 @@ private Rectangle AdjustToGrid(Rectangle controlBounds, SelectionRules rules) } /// - /// Builds up an array of snaplines used during resize to adjust/snap the controls bounds. + /// Builds up an array of snaplines used during resize to adjust/snap the controls bounds. /// private SnapLine[] GenerateSnapLines(SelectionRules rules, Point loc) { @@ -201,7 +201,7 @@ private SnapLine[] GenerateSnapLines(SelectionRules rules, Point loc) } /// - /// This is called in response to the mouse moving far enough away from its initial point. Basically, we calculate the bounds for each control we're resizing and disable any adorners. + /// This is called in response to the mouse moving far enough away from its initial point. Basically, we calculate the bounds for each control we're resizing and disable any adorners. /// private void InitiateResize() { @@ -282,7 +282,7 @@ private void InitiateResize() } /// - /// In response to a MouseDown, the SelectionBehavior will push (initiate) a dragBehavior by alerting the SelectionMananger that a new control has been selected and the mouse is down. Note that this is only if we find the related control's Dock property == none. + /// In response to a MouseDown, the SelectionBehavior will push (initiate) a dragBehavior by alerting the SelectionMananger that a new control has been selected and the mouse is down. Note that this is only if we find the related control's Dock property == none. /// public override bool OnMouseDown(Glyph g, MouseButtons button, Point mouseLoc) { @@ -353,7 +353,7 @@ public override bool OnMouseDown(Glyph g, MouseButtons button, Point mouseLoc) } /// - /// This method is called when we lose capture, which can occur when another window requests capture or the user presses ESC during a drag. We check to see if we are currently dragging, and if we are we abort the transaction. We pop our behavior off the stack at this time. + /// This method is called when we lose capture, which can occur when another window requests capture or the user presses ESC during a drag. We check to see if we are currently dragging, and if we are we abort the transaction. We pop our behavior off the stack at this time. /// public override void OnLoseCapture(Glyph g, EventArgs e) { @@ -441,7 +441,7 @@ internal static int AdjustPixelsForIntegralHeight(Control control, int pixelsMov } /// - /// This method will either initiate a new resize operation or continue with an existing one. If we're currently dragging (i.e. resizing) then we look at the resize rules and set the bounds of each control to the new location of the mouse pointer. + /// This method will either initiate a new resize operation or continue with an existing one. If we're currently dragging (i.e. resizing) then we look at the resize rules and set the bounds of each control to the new location of the mouse pointer. /// public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) { @@ -826,7 +826,7 @@ public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) } /// - /// This ends the Behavior by popping itself from the BehaviorStack. Also, all Adorners are re-enabled at the end of a successful drag. + /// This ends the Behavior by popping itself from the BehaviorStack. Also, all Adorners are re-enabled at the end of a successful drag. /// public override bool OnMouseUp(Glyph g, MouseButtons button) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyph.cs index 56c93e966a2..242f7168a26 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyph.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The SelectionBorderGlyph draws one side (depending on type) of a SelectionBorder. + /// The SelectionBorderGlyph draws one side (depending on type) of a SelectionBorder. /// internal class SelectionBorderGlyph : SelectionGlyphBase { /// - /// This constructor extends from the standard SelectionGlyphBase constructor. + /// This constructor extends from the standard SelectionGlyphBase constructor. /// internal SelectionBorderGlyph(Rectangle controlBounds, SelectionRules rules, SelectionBorderGlyphType type, Behavior behavior) : base(behavior) { @@ -20,7 +20,7 @@ internal SelectionBorderGlyph(Rectangle controlBounds, SelectionRules rules, Sel } /// - /// Helper function that initializes the Glyph based on bounds, type, and bordersize. + /// Helper function that initializes the Glyph based on bounds, type, and bordersize. /// private void InitializeGlyph(Rectangle controlBounds, SelectionRules selRules, SelectionBorderGlyphType type) { @@ -78,7 +78,7 @@ private void InitializeGlyph(Rectangle controlBounds, SelectionRules selRules, S } /// - /// Simple painting logic for selection Glyphs. + /// Simple painting logic for selection Glyphs. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyphType.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyphType.cs index bfb30c1be2a..5d9c12764f5 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyphType.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionBorderGlyphType.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// Describes the type of SelectionBorder the SelectionBorderGlyph represents. + /// Describes the type of SelectionBorder the SelectionBorderGlyph represents. /// internal enum SelectionBorderGlyphType { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionGlyphBase.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionGlyphBase.cs index 54722cfa305..6b1bae35d9d 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionGlyphBase.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionGlyphBase.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// This is the base class for all the selection Glyphs: GrabHandle, Hidden, Locked, Selection, and Tray Glyphs. This class includes all like-operations for the Selection glyphs. + /// This is the base class for all the selection Glyphs: GrabHandle, Hidden, Locked, Selection, and Tray Glyphs. This class includes all like-operations for the Selection glyphs. /// internal abstract class SelectionGlyphBase : Glyph { @@ -17,14 +17,14 @@ internal abstract class SelectionGlyphBase : Glyph protected SelectionRules rules; // the selection rules - defining how the control can change /// - /// Standard constructor. + /// Standard constructor. /// internal SelectionGlyphBase(Behavior behavior) : base(behavior) { } /// - /// Read-only property describing the SelecitonRules for these Glyphs. + /// Read-only property describing the SelecitonRules for these Glyphs. /// public SelectionRules SelectionRules { @@ -32,7 +32,7 @@ public SelectionRules SelectionRules } /// - /// Simple hit test rule: if the point is contained within the bounds - then it is a positive hit test. + /// Simple hit test rule: if the point is contained within the bounds - then it is a positive hit test. /// public override Cursor GetHitTest(Point p) { @@ -44,7 +44,7 @@ public override Cursor GetHitTest(Point p) } /// - /// Returns the HitTestCursor for this glyph. + /// Returns the HitTestCursor for this glyph. /// public Cursor HitTestCursor { @@ -52,7 +52,7 @@ public Cursor HitTestCursor } /// - /// The Bounds of this glyph. + /// The Bounds of this glyph. /// public override Rectangle Bounds { @@ -60,7 +60,7 @@ public override Rectangle Bounds } /// - /// There's no paint logic on this base class. + /// There's no paint logic on this base class. /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionManager.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionManager.cs index b23f3d5fcd9..b7a53a63919 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionManager.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/Behavior/SelectionManager.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design.Behavior { /// - /// The SelectionBehavior is pushed onto the BehaviorStack in response to a positively hit tested SelectionGlyph. The SelectionBehavior performs two main tasks: 1) forward messages to the related ControlDesigner, and 2) calls upon the SelectionManager to push a potention DragBehavior. + /// The SelectionBehavior is pushed onto the BehaviorStack in response to a positively hit tested SelectionGlyph. The SelectionBehavior performs two main tasks: 1) forward messages to the related ControlDesigner, and 2) calls upon the SelectionManager to push a potention DragBehavior. /// internal sealed class SelectionManager : IDisposable { @@ -33,7 +33,7 @@ internal sealed class SelectionManager : IDisposable private bool selectionChanging; //we dont want the OnSelectionChanged to be recursively called. /// - /// Constructor. Here we query for necessary services and cache them for perf. reasons. We also hook to Component Added/Removed/Changed notifications so we can keep in sync when the designers' components change. Also, we create our custom Adorner and add it to the BehaviorService. + /// Constructor. Here we query for necessary services and cache them for perf. reasons. We also hook to Component Added/Removed/Changed notifications so we can keep in sync when the designers' components change. Also, we create our custom Adorner and add it to the BehaviorService. /// public SelectionManager(IServiceProvider serviceProvider, BehaviorService behaviorService) { @@ -78,7 +78,7 @@ public SelectionManager(IServiceProvider serviceProvider, BehaviorService behavi } /// - /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. + /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. /// internal Adorner BodyGlyphAdorner { @@ -86,7 +86,7 @@ internal Adorner BodyGlyphAdorner } /// - /// There are certain cases like Adding Item to ToolStrips through InSitu Editor, where there is ParentTransaction that has to be cancelled depending upon the user action When this parent transaction is cancelled, there may be no reason to REFRESH the selectionManager which actually clears all the glyphs and readds them This REFRESH causes a lot of flicker and can be avoided by setting this property to false. Since this property is checked in the TransactionClosed, the SelectionManager won't REFRESH and hence just eat up the refresh thus avoiding unnecessary flicker. + /// There are certain cases like Adding Item to ToolStrips through InSitu Editor, where there is ParentTransaction that has to be cancelled depending upon the user action When this parent transaction is cancelled, there may be no reason to REFRESH the selectionManager which actually clears all the glyphs and readds them This REFRESH causes a lot of flicker and can be avoided by setting this property to false. Since this property is checked in the TransactionClosed, the SelectionManager won't REFRESH and hence just eat up the refresh thus avoiding unnecessary flicker. /// internal bool NeedRefresh { @@ -95,7 +95,7 @@ internal bool NeedRefresh } /// - /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. + /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. /// internal Adorner SelectionGlyphAdorner { @@ -103,7 +103,7 @@ internal Adorner SelectionGlyphAdorner } /// - /// This method fist calls the recursive AddControlGlyphs() method. When finished, we add the final glyph(s) to the root comp. + /// This method fist calls the recursive AddControlGlyphs() method. When finished, we add the final glyph(s) to the root comp. /// private void AddAllControlGlyphs(Control parent, ArrayList selComps, object primarySelection) { @@ -128,7 +128,7 @@ private void AddAllControlGlyphs(Control parent, ArrayList selComps, object prim } /// - /// Recursive method that goes through and adds all the glyphs of every child to our global Adorner. + /// Recursive method that goes through and adds all the glyphs of every child to our global Adorner. /// private void AddControlGlyphs(Control c, GlyphSelectionType selType) { @@ -175,7 +175,7 @@ private void AddControlGlyphs(Control c, GlyphSelectionType selType) } /// - /// Unhook all of our event notifications, clear our adorner and remove it from the Beh.Svc. + /// Unhook all of our event notifications, clear our adorner and remove it from the Beh.Svc. /// // We don't need to Dispose rootComponent. public void Dispose() @@ -225,7 +225,7 @@ public void Dispose() } /// - /// Refreshes all selection Glyphs. + /// Refreshes all selection Glyphs. /// public void Refresh() { @@ -234,7 +234,7 @@ public void Refresh() } /// - /// When a component is added, we get the designer and add it to our hashtable for quick lookup. + /// When a component is added, we get the designer and add it to our hashtable for quick lookup. /// private void OnComponentAdded(object source, ComponentEventArgs ce) { @@ -247,7 +247,7 @@ private void OnComponentAdded(object source, ComponentEventArgs ce) } /// - /// Before a drag, remove all glyphs that are involved in the drag operation and any that don't allow drops. + /// Before a drag, remove all glyphs that are involved in the drag operation and any that don't allow drops. /// private void OnBeginDrag(object source, BehaviorDragDropEventArgs e) { @@ -277,7 +277,7 @@ internal void OnBeginDrag(BehaviorDragDropEventArgs e) } /// - /// When a component is changed - we need to refresh the selection. + /// When a component is changed - we need to refresh the selection. /// private void OnComponentChanged(object source, ComponentChangedEventArgs ce) { @@ -295,7 +295,7 @@ private void OnComponentChanged(object source, ComponentChangedEventArgs ce) } /// - /// When a component is removed - we remove the key & value from our hashtable. + /// When a component is removed - we remove the key & value from our hashtable. /// private void OnComponentRemoved(object source, ComponentEventArgs ce) { @@ -310,7 +310,7 @@ private void OnComponentRemoved(object source, ComponentEventArgs ce) } } /// - /// Computes the region representing the difference between the old selection and the new selection. + /// Computes the region representing the difference between the old selection and the new selection. /// private Region DetermineRegionToRefresh(object primarySelection) { @@ -384,7 +384,7 @@ private Region DetermineRegionToRefresh(object primarySelection) } /// - /// Event handler for the behaviorService's Synchronize event + /// Event handler for the behaviorService's Synchronize event /// private void OnSynchronize(object sender, EventArgs e) { @@ -392,7 +392,7 @@ private void OnSynchronize(object sender, EventArgs e) } /// - /// On every selectionchange, we remove all glyphs, get the newly selected components, and re-add all glyphs back to the Adorner. + /// On every selectionchange, we remove all glyphs, get the newly selected components, and re-add all glyphs back to the Adorner. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -455,7 +455,7 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// When a transaction that involves one of our components closes, refresh to reflect any changes. + /// When a transaction that involves one of our components closes, refresh to reflect any changes. /// private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ChangeToolStripParentVerb.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ChangeToolStripParentVerb.cs index 19a3d1f0404..f385881dc67 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ChangeToolStripParentVerb.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ChangeToolStripParentVerb.cs @@ -21,7 +21,7 @@ internal class ChangeToolStripParentVerb private readonly IServiceProvider _provider; /// - /// Create one of these things... + /// Create one of these things... /// internal ChangeToolStripParentVerb(string text, ToolStripDesigner designer) { @@ -33,7 +33,7 @@ internal ChangeToolStripParentVerb(string text, ToolStripDesigner designer) } /// - /// When the verb is invoked, change the parent of the ToolStrip. + /// When the verb is invoked, change the parent of the ToolStrip. /// // This is actually called... public void ChangeParent() diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CollectionEditVerbManager.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CollectionEditVerbManager.cs index 30c3e1a4133..5a9cc3ea86f 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CollectionEditVerbManager.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CollectionEditVerbManager.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// Class for sharing code for launching the ToolStripItemsCollectionEditor from a verb. This class implments the IWindowsFormsEditorService and ITypeDescriptorContext to display the dialog. + /// Class for sharing code for launching the ToolStripItemsCollectionEditor from a verb. This class implments the IWindowsFormsEditorService and ITypeDescriptorContext to display the dialog. /// internal class CollectionEditVerbManager : IWindowsFormsEditorService, ITypeDescriptorContext { @@ -21,7 +21,7 @@ internal class CollectionEditVerbManager : IWindowsFormsEditorService, ITypeDesc private readonly DesignerVerb _editItemsVerb; /// - /// Create one of these things... + /// Create one of these things... /// internal CollectionEditVerbManager(string text, ComponentDesigner designer, PropertyDescriptor prop, bool addToDesignerVerbs) { @@ -50,7 +50,7 @@ internal CollectionEditVerbManager(string text, ComponentDesigner designer, Prop } /// - /// Our caching property for the IComponentChangeService + /// Our caching property for the IComponentChangeService /// private IComponentChangeService ChangeService { @@ -65,7 +65,7 @@ private IComponentChangeService ChangeService } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// IContainer ITypeDescriptorContext.Container { @@ -85,12 +85,12 @@ public DesignerVerb EditItemsVerb } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// void ITypeDescriptorContext.OnComponentChanged() => ChangeService.OnComponentChanged(_designer.Component, _targetProperty, null, null); /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// bool ITypeDescriptorContext.OnComponentChanging() { @@ -110,7 +110,7 @@ bool ITypeDescriptorContext.OnComponentChanging() } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// object ITypeDescriptorContext.Instance { @@ -118,7 +118,7 @@ object ITypeDescriptorContext.Instance } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// PropertyDescriptor ITypeDescriptorContext.PropertyDescriptor { @@ -126,7 +126,7 @@ PropertyDescriptor ITypeDescriptorContext.PropertyDescriptor } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// object IServiceProvider.GetService(Type serviceType) { @@ -142,7 +142,7 @@ object IServiceProvider.GetService(Type serviceType) } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// void IWindowsFormsEditorService.CloseDropDown() { @@ -152,7 +152,7 @@ void IWindowsFormsEditorService.CloseDropDown() } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// void IWindowsFormsEditorService.DropDownControl(Control control) { @@ -161,7 +161,7 @@ void IWindowsFormsEditorService.DropDownControl(Control control) } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// DialogResult IWindowsFormsEditorService.ShowDialog(Form dialog) { @@ -177,7 +177,7 @@ DialogResult IWindowsFormsEditorService.ShowDialog(Form dialog) } /// - /// When the verb is invoked, use all the stuff above to show the dialog, etc. + /// When the verb is invoked, use all the stuff above to show the dialog, etc. /// private void OnEditItems(object sender, EventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CommandSet.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CommandSet.cs index 90988988d47..338cea5a2ff 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CommandSet.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CommandSet.cs @@ -17,7 +17,7 @@ namespace System.Windows.Forms.Design { /// - /// This class implements the standard set of menu commands for the form designer. This set of command is shared between the form designer (and other UI-based form packages), and composition designer, which doesn't manipulate controls. Therefore, this set of command should only contain commands that are common to both functions. + /// This class implements the standard set of menu commands for the form designer. This set of command is shared between the form designer (and other UI-based form packages), and composition designer, which doesn't manipulate controls. Therefore, this set of command should only contain commands that are common to both functions. /// internal class CommandSet : IDisposable { @@ -44,7 +44,7 @@ internal class CommandSet : IDisposable private StatusCommandUI _statusCommandUI; //Used to update the statusBar Information. /// - /// Creates a new CommandSet object. This object implements the set of commands that the UI.Win32 form designer offers. + /// Creates a new CommandSet object. This object implements the set of commands that the UI.Win32 form designer offers. /// public CommandSet(ISite site) { @@ -111,7 +111,7 @@ public CommandSet(ISite site) } /// - /// Demand creates a pointer to the BehaviorService + /// Demand creates a pointer to the BehaviorService /// protected BehaviorService BehaviorService { @@ -126,7 +126,7 @@ protected BehaviorService BehaviorService } /// - /// Retrieves the menu command service, which the command set typically uses quite a bit. + /// Retrieves the menu command service, which the command set typically uses quite a bit. /// protected IMenuCommandService MenuService { @@ -141,7 +141,7 @@ protected IMenuCommandService MenuService } /// - /// Retrieves the selection service, which the command set typically uses quite a bit. + /// Retrieves the selection service, which the command set typically uses quite a bit. /// protected ISelectionService SelectionService { @@ -154,7 +154,7 @@ protected int SelectionVersion } /// - /// This property demand creates our snaplinetimer used to track how long we'll leave snaplines on the screen before erasing them + /// This property demand creates our snaplinetimer used to track how long we'll leave snaplines on the screen before erasing them /// protected Timer SnapLineTimer { @@ -174,7 +174,7 @@ protected Timer SnapLineTimer } /// - /// Checks if an object supports ComponentEditors, and optionally launches the editor. + /// Checks if an object supports ComponentEditors, and optionally launches the editor. /// private bool CheckComponentEditor(object obj, bool launchEditor) { @@ -243,7 +243,7 @@ private bool CheckComponentEditor(object obj, bool launchEditor) } /// - /// Disposes of this object, removing all commands from the menu service. + /// Disposes of this object, removing all commands from the menu service. /// public virtual void Dispose() { @@ -289,7 +289,7 @@ public virtual void Dispose() } /// - /// Properly cleans up our drag engine. + /// Properly cleans up our drag engine. /// protected void EndDragManager() { @@ -306,7 +306,7 @@ protected void EndDragManager() } /// - /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. + /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. /// private object[] FilterSelection(object[] components, SelectionRules selectionRules) { @@ -336,7 +336,7 @@ private object[] FilterSelection(object[] components, SelectionRules selectionRu } /// - /// Used to retrieve the selection for a copy. The default implementation retrieves the current selection. + /// Used to retrieve the selection for a copy. The default implementation retrieves the current selection. /// protected virtual ICollection GetCopySelection() { @@ -388,7 +388,7 @@ private void GetAssociatedComponents(IComponent component, IDesignerHost host, A } /// - /// Used to retrieve the current location of the given component. + /// Used to retrieve the current location of the given component. /// private Point GetLocation(IComponent comp) { @@ -412,7 +412,7 @@ private Point GetLocation(IComponent comp) } /// - /// Retrieves the given property on the given component. + /// Retrieves the given property on the given component. /// protected PropertyDescriptor GetProperty(object comp, string propName) { @@ -420,7 +420,7 @@ protected PropertyDescriptor GetProperty(object comp, string propName) } /// - /// Retrieves the requested service. + /// Retrieves the requested service. /// protected virtual object GetService(Type serviceType) { @@ -432,7 +432,7 @@ protected virtual object GetService(Type serviceType) } /// - /// Used to retrieve the current size of the given component. + /// Used to retrieve the current size of the given component. /// private Size GetSize(IComponent comp) { @@ -445,7 +445,7 @@ private Size GetSize(IComponent comp) } /// - /// Retrieves the snap information for the given component. + /// Retrieves the snap information for the given component. /// protected virtual void GetSnapInformation(IDesignerHost host, IComponent component, out Size snapSize, out IComponent snapComponent, out PropertyDescriptor snapProperty) { @@ -481,7 +481,7 @@ protected virtual void GetSnapInformation(IDesignerHost host, IComponent compone } /// - /// Called before doing any change to multiple controls to check if we have the right to make any change otherwise we would get a checkout message for each control we call setvalue on + /// Called before doing any change to multiple controls to check if we have the right to make any change otherwise we would get a checkout message for each control we call setvalue on /// protected bool CanCheckout(IComponent comp) { @@ -508,7 +508,7 @@ protected bool CanCheckout(IComponent comp) } /// - /// Called by the event handler service when the current event handler has changed. Here we invalidate all of our menu items so that they can pick up the new event handler. + /// Called by the event handler service when the current event handler has changed. Here we invalidate all of our menu items so that they can pick up the new event handler. /// private void OnEventHandlerChanged(object sender, EventArgs e) { @@ -516,7 +516,7 @@ private void OnEventHandlerChanged(object sender, EventArgs e) } /// - /// Called for the two cancel commands we support. + /// Called for the two cancel commands we support. /// private void OnKeyCancel(object sender, EventArgs e) { @@ -524,7 +524,7 @@ private void OnKeyCancel(object sender, EventArgs e) } /// - /// Called for the two cancel commands we support. Returns true If we did anything with the cancel, or false if not. + /// Called for the two cancel commands we support. Returns true If we did anything with the cancel, or false if not. /// protected virtual bool OnKeyCancel(object sender) { @@ -558,7 +558,7 @@ protected virtual bool OnKeyCancel(object sender) } /// - /// Called for the "default" command, typically the Enter key. + /// Called for the "default" command, typically the Enter key. /// protected void OnKeyDefault(object sender, EventArgs e) { @@ -583,7 +583,7 @@ protected void OnKeyDefault(object sender, EventArgs e) } /// - /// Called for all cursor movement commands. + /// Called for all cursor movement commands. /// protected virtual void OnKeyMove(object sender, EventArgs e) { @@ -788,7 +788,7 @@ protected virtual void OnKeyMove(object sender, EventArgs e) } /// - /// Called for all alignment operations that key off of a primary selection. + /// Called for all alignment operations that key off of a primary selection. /// protected void OnMenuAlignByPrimary(object sender, EventArgs e) { @@ -937,7 +937,7 @@ protected void OnMenuAlignByPrimary(object sender, EventArgs e) } /// - /// Called when the align->to grid menu item is selected. + /// Called when the align->to grid menu item is selected. /// protected void OnMenuAlignToGrid(object sender, EventArgs e) { @@ -1053,7 +1053,7 @@ protected void OnMenuAlignToGrid(object sender, EventArgs e) } /// - /// Called when the center horizontally or center vertically menu item is selected. + /// Called when the center horizontally or center vertically menu item is selected. /// protected void OnMenuCenterSelection(object sender, EventArgs e) { @@ -1247,7 +1247,7 @@ protected void OnMenuCenterSelection(object sender, EventArgs e) } /// - /// Called when the copy menu item is selected. + /// Called when the copy menu item is selected. /// protected void OnMenuCopy(object sender, EventArgs e) { @@ -1284,7 +1284,7 @@ protected void OnMenuCopy(object sender, EventArgs e) } /// - /// Called when the cut menu item is selected. + /// Called when the cut menu item is selected. /// protected void OnMenuCut(object sender, EventArgs e) { @@ -1431,7 +1431,7 @@ protected void OnMenuCut(object sender, EventArgs e) } /// - /// Called when the delete menu item is selected. + /// Called when the delete menu item is selected. /// protected void OnMenuDelete(object sender, EventArgs e) { @@ -1669,7 +1669,7 @@ protected void OnMenuDelete(object sender, EventArgs e) } /// - /// Called when the paste menu item is selected. + /// Called when the paste menu item is selected. /// protected void OnMenuPaste(object sender, EventArgs e) { @@ -2001,7 +2001,7 @@ protected void OnMenuPaste(object sender, EventArgs e) } /// - /// Called when the select all menu item is selected. + /// Called when the select all menu item is selected. /// protected void OnMenuSelectAll(object sender, EventArgs e) { @@ -2054,7 +2054,7 @@ protected void OnMenuSelectAll(object sender, EventArgs e) } /// - /// Called when the show grid menu item is selected. + /// Called when the show grid menu item is selected. /// protected void OnMenuShowGrid(object sender, EventArgs e) { @@ -2093,7 +2093,7 @@ protected void OnMenuShowGrid(object sender, EventArgs e) } /// - /// Handles the various size to commands. + /// Handles the various size to commands. /// protected void OnMenuSizingCommand(object sender, EventArgs e) { @@ -2193,7 +2193,7 @@ protected void OnMenuSizingCommand(object sender, EventArgs e) } /// - /// Called when the size->to grid menu item is selected. + /// Called when the size->to grid menu item is selected. /// protected void OnMenuSizeToGrid(object sender, EventArgs e) { @@ -2274,7 +2274,7 @@ protected void OnMenuSizeToGrid(object sender, EventArgs e) } /// - /// Called when the properties menu item is selected on the Context menu + /// Called when the properties menu item is selected on the Context menu /// protected void OnMenuDesignerProperties(object sender, EventArgs e) { @@ -2297,7 +2297,7 @@ protected void OnMenuDesignerProperties(object sender, EventArgs e) } /// - /// Called when the snap to grid menu item is selected. + /// Called when the snap to grid menu item is selected. /// protected void OnMenuSnapToGrid(object sender, EventArgs e) { @@ -2335,7 +2335,7 @@ protected void OnMenuSnapToGrid(object sender, EventArgs e) } /// - /// Called when a spacing command is selected + /// Called when a spacing command is selected /// protected void OnMenuSpacingCommand(object sender, EventArgs e) { @@ -2707,7 +2707,7 @@ protected void OnMenuSpacingCommand(object sender, EventArgs e) } /// - /// Called when the current selection changes. Here we determine what commands can and can't be enabled. + /// Called when the current selection changes. Here we determine what commands can and can't be enabled. /// protected void OnSelectionChanged(object sender, EventArgs e) { @@ -2754,7 +2754,7 @@ protected void OnSelectionChanged(object sender, EventArgs e) } /// - /// When this timer expires, this tells us that we need to erase any snaplines we have drawn. First, we need to marshal this back to the correct thread. + /// When this timer expires, this tells us that we need to erase any snaplines we have drawn. First, we need to marshal this back to the correct thread. /// private void OnSnapLineTimerExpire(object sender, EventArgs e) { @@ -2766,7 +2766,7 @@ private void OnSnapLineTimerExpire(object sender, EventArgs e) } /// - /// Called when our snapline timer expires - this method has been call has been properly marshalled back to the correct thread. + /// Called when our snapline timer expires - this method has been call has been properly marshalled back to the correct thread. /// private void OnSnapLineTimerExpireMarshalled(object sender, EventArgs e) { @@ -2775,7 +2775,7 @@ private void OnSnapLineTimerExpireMarshalled(object sender, EventArgs e) } /// - /// Determines the status of a menu command. Commands with this event handler are always enabled. + /// Determines the status of a menu command. Commands with this event handler are always enabled. /// protected void OnStatusAlways(object sender, EventArgs e) { @@ -2784,7 +2784,7 @@ protected void OnStatusAlways(object sender, EventArgs e) } /// - /// Determines the status of a menu command. Commands with this event handler are enabled when one or more objects are selected. + /// Determines the status of a menu command. Commands with this event handler are enabled when one or more objects are selected. /// protected void OnStatusAnySelection(object sender, EventArgs e) { @@ -2793,7 +2793,7 @@ protected void OnStatusAnySelection(object sender, EventArgs e) } /// - /// Status for the copy command. This is enabled when there is something juicy selected. + /// Status for the copy command. This is enabled when there is something juicy selected. /// protected void OnStatusCopy(object sender, EventArgs e) { @@ -2827,7 +2827,7 @@ protected void OnStatusCopy(object sender, EventArgs e) } /// - /// Status for the cut command. This is enabled when there is something juicy selected and that something does not contain any inherited components. + /// Status for the cut command. This is enabled when there is something juicy selected and that something does not contain any inherited components. /// protected void OnStatusCut(object sender, EventArgs e) { @@ -2839,7 +2839,7 @@ protected void OnStatusCut(object sender, EventArgs e) } /// - /// Status for the delete command. This is enabled when there is something selected and that something does not contain inherited components. + /// Status for the delete command. This is enabled when there is something selected and that something does not contain inherited components. /// protected void OnStatusDelete(object sender, EventArgs e) { @@ -2873,7 +2873,7 @@ protected void OnStatusDelete(object sender, EventArgs e) } /// - /// Determines the status of a menu command. Commands with this event are enabled when there is something yummy on the clipboard. + /// Determines the status of a menu command. Commands with this event are enabled when there is something yummy on the clipboard. /// protected void OnStatusPaste(object sender, EventArgs e) { @@ -2932,7 +2932,7 @@ protected virtual void OnStatusSelectAll(object sender, EventArgs e) } /// - /// This is called when the selection has changed. Anyone using CommandSetItems that need to update their status based on selection changes should override this and update their own commands at this time. The base implementaion runs through all base commands and calls UpdateStatus on them. + /// This is called when the selection has changed. Anyone using CommandSetItems that need to update their status based on selection changes should override this and update their own commands at this time. The base implementaion runs through all base commands and calls UpdateStatus on them. /// protected virtual void OnUpdateCommandStatus() { @@ -2944,7 +2944,7 @@ protected virtual void OnUpdateCommandStatus() } /// - /// This method grows the objects collection by one. It prepends the collection with a string[] which contains the component names in order for each component in the list. + /// This method grows the objects collection by one. It prepends the collection with a string[] which contains the component names in order for each component in the list. /// private ICollection PrependComponentNames(ICollection objects) { @@ -2971,7 +2971,7 @@ private ICollection PrependComponentNames(ICollection objects) } /// - /// called by the formatting commands when we need a given selection array sorted. Sorting the array sorts by x from left to right, and by Y from top to bottom. + /// called by the formatting commands when we need a given selection array sorted. Sorting the array sorts by x from left to right, and by Y from top to bottom. /// private void SortSelection(object[] selectedObjects, int nSortBy) { @@ -2994,7 +2994,7 @@ private void SortSelection(object[] selectedObjects, int nSortBy) } /// - /// Common function that updates the status of clipboard menu items only + /// Common function that updates the status of clipboard menu items only /// private void UpdateClipboardItems(object s, EventArgs e) { @@ -3192,7 +3192,7 @@ private void UpdatePasteTabIndex(Control componentControl, object parentComponen } /// - /// We extend MenuCommand for our command set items. A command set item is a menu command with an added delegate that is used to determine the flags for the menu item. We have different classes of delegates here. For example, many menu items may be enabled when there is at least one object selected, while others are only enabled if there is more than one object or if there is a primary selection. + /// We extend MenuCommand for our command set items. A command set item is a menu command with an added delegate that is used to determine the flags for the menu item. We have different classes of delegates here. For example, many menu items may be enabled when there is at least one object selected, while others are only enabled if there is more than one object or if there is a primary selection. /// protected class CommandSetItem : MenuCommand { @@ -3216,7 +3216,7 @@ public CommandSetItem(CommandSet commandSet, EventHandler statusHandler, EventHa } /// - /// Creates a new CommandSetItem. + /// Creates a new CommandSetItem. /// public CommandSetItem(CommandSet commandSet, EventHandler statusHandler, EventHandler invokeHandler, CommandID id, bool optimizeStatus, IUIService uiService) : base(invokeHandler, id) @@ -3250,7 +3250,7 @@ public CommandSetItem(CommandSet commandSet, EventHandler statusHandler, EventHa } /// - /// Checks if the status for this command is valid, meaning we don't need to call the status handler. + /// Checks if the status for this command is valid, meaning we don't need to call the status handler. /// private bool CommandStatusValid { @@ -3269,7 +3269,7 @@ private bool CommandStatusValid } /// - /// Applys the cached status to this item. + /// Applys the cached status to this item. /// private void ApplyCachedStatus() { @@ -3291,7 +3291,7 @@ private void ApplyCachedStatus() } /// - /// This may be called to invoke the menu item. + /// This may be called to invoke the menu item. /// public override void Invoke() { @@ -3322,7 +3322,7 @@ public override void Invoke() } /// - /// Only pass this down to the base when we're not doing the cached update. + /// Only pass this down to the base when we're not doing the cached update. /// protected override void OnCommandChanged(EventArgs e) { @@ -3333,7 +3333,7 @@ protected override void OnCommandChanged(EventArgs e) } /// - /// Saves the status for this command to the statusstate that's stored in the hashtable based on our status handler delegate. + /// Saves the status for this command to the statusstate that's stored in the hashtable based on our status handler delegate. /// private void SaveCommandStatus() { @@ -3355,7 +3355,7 @@ private void SaveCommandStatus() } /// - /// Called when the status of this command should be re-queried. + /// Called when the status of this command should be re-queried. /// public void UpdateStatus() { @@ -3390,7 +3390,7 @@ public void UpdateStatus() } /// - /// Remove this command item from the static hashtable to avoid leaking this object. + /// Remove this command item from the static hashtable to avoid leaking this object. /// public virtual void Dispose() { @@ -3405,7 +3405,7 @@ public virtual void Dispose() } /// - /// This class saves the state for a given command. It keeps track of the results of the last status handler invocation and what "selection version" that happened on. + /// This class saves the state for a given command. It keeps track of the results of the last status handler invocation and what "selection version" that happened on. /// private class StatusState { @@ -3421,7 +3421,7 @@ private class StatusState internal int refCount = 0; /// - /// Just what it says... + /// Just what it says... /// public int SelectionVersion { @@ -3429,7 +3429,7 @@ public int SelectionVersion } /// - /// Pushes the state stored in this object into the given command item. + /// Pushes the state stored in this object into the given command item. /// internal void ApplyState(CommandSetItem item) { @@ -3441,7 +3441,7 @@ internal void ApplyState(CommandSetItem item) } /// - /// Updates this status object with the state from the given item, and saves teh seletion version. + /// Updates this status object with the state from the given item, and saves teh seletion version. /// internal void SaveState(CommandSetItem item, int version) { @@ -3468,19 +3468,19 @@ internal void SaveState(CommandSetItem item, int version) } /// - /// The immediate command set item is used for commands that cannot be cached. Commands such as Paste that get outside stimulus cannot be cached by our menu system, so they get an ImmediateCommandSetItem instead of a CommandSetItem. + /// The immediate command set item is used for commands that cannot be cached. Commands such as Paste that get outside stimulus cannot be cached by our menu system, so they get an ImmediateCommandSetItem instead of a CommandSetItem. /// protected class ImmediateCommandSetItem : CommandSetItem { /// - /// Creates a new ImmediateCommandSetItem. + /// Creates a new ImmediateCommandSetItem. /// public ImmediateCommandSetItem(CommandSet commandSet, EventHandler statusHandler, EventHandler invokeHandler, CommandID id, IUIService uiService) : base(commandSet, statusHandler, invokeHandler, id, uiService) { } /// - /// Overrides OleStatus in MenuCommand to invoke our status handler first. + /// Overrides OleStatus in MenuCommand to invoke our status handler first. /// public override int OleStatus { @@ -3493,7 +3493,7 @@ public override int OleStatus } /// - /// Component comparer that compares the left property of a component. + /// Component comparer that compares the left property of a component. /// private class ComponentLeftCompare : IComparer { @@ -3513,7 +3513,7 @@ public int Compare(object p, object q) } /// - /// Component comparer that compares the top property of a component. + /// Component comparer that compares the top property of a component. /// private class ComponentTopCompare : IComparer { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ComponentTray.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ComponentTray.cs index 6ca4ec3ce27..a5abfe6baa9 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ComponentTray.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ComponentTray.cs @@ -19,7 +19,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides the component tray UI for the form designer. + /// Provides the component tray UI for the form designer. /// [ToolboxItem(false)] [DesignTimeVisible(false)] @@ -38,7 +38,7 @@ public class ComponentTray : ScrollableControl, IExtenderProvider, ISelectionUIH private IToolboxService toolboxService; // cached for drag/drop /// - /// Provides drag and drop functionality through OLE. + /// Provides drag and drop functionality through OLE. /// internal OleDragDropHandler oleDragDropHandler; // handler class for ole drag drop operations. @@ -73,9 +73,9 @@ public class ComponentTray : ScrollableControl, IExtenderProvider, ISelectionUIH // Empty class for build time dependancy /// - /// Creates a new component tray. The component tray - /// will monitor component additions and removals and create - /// appropriate UI objects in its space. + /// Creates a new component tray. The component tray + /// will monitor component additions and removals and create + /// appropriate UI objects in its space. /// public ComponentTray(IDesigner mainDesigner, IServiceProvider serviceProvider) { @@ -444,7 +444,7 @@ public bool AutoArrange } /// - /// Gets the number of compnents contained within this tray. + /// Gets the number of compnents contained within this tray. /// public int ComponentCount { @@ -467,7 +467,7 @@ internal GlyphCollection SelectionGlyphs } /// - /// Determines whether the tray will show large icon view or not. + /// Determines whether the tray will show large icon view or not. /// public bool ShowLargeIcons { @@ -678,7 +678,7 @@ private void OnContextMenu(int x, int y, bool useSelection) void ISelectionUIHandler.OleDragLeave() => GetOleDragHandler().DoOleDragLeave(); /// - /// Adds a component to the tray. + /// Adds a component to the tray. /// public virtual void AddComponent(IComponent component) { @@ -803,10 +803,10 @@ private Type GetDesignerType(Type t, Type designerBaseType) } /// - /// This method determines if a UI representation for the given component should be provided. - /// If it returns true, then the component will get a glyph in the tray area. If it returns - /// false, then the component will not actually be added to the tray. The default - /// implementation looks for DesignTimeVisibleAttribute.Yes on the component's class. + /// This method determines if a UI representation for the given component should be provided. + /// If it returns true, then the component will get a glyph in the tray area. If it returns + /// false, then the component will not actually be added to the tray. The default + /// implementation looks for DesignTimeVisibleAttribute.Yes on the component's class. /// protected virtual bool CanDisplayComponent(IComponent component) { @@ -825,7 +825,7 @@ public void CreateComponentFromTool(ToolboxItem tool) } /// - /// Displays the given exception to the user. + /// Displays the given exception to the user. /// protected void DisplayError(Exception e) { @@ -846,7 +846,7 @@ protected void DisplayError(Exception e) } /// - /// Disposes of the resources (other than memory) used by the component tray object. + /// Disposes of the resources (other than memory) used by the component tray object. /// protected override void Dispose(bool disposing) { @@ -920,10 +920,10 @@ protected override void Dispose(bool disposing) } /// - /// Similar to GetNextControl on Control, this method returns the next - /// component in the tray, given a starting component. It will return - /// null if the end (or beginning, if forward is false) of the list - /// is encountered. + /// Similar to GetNextControl on Control, this method returns the next + /// component in the tray, given a starting component. It will return + /// null if the end (or beginning, if forward is false) of the list + /// is encountered. /// public IComponent GetNextComponent(IComponent component, bool forward) { @@ -951,8 +951,8 @@ public IComponent GetNextComponent(IComponent component, bool forward) } /// - /// Accessor method for the location extender property. We offer this extender - /// to all non-visual components. + /// Accessor method for the location extender property. We offer this extender + /// to all non-visual components. /// [Category("Layout")] [Localizable(false)] @@ -976,8 +976,8 @@ public Point GetLocation(IComponent receiver) } /// - /// Accessor method for the location extender property. We offer this extender - /// to all non-visual components. + /// Accessor method for the location extender property. We offer this extender + /// to all non-visual components. /// [Category("Layout")] [Localizable(false)] @@ -998,7 +998,7 @@ public Point GetTrayLocation(IComponent receiver) } /// - /// Gets the requsted service type. + /// Gets the requsted service type. /// protected override object GetService(Type serviceType) { @@ -1012,7 +1012,7 @@ protected override object GetService(Type serviceType) } /// - /// Returns true if the given componenent is being shown on the tray. + /// Returns true if the given componenent is being shown on the tray. /// public bool IsTrayComponent(IComponent comp) { @@ -1052,8 +1052,8 @@ protected override void OnMouseDoubleClick(MouseEventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onGiveFeedback to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onGiveFeedback to send this event to any registered event listeners. /// protected override void OnGiveFeedback(GiveFeedbackEventArgs gfevent) { @@ -1062,8 +1062,8 @@ protected override void OnGiveFeedback(GiveFeedbackEventArgs gfevent) } /// - /// Called in response to a drag drop for OLE drag and drop. Here we - /// drop a toolbox component on our parent control. + /// Called in response to a drag drop for OLE drag and drop. Here we + /// drop a toolbox component on our parent control. /// protected override void OnDragDrop(DragEventArgs de) { @@ -1107,7 +1107,7 @@ protected override void OnDragDrop(DragEventArgs de) } /// - /// Called in response to a drag enter for OLE drag and drop. + /// Called in response to a drag enter for OLE drag and drop. /// protected override void OnDragEnter(DragEventArgs de) { @@ -1145,7 +1145,7 @@ protected override void OnDragEnter(DragEventArgs de) } /// - /// Called when a drag-drop operation leaves the control designer view + /// Called when a drag-drop operation leaves the control designer view /// protected override void OnDragLeave(EventArgs e) { @@ -1155,7 +1155,7 @@ protected override void OnDragLeave(EventArgs e) } /// - /// Called when a drag drop object is dragged over the control designer view + /// Called when a drag drop object is dragged over the control designer view /// protected override void OnDragOver(DragEventArgs de) { @@ -1171,7 +1171,7 @@ protected override void OnDragOver(DragEventArgs de) } /// - /// Forces the layout of any docked or anchored child controls. + /// Forces the layout of any docked or anchored child controls. /// protected override void OnLayout(LayoutEventArgs levent) { @@ -1182,9 +1182,9 @@ protected override void OnLayout(LayoutEventArgs levent) } /// - /// This is called when we lose capture. Here we get rid of any - /// rubber band we were drawing. You should put any cleanup - /// code in here. + /// This is called when we lose capture. Here we get rid of any + /// rubber band we were drawing. You should put any cleanup + /// code in here. /// protected virtual void OnLostCapture() { @@ -1211,8 +1211,8 @@ private void DrawRubber(Point start, Point end) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onMouseDown to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onMouseDown to send this event to any registered event listeners. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -1288,8 +1288,8 @@ protected override void OnMouseDown(MouseEventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onMouseMove to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onMouseMove to send this event to any registered event listeners. /// protected override void OnMouseMove(MouseEventArgs e) { @@ -1319,8 +1319,8 @@ protected override void OnMouseMove(MouseEventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onMouseUp to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onMouseUp to send this event to any registered event listeners. /// protected override void OnMouseUp(MouseEventArgs e) { @@ -1492,8 +1492,8 @@ protected override void OnPaint(PaintEventArgs pe) } /// - /// Sets the cursor. You may override this to set your own - /// cursor. + /// Sets the cursor. You may override this to set your own + /// cursor. /// protected virtual void OnSetCursor() { @@ -1508,7 +1508,7 @@ protected virtual void OnSetCursor() } /// - /// Removes a component from the tray. + /// Removes a component from the tray. /// public virtual void RemoveComponent(IComponent component) { @@ -1539,8 +1539,8 @@ public virtual void RemoveComponent(IComponent component) } /// - /// Accessor method for the location extender property. We offer this extender - /// to all non-visual components. + /// Accessor method for the location extender property. We offer this extender + /// to all non-visual components. /// public void SetLocation(IComponent receiver, Point location) { @@ -1569,8 +1569,8 @@ public void SetLocation(IComponent receiver, Point location) } /// - /// Accessor method for the location extender property. We offer this extender - /// to all non-visual components. + /// Accessor method for the location extender property. We offer this extender + /// to all non-visual components. /// public void SetTrayLocation(IComponent receiver, Point location) { @@ -1597,7 +1597,7 @@ public void SetTrayLocation(IComponent receiver, Point location) } /// - /// We override our base class's WndProc to monitor certain messages. + /// We override our base class's WndProc to monitor certain messages. /// protected override void WndProc(ref Message m) { @@ -1920,7 +1920,7 @@ internal class TrayControl : Control internal bool _fRecompute = false; // This flag tells the TrayControl that it needs to retrieve the font and the background color before painting. /// - /// Creates a new TrayControl based on the component. + /// Creates a new TrayControl based on the component. /// public TrayControl(ComponentTray tray, IComponent component) { @@ -1964,7 +1964,7 @@ public TrayControl(ComponentTray tray, IComponent component) } /// - /// Retrieves the compnent this control is representing. + /// Retrieves the compnent this control is representing. /// public IComponent Component { @@ -1988,7 +1988,7 @@ public bool Positioned } /// - /// Adjusts the size of the control based on the contents. + /// Adjusts the size of the control based on the contents. /// // CONSIDER: this method gets called three or four times per component, and is even reentrant (CreateGraphics can force handle creation, and OnCreateHandle calls this method). There's probably a better way to do this, but since this doesn't seem to be on the critical path, I'm not going to lose sleep over it. private void AdjustSize() @@ -2033,7 +2033,7 @@ private void AdjustSize() protected override AccessibleObject CreateAccessibilityInstance() => new TrayControlAccessibleObject(this, _tray); /// - /// Destroys this control. Views automatically destroy themselves when they are removed from the design container. + /// Destroys this control. Views automatically destroy themselves when they are removed from the design container. /// protected override void Dispose(bool disposing) { @@ -2061,7 +2061,7 @@ protected override void Dispose(bool disposing) } /// - /// Retrieves the tray control object for the given component. + /// Retrieves the tray control object for the given component. /// public static TrayControl FromComponent(IComponent component) { @@ -2085,7 +2085,7 @@ public static TrayControl FromComponent(IComponent component) } /// - /// Delegate that is called in response to a name change. Here we update our own stashed version of the name, recalcuate our size and repaint. + /// Delegate that is called in response to a name change. Here we update our own stashed version of the name, recalcuate our size and repaint. /// private void OnComponentRename(object sender, ComponentRenameEventArgs e) { @@ -2097,7 +2097,7 @@ private void OnComponentRename(object sender, ComponentRenameEventArgs e) } /// - /// Overrides handle creation notification for a control. Here we just ensure that we're the proper size. + /// Overrides handle creation notification for a control. Here we just ensure that we're the proper size. /// protected override void OnHandleCreated(EventArgs e) { @@ -2106,7 +2106,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Called in response to a double-click of the left mouse button. The default behavior here calls onDoubleClick on IMouseHandler + /// Called in response to a double-click of the left mouse button. The default behavior here calls onDoubleClick on IMouseHandler /// protected override void OnDoubleClick(EventArgs e) { @@ -2134,7 +2134,7 @@ protected override void OnDoubleClick(EventArgs e) } /// - /// Terminates our drag operation. + /// Terminates our drag operation. /// private void OnEndDrag(bool cancel) { @@ -2166,7 +2166,7 @@ private void OnEndDrag(bool cancel) } /// - /// Called when the mouse button is pressed down. Here, we provide drag support for the component. + /// Called when the mouse button is pressed down. Here, we provide drag support for the component. /// protected override void OnMouseDown(MouseEventArgs me) { @@ -2196,7 +2196,7 @@ protected override void OnMouseDown(MouseEventArgs me) } /// - /// Called when the mouse is moved over the component. We update our drag information here if we're dragging the component around. + /// Called when the mouse is moved over the component. We update our drag information here if we're dragging the component around. /// protected override void OnMouseMove(MouseEventArgs me) { @@ -2251,7 +2251,7 @@ protected override void OnMouseMove(MouseEventArgs me) } /// - /// Called when the mouse button is released. Here, we finish our drag if one was started. + /// Called when the mouse button is released. Here, we finish our drag if one was started. /// protected override void OnMouseUp(MouseEventArgs me) { @@ -2260,7 +2260,7 @@ protected override void OnMouseUp(MouseEventArgs me) } /// - /// Called when we are to display our context menu for this component. + /// Called when we are to display our context menu for this component. /// private void OnContextMenu(int x, int y) { @@ -2284,7 +2284,7 @@ private void OnContextMenu(int x, int y) } /// - /// Painting for our control. + /// Painting for our control. /// protected override void OnPaint(PaintEventArgs e) { @@ -2355,7 +2355,7 @@ protected override void OnPaint(PaintEventArgs e) } /// - /// Overrides control's FontChanged. Here we re-adjust our size if the font changes. + /// Overrides control's FontChanged. Here we re-adjust our size if the font changes. /// protected override void OnFontChanged(EventArgs e) { @@ -2364,7 +2364,7 @@ protected override void OnFontChanged(EventArgs e) } /// - /// Overrides control's LocationChanged. Here, we make sure that any glyphs associated with us are also relocated. + /// Overrides control's LocationChanged. Here, we make sure that any glyphs associated with us are also relocated. /// protected override void OnLocationChanged(EventArgs e) { @@ -2375,7 +2375,7 @@ protected override void OnLocationChanged(EventArgs e) } /// - /// Overrides control's TextChanged. Here we re-adjust our size if the font changes. + /// Overrides control's TextChanged. Here we re-adjust our size if the font changes. /// protected override void OnTextChanged(EventArgs e) { @@ -2384,10 +2384,10 @@ protected override void OnTextChanged(EventArgs e) } /// - /// Called each time the cursor needs to be set. The ControlDesigner behavior here will set the cursor to one of three things: - /// 1. If the selection UI service shows a locked selection, or if there is no location property on the control, then the default arrow will be set. - /// 2. Otherwise, the four headed arrow will be set to indicate that the component can be clicked and moved. - /// 3. If the user is currently dragging a component, the crosshair cursor will be used instead of the four headed arrow. + /// Called each time the cursor needs to be set. The ControlDesigner behavior here will set the cursor to one of three things: + /// 1. If the selection UI service shows a locked selection, or if there is no location property on the control, then the default arrow will be set. + /// 2. Otherwise, the four headed arrow will be set to indicate that the component can be clicked and moved. + /// 3. If the user is currently dragging a component, the crosshair cursor will be used instead of the four headed arrow. /// private void OnSetCursor() { @@ -2486,7 +2486,7 @@ internal void UpdateIconInfo() } /// - /// This creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location. + /// This creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location. /// public virtual void ViewDefaultEvent(IComponent component) { @@ -2544,7 +2544,7 @@ public virtual void ViewDefaultEvent(IComponent component) } /// - /// This method should be called by the extending designer for each message the control would normally receive. This allows the designer to pre-process messages before allowing them to be routed to the control. + /// This method should be called by the extending designer for each message the control would normally receive. This allows the designer to pre-process messages before allowing them to be routed to the control. /// protected override void WndProc(ref Message m) { @@ -2630,7 +2630,7 @@ private class ComponentTrayGlyphManager private readonly BehaviorService _behaviorSvc; /// - /// Constructor that simply creates an empty adorner. + /// Constructor that simply creates an empty adorner. /// public ComponentTrayGlyphManager(ISelectionService selSvc, BehaviorService behaviorSvc) { @@ -2640,7 +2640,7 @@ public ComponentTrayGlyphManager(ISelectionService selSvc, BehaviorService behav } /// - /// This is how we publically expose our glyph collection so that other designer services can 'add value'. + /// This is how we publically expose our glyph collection so that other designer services can 'add value'. /// public GlyphCollection SelectionGlyphs { @@ -2648,7 +2648,7 @@ public GlyphCollection SelectionGlyphs } /// - /// Clears teh adorner of glyphs. + /// Clears teh adorner of glyphs. /// public void Dispose() { @@ -2660,7 +2660,7 @@ public void Dispose() } /// - /// Retrieves a list of glyphs associated with the component. + /// Retrieves a list of glyphs associated with the component. /// public GlyphCollection GetGlyphsForComponent(IComponent comp) { @@ -2680,7 +2680,7 @@ public GlyphCollection GetGlyphsForComponent(IComponent comp) } /// - /// Called from the tray's NCHITTEST message in the WndProc. We use this to loop through our glyphs and identify which one is successfully hit tested. From here, we know where to send our messages. + /// Called from the tray's NCHITTEST message in the WndProc. We use this to loop through our glyphs and identify which one is successfully hit tested. From here, we know where to send our messages. /// public Cursor GetHitTest(Point p) { @@ -2698,7 +2698,7 @@ public Cursor GetHitTest(Point p) } /// - /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. + /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. /// public bool OnMouseDoubleClick(MouseEventArgs e) { @@ -2710,7 +2710,7 @@ public bool OnMouseDoubleClick(MouseEventArgs e) } /// - /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. + /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. /// public bool OnMouseDown(MouseEventArgs e) { @@ -2722,7 +2722,7 @@ public bool OnMouseDown(MouseEventArgs e) } /// - /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. + /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. /// public bool OnMouseMove(MouseEventArgs e) { @@ -2734,7 +2734,7 @@ public bool OnMouseMove(MouseEventArgs e) } /// - /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. + /// Called when the tray receives this mouse message. Here, we'll give our glyphs the first chance to repsond to the message before the tray even sees it. /// public bool OnMouseUp(MouseEventArgs e) { @@ -2746,7 +2746,7 @@ public bool OnMouseUp(MouseEventArgs e) } /// - /// Called when the comp tray or any tray control paints. This will simply enumerate through the glyphs in our Adorner and ask them to paint + /// Called when the comp tray or any tray control paints. This will simply enumerate through the glyphs in our Adorner and ask them to paint /// public void OnPaintGlyphs(PaintEventArgs pe) { @@ -2758,7 +2758,7 @@ public void OnPaintGlyphs(PaintEventArgs pe) } /// - /// Called when a tray control's location has changed. We'll loop through our glyphs and invalidate any that are associated with the component. + /// Called when a tray control's location has changed. We'll loop through our glyphs and invalidate any that are associated with the component. /// public void UpdateLocation(TrayControl trayControl) { @@ -2807,7 +2807,7 @@ private class TraySelectionUIHandler : SelectionUIHandler private Size _snapSize = Size.Empty; /// - /// Creates a new selection UI handler for the given component tray. + /// Creates a new selection UI handler for the given component tray. /// public TraySelectionUIHandler(ComponentTray tray) { @@ -2816,7 +2816,7 @@ public TraySelectionUIHandler(ComponentTray tray) } /// - /// Called when the user has started the drag. + /// Called when the user has started the drag. /// public override bool BeginDrag(object[] components, SelectionRules rules, int initialX, int initialY) { @@ -2826,7 +2826,7 @@ public override bool BeginDrag(object[] components, SelectionRules rules, int in } /// - /// Called when the user has completed the drag. The designer should remove any UI feedback it may be providing. + /// Called when the user has completed the drag. The designer should remove any UI feedback it may be providing. /// public override void EndDrag(object[] components, bool cancel) { @@ -2835,7 +2835,7 @@ public override void EndDrag(object[] components, bool cancel) } /// - /// Retrieves the base component for the selection handler. + /// Retrieves the base component for the selection handler. /// protected override IComponent GetComponent() { @@ -2843,7 +2843,7 @@ protected override IComponent GetComponent() } /// - /// Retrieves the base component's UI control for the selection handler. + /// Retrieves the base component's UI control for the selection handler. /// protected override Control GetControl() { @@ -2851,7 +2851,7 @@ protected override Control GetControl() } /// - /// Retrieves the UI control for the given component. + /// Retrieves the UI control for the given component. /// protected override Control GetControl(IComponent component) { @@ -2859,7 +2859,7 @@ protected override Control GetControl(IComponent component) } /// - /// Retrieves the current grid snap size we should snap objects to. + /// Retrieves the current grid snap size we should snap objects to. /// protected override Size GetCurrentSnapSize() { @@ -2867,7 +2867,7 @@ protected override Size GetCurrentSnapSize() } /// - /// We use this to request often-used services. + /// We use this to request often-used services. /// protected override object GetService(Type serviceType) { @@ -2875,7 +2875,7 @@ protected override object GetService(Type serviceType) } /// - /// Determines if the selection UI handler should attempt to snap objects to a grid. + /// Determines if the selection UI handler should attempt to snap objects to a grid. /// protected override bool GetShouldSnapToGrid() { @@ -2883,7 +2883,7 @@ protected override bool GetShouldSnapToGrid() } /// - /// Given a rectangle, this updates the dimensions of it with any grid snaps and returns a new rectangle. If no changes to the rectangle's size were needed, this may return the same rectangle. + /// Given a rectangle, this updates the dimensions of it with any grid snaps and returns a new rectangle. If no changes to the rectangle's size were needed, this may return the same rectangle. /// public override Rectangle GetUpdatedRect(Rectangle originalRect, Rectangle dragRect, bool updateSize) { @@ -2891,7 +2891,7 @@ public override Rectangle GetUpdatedRect(Rectangle originalRect, Rectangle dragR } /// - /// Asks the handler to set the appropriate cursor + /// Asks the handler to set the appropriate cursor /// public override void SetCursor() { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgs.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgs.cs index 7c1af36b0b2..e47eb681fa3 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides data for the event. + /// Provides data for the event. /// internal class ContainerSelectorActiveEventArgs : EventArgs { @@ -13,14 +13,14 @@ internal class ContainerSelectorActiveEventArgs : EventArgs private readonly ContainerSelectorActiveEventArgsType _eventType; /// - /// Initializes a new instance of the 'ContainerSelectorActiveEventArgs' class. + /// Initializes a new instance of the 'ContainerSelectorActiveEventArgs' class. /// public ContainerSelectorActiveEventArgs(object component) : this(component, ContainerSelectorActiveEventArgsType.Mouse) { } /// - /// Initializes a new instance of the 'ContainerSelectorActiveEventArgs' class. + /// Initializes a new instance of the 'ContainerSelectorActiveEventArgs' class. /// public ContainerSelectorActiveEventArgs(object component, ContainerSelectorActiveEventArgsType eventType) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgsType.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgsType.cs index ad86ebeb6c0..cfda5c9b526 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgsType.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventArgsType.cs @@ -5,16 +5,16 @@ namespace System.Windows.Forms.Design { /// - /// Specifies IDs for containers of certain event types. + /// Specifies IDs for containers of certain event types. /// internal enum ContainerSelectorActiveEventArgsType { /// - /// Indicates the container of the active event was the contextmenu. + /// Indicates the container of the active event was the contextmenu. /// Contextmenu = 1, /// - /// Indicates the container of the active event was the mouse. + /// Indicates the container of the active event was the mouse. /// Mouse = 2, } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventHandler.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventHandler.cs index 56ebde47c62..1d5c4baa001 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ContainerSelectorActiveEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.Design { /// - /// Represents the method that will handle a ContainerSelectorActive event. + /// Represents the method that will handle a ContainerSelectorActive event. /// internal delegate void ContainerSelectorActiveEventHandler(object sender, ContainerSelectorActiveEventArgs e); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ControlDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ControlDesigner.cs index fdb0a63c68f..282bc5ae951 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ControlDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ControlDesigner.cs @@ -20,7 +20,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a designer that can design components that extend Control. + /// Provides a designer that can design components that extend Control. /// public class ControlDesigner : ComponentDesigner { @@ -92,7 +92,7 @@ internal bool ForceVisible } /// - /// Retrieves a list of associated components. These are components that should be incluced in a cut or copy operation on this component. + /// Retrieves a list of associated components. These are components that should be incluced in a cut or copy operation on this component. /// public override ICollection AssociatedComponents { @@ -134,7 +134,7 @@ public virtual AccessibleObject AccessibilityObject } /// - /// Retrieves the control we're designing. + /// Retrieves the control we're designing. /// public virtual Control Control { @@ -142,7 +142,7 @@ public virtual Control Control } /// - /// Determines whether drag rects can be drawn on this designer. + /// Determines whether drag rects can be drawn on this designer. /// protected virtual bool EnableDragRect { @@ -150,7 +150,7 @@ protected virtual bool EnableDragRect } /// - /// Returns the parent component for this control designer. The default implementation just checks to see if the component being designed is a control, and if it is it returns its parent. This property can return null if there is no parent component. + /// Returns the parent component for this control designer. The default implementation just checks to see if the component being designed is a control, and if it is it returns its parent. This property can return null if there is no parent component. /// protected override IComponent ParentComponent { @@ -165,7 +165,7 @@ protected override IComponent ParentComponent } /// - /// Determines whether or not the ControlDesigner will allow SnapLine alignment during a drag operation when the primary drag control is over this designer, or when a control is being dragged from the toolbox, or when a control is being drawn through click-drag. + /// Determines whether or not the ControlDesigner will allow SnapLine alignment during a drag operation when the primary drag control is over this designer, or when a control is being dragged from the toolbox, or when a control is being drawn through click-drag. /// public virtual bool ParticipatesWithSnapLines { @@ -197,7 +197,7 @@ private Dictionary SubclassedChildWindows } /// - /// Retrieves a set of rules concerning the movement capabilities of a component. This should be one or more flags from the SelectionRules class. If no designer provides rules for a component, the component will not get any UI services. + /// Retrieves a set of rules concerning the movement capabilities of a component. This should be one or more flags from the SelectionRules class. If no designer provides rules for a component, the component will not get any UI services. /// public virtual SelectionRules SelectionRules { @@ -322,7 +322,7 @@ private bool IsResizableConsiderAutoSize(PropertyDescriptor autoSizeProp, Proper } /// - /// Returns a list of SnapLine objects representing interesting alignment points for this control. These SnapLines are used to assist in the positioning of the control on a parent's surface. + /// Returns a list of SnapLine objects representing interesting alignment points for this control. These SnapLines are used to assist in the positioning of the control on a parent's surface. /// public virtual IList SnapLines { @@ -382,27 +382,27 @@ protected override InheritanceAttribute InheritanceAttribute } /// - /// Returns the number of internal control designers in the ControlDesigner. An internal control is a control that is not in the IDesignerHost.Container.Components collection. SplitterPanel is an example of one such control. We use this to get SnapLines for the internal control designers. + /// Returns the number of internal control designers in the ControlDesigner. An internal control is a control that is not in the IDesignerHost.Container.Components collection. SplitterPanel is an example of one such control. We use this to get SnapLines for the internal control designers. /// public virtual int NumberOfInternalControlDesigners() => 0; /// - /// Returns the internal control designer with the specified index in the ControlDesigner. An internal control is a control that is not in the IDesignerHost.Container.Components collection. SplitterPanel is an example of one such control. internalControlIndex is zero-based. + /// Returns the internal control designer with the specified index in the ControlDesigner. An internal control is a control that is not in the IDesignerHost.Container.Components collection. SplitterPanel is an example of one such control. internalControlIndex is zero-based. /// public virtual ControlDesigner InternalControlDesigner(int internalControlIndex) => null; /// - /// Default processing for messages. This method causes the message to get processed by windows, skipping the control. This is useful if you want to block this message from getting to the control, but you do not want to block it from getting to Windows itself because it causes other messages to be generated. + /// Default processing for messages. This method causes the message to get processed by windows, skipping the control. This is useful if you want to block this message from getting to the control, but you do not want to block it from getting to Windows itself because it causes other messages to be generated. /// protected void BaseWndProc(ref Message m) => m.Result = UnsafeNativeMethods.DefWindowProc(m.HWnd, m.Msg, m.WParam, m.LParam); /// - /// Determines if the this designer can be parented to the specified desinger -- generally this means if the control for this designer can be parented into the given ParentControlDesigner's designer. + /// Determines if the this designer can be parented to the specified desinger -- generally this means if the control for this designer can be parented into the given ParentControlDesigner's designer. /// public virtual bool CanBeParentedTo(IDesigner parentDesigner) => parentDesigner is ParentControlDesigner p && !Control.Contains(p.Control); /// - /// Default processing for messages. This method causes the message to get processed by the control, rather than the designer. + /// Default processing for messages. This method causes the message to get processed by the control, rather than the designer. /// protected void DefWndProc(ref Message m) { @@ -410,7 +410,7 @@ protected void DefWndProc(ref Message m) } /// - /// Displays the given exception to the user. + /// Displays the given exception to the user. /// protected void DisplayError(Exception e) { @@ -431,7 +431,7 @@ protected void DisplayError(Exception e) } /// - /// Disposes of this object. + /// Disposes of this object. /// protected override void Dispose(bool disposing) { @@ -578,7 +578,7 @@ private void DataSource_ComponentRemoved(object sender, ComponentEventArgs e) } /// - /// Enables design time functionality for a child control. The child control is a child of this control designer's control. The child does not directly participate in persistence, but it will if it is exposed as a property of the main control. Consider a control like the SplitContainer: it has two panels, Panel1 and Panel2. These panels are exposed through read only Panel1 and Panel2 properties on the SplitContainer class. SplitContainer's designer calls EnableDesignTime for each panel, which allows other components to be dropped on them. But, in order for the contents of Panel1 and Panel2 to be saved, SplitContainer itself needed to expose the panels as public properties. The child paramter is the control to enable. The name paramter is the name of this control as exposed to the end user. Names need to be unique within a control designer, but do not have to be unique to other control designer's children. This method returns true if the child control could be enabled for design time, or false if the hosting infrastructure does not support it. To support this feature, the hosting infrastructure must expose the INestedContainer class as a service off of the site. + /// Enables design time functionality for a child control. The child control is a child of this control designer's control. The child does not directly participate in persistence, but it will if it is exposed as a property of the main control. Consider a control like the SplitContainer: it has two panels, Panel1 and Panel2. These panels are exposed through read only Panel1 and Panel2 properties on the SplitContainer class. SplitContainer's designer calls EnableDesignTime for each panel, which allows other components to be dropped on them. But, in order for the contents of Panel1 and Panel2 to be saved, SplitContainer itself needed to expose the panels as public properties. The child paramter is the control to enable. The name paramter is the name of this control as exposed to the end user. Names need to be unique within a control designer, but do not have to be unique to other control designer's children. This method returns true if the child control could be enabled for design time, or false if the hosting infrastructure does not support it. To support this feature, the hosting infrastructure must expose the INestedContainer class as a service off of the site. /// protected bool EnableDesignMode(Control child, string name) { @@ -610,7 +610,7 @@ protected bool EnableDesignMode(Control child, string name) } /// - /// Enables or disables drag/drop support. This hooks drag event handlers to the control. + /// Enables or disables drag/drop support. This hooks drag event handlers to the control. /// protected void EnableDragDrop(bool value) { @@ -697,7 +697,7 @@ internal System.Windows.Forms.Design.Behavior.Behavior MoveBehavior } /// - /// Returns a 'BodyGlyph' representing the bounds of this control. The BodyGlyph is responsible for hit testing the related CtrlDes and forwarding messages directly to the designer. + /// Returns a 'BodyGlyph' representing the bounds of this control. The BodyGlyph is responsible for hit testing the related CtrlDes and forwarding messages directly to the designer. /// protected virtual ControlBodyGlyph GetControlGlyph(GlyphSelectionType selectionType) { @@ -741,7 +741,7 @@ protected virtual ControlBodyGlyph GetControlGlyph(GlyphSelectionType selectionT internal ControlBodyGlyph GetControlGlyphInternal(GlyphSelectionType selectionType) => GetControlGlyph(selectionType); /// - /// Returns a collection of Glyph objects representing the selection borders and grab handles for a standard control. Note that based on 'selectionType' the Glyphs returned will either: represent a fully resizeable selection border with grab handles, a locked selection border, or a single 'hidden' selection Glyph. + /// Returns a collection of Glyph objects representing the selection borders and grab handles for a standard control. Note that based on 'selectionType' the Glyphs returned will either: represent a fully resizeable selection border with grab handles, a locked selection border, or a single 'hidden' selection Glyph. /// public virtual GlyphCollection GetGlyphs(GlyphSelectionType selectionType) { @@ -856,7 +856,7 @@ internal virtual bool SerializePerformLayout } /// - /// Allows your component to support a design time user interface. A TabStrip control, for example, has a design time user interface that allows the user to click the tabs to change tabs. To implement this, TabStrip returns true whenever the given point is within its tabs. + /// Allows your component to support a design time user interface. A TabStrip control, for example, has a design time user interface that allows the user to click the tabs to change tabs. To implement this, TabStrip returns true whenever the given point is within its tabs. /// protected virtual bool GetHitTest(Point point) { @@ -864,7 +864,7 @@ protected virtual bool GetHitTest(Point point) } /// - /// Hooks the children of the given control. We need to do this for child controls that are not in design mode, which is the case for composite controls. + /// Hooks the children of the given control. We need to do this for child controls that are not in design mode, which is the case for composite controls. /// protected void HookChildControls(Control firstChild) { @@ -912,7 +912,7 @@ private void OnChildHandleCreated(object sender, EventArgs e) } /// - /// Called by the host when we're first initialized. + /// Called by the host when we're first initialized. /// public override void Initialize(IComponent component) { @@ -1107,7 +1107,7 @@ private bool Visible } /// - /// ControlDesigner overrides this method to handle after-drop cases. + /// ControlDesigner overrides this method to handle after-drop cases. /// public override void InitializeExistingComponent(IDictionary defaultValues) { @@ -1127,7 +1127,7 @@ public override void InitializeExistingComponent(IDictionary defaultValues) } /// - /// ControlDesigner overrides this method. It will look at the default property for the control and, if it is of type string, it will set this property's value to the name of the component. It only does this if the designer has been configured with this option in the options service. This method also connects the control to its parent and positions it. If you override this method, you should always call base. + /// ControlDesigner overrides this method. It will look at the default property for the control and, if it is of type string, it will set this property's value to the name of the component. It only does this if the designer has been configured with this option in the options service. This method also connects the control to its parent and positions it. If you override this method, you should always call base. /// public override void InitializeNewComponent(IDictionary defaultValues) { @@ -1186,7 +1186,7 @@ public override void InitializeNewComponent(IDictionary defaultValues) } /// - /// Called when the designer is intialized. This allows the designer to provide some meaningful default values in the component. The default implementation of this sets the components's default property to it's name, if that property is a string. + /// Called when the designer is intialized. This allows the designer to provide some meaningful default values in the component. The default implementation of this sets the components's default property to it's name, if that property is a string. /// [Obsolete("This method has been deprecated. Use InitializeNewComponent instead. http://go.microsoft.com/fwlink/?linkid=14202")] public override void OnSetComponentDefaults() @@ -1203,7 +1203,7 @@ public override void OnSetComponentDefaults() } /// - /// Called when the context menu should be displayed + /// Called when the context menu should be displayed /// protected virtual void OnContextMenu(int x, int y) { @@ -1211,7 +1211,7 @@ protected virtual void OnContextMenu(int x, int y) } /// - /// This is called immediately after the control handle has been created. + /// This is called immediately after the control handle has been created. /// protected virtual void OnCreateHandle() { @@ -1223,7 +1223,7 @@ protected virtual void OnCreateHandle() } /// - /// Called when a drag-drop operation enters the control designer view + /// Called when a drag-drop operation enters the control designer view /// protected virtual void OnDragEnter(DragEventArgs de) { @@ -1236,7 +1236,7 @@ protected virtual void OnDragEnter(DragEventArgs de) } /// - /// Called to cleanup a D&D operation + /// Called to cleanup a D&D operation /// protected virtual void OnDragComplete(DragEventArgs de) { @@ -1244,7 +1244,7 @@ protected virtual void OnDragComplete(DragEventArgs de) } /// - /// Called when a drag drop object is dropped onto the control designer view + /// Called when a drag drop object is dropped onto the control designer view /// protected virtual void OnDragDrop(DragEventArgs de) { @@ -1258,7 +1258,7 @@ protected virtual void OnDragDrop(DragEventArgs de) } /// - /// Called when a drag-drop operation leaves the control designer view + /// Called when a drag-drop operation leaves the control designer view /// protected virtual void OnDragLeave(EventArgs e) { @@ -1271,7 +1271,7 @@ protected virtual void OnDragLeave(EventArgs e) } /// - /// Called when a drag drop object is dragged over the control designer view + /// Called when a drag drop object is dragged over the control designer view /// protected virtual void OnDragOver(DragEventArgs de) { @@ -1284,14 +1284,14 @@ protected virtual void OnDragOver(DragEventArgs de) } /// - /// Event handler for our GiveFeedback event, which is called when a drag operation is in progress. The host will call us with this when an OLE drag event happens. + /// Event handler for our GiveFeedback event, which is called when a drag operation is in progress. The host will call us with this when an OLE drag event happens. /// protected virtual void OnGiveFeedback(GiveFeedbackEventArgs e) { } /// - /// Called in response to the left mouse button being pressed on a component. It ensures that the component is selected. + /// Called in response to the left mouse button being pressed on a component. It ensures that the component is selected. /// protected virtual void OnMouseDragBegin(int x, int y) { @@ -1312,7 +1312,7 @@ protected virtual void OnMouseDragBegin(int x, int y) } /// - /// Called at the end of a drag operation. This either commits or rolls back the drag. + /// Called at the end of a drag operation. This either commits or rolls back the drag. /// protected virtual void OnMouseDragEnd(bool cancel) { @@ -1362,7 +1362,7 @@ protected virtual void OnMouseDragEnd(bool cancel) } /// - /// Called for each movement of the mouse. This will check to see if a drag operation is in progress. If so, it will pass the updated drag dimensions on to the selection UI service. + /// Called for each movement of the mouse. This will check to see if a drag operation is in progress. If so, it will pass the updated drag dimensions on to the selection UI service. /// protected virtual void OnMouseDragMove(int x, int y) { @@ -1438,7 +1438,7 @@ protected virtual void OnMouseDragMove(int x, int y) } /// - /// Called when the mouse first enters the control. This is forwarded to the parent designer to enable the container selector. + /// Called when the mouse first enters the control. This is forwarded to the parent designer to enable the container selector. /// protected virtual void OnMouseEnter() { @@ -1465,9 +1465,9 @@ protected virtual void OnMouseEnter() } /// - /// Called after the mouse hovers over the control. This is forwarded to the parent designer to enabled the container selector. - /// Called after the mouse hovers over the control. This is forwarded to the parent - /// designer to enabled the container selector. + /// Called after the mouse hovers over the control. This is forwarded to the parent designer to enabled the container selector. + /// Called after the mouse hovers over the control. This is forwarded to the parent + /// designer to enabled the container selector. /// protected virtual void OnMouseHover() { @@ -1494,7 +1494,7 @@ protected virtual void OnMouseHover() } /// - /// Called when the mouse first enters the control. This is forwarded to the parent designer to enable the container selector. + /// Called when the mouse first enters the control. This is forwarded to the parent designer to enable the container selector. /// protected virtual void OnMouseLeave() { @@ -1521,7 +1521,7 @@ protected virtual void OnMouseLeave() } /// - /// Called when the control we're designing has finished painting. This method gives the designer a chance to paint any additional adornments on top of the control. + /// Called when the control we're designing has finished painting. This method gives the designer a chance to paint any additional adornments on top of the control. /// protected virtual void OnPaintAdornments(PaintEventArgs pe) { @@ -1533,11 +1533,11 @@ protected virtual void OnPaintAdornments(PaintEventArgs pe) } /// - /// Called each time the cursor needs to be set. The ControlDesigner behavior here will set the cursor to one of three things: - /// 1. If the toolbox service has a tool selected, it will allow the toolbox service to set the cursor. - /// 2. If the selection UI service shows a locked selection, or if there is no location property on the control, then the default arrow will be set. - /// 3. Otherwise, the four headed arrow will be set to indicate that the component can be clicked and moved. - /// 4. If the user is currently dragging a component, the crosshair cursor will be used instead of the four headed arrow. + /// Called each time the cursor needs to be set. The ControlDesigner behavior here will set the cursor to one of three things: + /// 1. If the toolbox service has a tool selected, it will allow the toolbox service to set the cursor. + /// 2. If the selection UI service shows a locked selection, or if there is no location property on the control, then the default arrow will be set. + /// 3. Otherwise, the four headed arrow will be set to indicate that the component can be clicked and moved. + /// 4. If the user is currently dragging a component, the crosshair cursor will be used instead of the four headed arrow. /// protected virtual void OnSetCursor() { @@ -1591,7 +1591,7 @@ private bool Locked } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -1631,7 +1631,7 @@ protected override void PreFilterProperties(IDictionary properties) } /// - /// Hooks the children of the given control. We need to do this for child controls that are not in design mode, which is the case for composite controls. + /// Hooks the children of the given control. We need to do this for child controls that are not in design mode, which is the case for composite controls. /// protected void UnhookChildControls(Control firstChild) { @@ -1660,7 +1660,7 @@ protected void UnhookChildControls(Control firstChild) } /// - /// This method should be called by the extending designer for each message the control would normally receive. This allows the designer to pre-process messages before allowing them to be routed to the control. + /// This method should be called by the extending designer for each message the control would normally receive. This allows the designer to pre-process messages before allowing them to be routed to the control. /// protected virtual void WndProc(ref Message m) { @@ -2549,7 +2549,7 @@ public override AccessibleObject GetSelected() } /// - /// This TransparentBehavior is associated with the BodyGlyph for this ControlDesigner. When the BehaviorService hittests a glyph w/a TransparentBehavior, all messages will be passed through the BehaviorService directly to the ControlDesigner. During a Drag operation, when the BehaviorService hittests + /// This TransparentBehavior is associated with the BodyGlyph for this ControlDesigner. When the BehaviorService hittests a glyph w/a TransparentBehavior, all messages will be passed through the BehaviorService directly to the ControlDesigner. During a Drag operation, when the BehaviorService hittests /// internal class TransparentBehavior : Behavior.Behavior { @@ -2557,7 +2557,7 @@ internal class TransparentBehavior : Behavior.Behavior Rectangle _controlRect = Rectangle.Empty; /// - /// Constructor that accepts the related ControlDesigner. + /// Constructor that accepts the related ControlDesigner. /// internal TransparentBehavior(ControlDesigner designer) { @@ -2565,12 +2565,12 @@ internal TransparentBehavior(ControlDesigner designer) } /// - /// This property performs a hit test on the ControlDesigner to determine if the BodyGlyph should return '-1' for hit testing (letting all messages pass directly to the the control). + /// This property performs a hit test on the ControlDesigner to determine if the BodyGlyph should return '-1' for hit testing (letting all messages pass directly to the the control). /// internal bool IsTransparent(Point p) => _designer.GetHitTest(p); /// - /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. + /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. /// public override void OnDragDrop(Glyph g, DragEventArgs e) { @@ -2579,7 +2579,7 @@ public override void OnDragDrop(Glyph g, DragEventArgs e) } /// - /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. + /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. /// public override void OnDragEnter(Glyph g, DragEventArgs e) { @@ -2591,7 +2591,7 @@ public override void OnDragEnter(Glyph g, DragEventArgs e) } /// - /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. + /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. /// public override void OnDragLeave(Glyph g, EventArgs e) { @@ -2600,7 +2600,7 @@ public override void OnDragLeave(Glyph g, EventArgs e) } /// - /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. + /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. /// public override void OnDragOver(Glyph g, DragEventArgs e) { @@ -2614,7 +2614,7 @@ public override void OnDragOver(Glyph g, DragEventArgs e) } /// - /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. + /// Forwards DragDrop notification from the BehaviorService to the related ControlDesigner. /// public override void OnGiveFeedback(Glyph g, GiveFeedbackEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CustomMenuItemCollection.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CustomMenuItemCollection.cs index 9f9c45e0299..9847d5538db 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CustomMenuItemCollection.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/CustomMenuItemCollection.cs @@ -7,19 +7,19 @@ namespace System.Windows.Forms.Design { /// - /// A strongly-typed collection that stores ToolStripMenuItem objects for DesignerContextMenu + /// A strongly-typed collection that stores ToolStripMenuItem objects for DesignerContextMenu /// internal class CustomMenuItemCollection : CollectionBase { /// - /// Constructor + /// Constructor /// public CustomMenuItemCollection() { } /// - /// Add value to the collection + /// Add value to the collection /// public int Add(ToolStripItem value) { @@ -27,7 +27,7 @@ public int Add(ToolStripItem value) } /// - /// Add range of values to the collection + /// Add range of values to the collection /// public void AddRange(ToolStripItem[] value) { @@ -38,7 +38,7 @@ public void AddRange(ToolStripItem[] value) } /// - /// Abstract base class version for refreshing the items + /// Abstract base class version for refreshing the items /// public virtual void RefreshItems() { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedEventArgs.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedEventArgs.cs index 9b1162ab9c9..7b9aaa1a0fe 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedEventArgs.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedEventArgs.cs @@ -5,12 +5,12 @@ namespace System.ComponentModel.Design { /// - /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. + /// This EventArgs class is used by the DesignerActionService to signify that there has been a change in DesignerActionLists (added or removed) on the related object. /// public class DesignerActionListsChangedEventArgs : EventArgs { /// - /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object. on the related object. + /// Constructor that requires the object in question, the type of change and the remaining actionlists left for the object. on the related object. /// public DesignerActionListsChangedEventArgs(object relatedObject, DesignerActionListsChangedType changeType, DesignerActionListCollection actionLists) { @@ -20,17 +20,17 @@ public DesignerActionListsChangedEventArgs(object relatedObject, DesignerActionL } /// - /// The object this change is related to. + /// The object this change is related to. /// public object RelatedObject { get; } /// - /// The type of changed that caused the related event to be thrown. + /// The type of changed that caused the related event to be thrown. /// public DesignerActionListsChangedType ChangeType { get; } /// - /// The remaining actionlists left for the related object. + /// The remaining actionlists left for the related object. /// public DesignerActionListCollection ActionLists { get; } } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedType.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedType.cs index 6e939eeb40d..adeefc5cc04 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedType.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionListsChangedType.cs @@ -7,18 +7,18 @@ namespace System.ComponentModel.Design { /// - /// An enum that defines what time of action happend to the related object's DesignerActionLists collection. + /// An enum that defines what time of action happend to the related object's DesignerActionLists collection. /// [ComVisible(true)] public enum DesignerActionListsChangedType { /// - /// Signifies that one or more DesignerActionList was added. + /// Signifies that one or more DesignerActionList was added. /// ActionListsAdded, /// - /// Signifies that one or more DesignerActionList was removed. + /// Signifies that one or more DesignerActionList was removed. /// ActionListsRemoved } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionService.cs index 9e34f9c8210..dcae7e135e8 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionService.cs @@ -9,7 +9,7 @@ namespace System.ComponentModel.Design { /// - /// The DesignerActionService manages DesignerActions. All DesignerActions are associated with an object. DesignerActions can be added or removed at any given time. The DesignerActionService controls the expiration of DesignerActions by monitoring three basic events: selection change, component change, and timer expiration. Designer implementing this service will need to monitor the DesignerActionsChanged event on this class. This event will fire every time a change is made to any object's DesignerActions. + /// The DesignerActionService manages DesignerActions. All DesignerActions are associated with an object. DesignerActions can be added or removed at any given time. The DesignerActionService controls the expiration of DesignerActions by monitoring three basic events: selection change, component change, and timer expiration. Designer implementing this service will need to monitor the DesignerActionsChanged event on this class. This event will fire every time a change is made to any object's DesignerActions. /// public class DesignerActionService : IDisposable { @@ -22,7 +22,7 @@ public class DesignerActionService : IDisposable private bool _reEntrantCode = false; /// - /// Standard constructor. A Service Provider is necessary for monitoring selection and component changes. + /// Standard constructor. A Service Provider is necessary for monitoring selection and component changes. /// public DesignerActionService(IServiceProvider serviceProvider) { @@ -45,7 +45,7 @@ public DesignerActionService(IServiceProvider serviceProvider) } /// - /// This event is thrown whenever a DesignerActionList is removed or added for any object. + /// This event is thrown whenever a DesignerActionList is removed or added for any object. /// public event DesignerActionListsChangedEventHandler DesignerActionListsChanged { @@ -54,7 +54,7 @@ public event DesignerActionListsChangedEventHandler DesignerActionListsChanged } /// - /// Adds a new collection of DesignerActions to be monitored with the related comp object. + /// Adds a new collection of DesignerActions to be monitored with the related comp object. /// public void Add(IComponent comp, DesignerActionListCollection designerActionListCollection) { @@ -82,7 +82,7 @@ public void Add(IComponent comp, DesignerActionListCollection designerActionList } /// - /// Adds a new DesignerActionList to be monitored with the related comp object + /// Adds a new DesignerActionList to be monitored with the related comp object /// public void Add(IComponent comp, DesignerActionList actionList) { @@ -90,7 +90,7 @@ public void Add(IComponent comp, DesignerActionList actionList) } /// - /// Clears all objects and DesignerActions from the DesignerActionService. + /// Clears all objects and DesignerActions from the DesignerActionService. /// public void Clear() { @@ -117,7 +117,7 @@ public void Clear() } /// - /// Returns true if the DesignerActionService is currently managing the comp object. + /// Returns true if the DesignerActionService is currently managing the comp object. /// public bool Contains(IComponent comp) { @@ -129,7 +129,7 @@ public bool Contains(IComponent comp) } /// - /// Disposes all resources and unhooks all events. + /// Disposes all resources and unhooks all events. /// public void Dispose() { @@ -317,7 +317,7 @@ protected virtual void GetComponentServiceActions(IComponent component, Designer } /// - /// We hook the OnComponentRemoved event so we can clean up all associated actions. + /// We hook the OnComponentRemoved event so we can clean up all associated actions. /// private void OnComponentRemoved(object source, ComponentEventArgs ce) { @@ -325,7 +325,7 @@ private void OnComponentRemoved(object source, ComponentEventArgs ce) } /// - /// This fires our DesignerActionsChanged event. + /// This fires our DesignerActionsChanged event. /// private void OnDesignerActionListsChanged(DesignerActionListsChangedEventArgs e) { @@ -333,7 +333,7 @@ private void OnDesignerActionListsChanged(DesignerActionListsChangedEventArgs e) } /// - /// This will remove all DesignerActions associated with the 'comp' object. All alarms will be unhooked and the DesignerActionsChagned event will be fired. + /// This will remove all DesignerActions associated with the 'comp' object. All alarms will be unhooked and the DesignerActionsChagned event will be fired. /// public void Remove(IComponent comp) { @@ -352,7 +352,7 @@ public void Remove(IComponent comp) } /// - /// This will remove the specified Designeraction from the DesignerActionService. All alarms will be unhooked and the DesignerActionsChagned event will be fired. + /// This will remove the specified Designeraction from the DesignerActionService. All alarms will be unhooked and the DesignerActionsChagned event will be fired. /// public void Remove(DesignerActionList actionList) { @@ -373,7 +373,7 @@ public void Remove(DesignerActionList actionList) } /// - /// This will remove the all instances of the DesignerAction from the 'comp' object. If an alarm was set, it will be unhooked. This will also fire the DesignerActionChanged event. + /// This will remove the all instances of the DesignerAction from the 'comp' object. If an alarm was set, it will be unhooked. This will also fire the DesignerActionChanged event. /// public void Remove(IComponent comp, DesignerActionList actionList) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUI.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUI.cs index af4a71580b3..fdeda03f97b 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUI.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUI.cs @@ -14,7 +14,7 @@ namespace System.ComponentModel.Design { /// - /// The DesignerActionUI is the designer/UI-specific implementation of the DesignerActions feature. This class instantiates the DesignerActionService and hooks to its DesignerActionsChanged event. Responding to this single event will enable the DesignerActionUI to perform all neceessary UI-related operations. Note that the DesignerActionUI uses the BehaviorService to manage all UI interaction. For every component containing a DesignerAction (determined by the DesignerActionsChagned event) there will be an associated DesignerActionGlyph and DesignerActionBehavior. Finally, the DesignerActionUI is also responsible for showing and managing the Action's context menus. Note that every DesignerAction context menu has an item that will bring up the DesignerActions option pane in the options dialog. + /// The DesignerActionUI is the designer/UI-specific implementation of the DesignerActions feature. This class instantiates the DesignerActionService and hooks to its DesignerActionsChanged event. Responding to this single event will enable the DesignerActionUI to perform all neceessary UI-related operations. Note that the DesignerActionUI uses the BehaviorService to manage all UI interaction. For every component containing a DesignerAction (determined by the DesignerActionsChagned event) there will be an associated DesignerActionGlyph and DesignerActionBehavior. Finally, the DesignerActionUI is also responsible for showing and managing the Action's context menus. Note that every DesignerAction context menu has an item that will bring up the DesignerActions option pane in the options dialog. /// internal class DesignerActionUI : IDisposable { @@ -50,7 +50,7 @@ internal class DesignerActionUI : IDisposable internal static readonly TraceSwitch DropDownVisibilityDebug; #endif /// - /// Constructor that takes a service provider. This is needed to establish references to the BehaviorService and SelecteionService, as well as spin-up the DesignerActionService. + /// Constructor that takes a service provider. This is needed to establish references to the BehaviorService and SelecteionService, as well as spin-up the DesignerActionService. /// public DesignerActionUI(IServiceProvider serviceProvider, Adorner containerAdorner) { @@ -107,7 +107,7 @@ public DesignerActionUI(IServiceProvider serviceProvider, Adorner containerAdorn } /// - /// Disposes all UI-related objects and unhooks services. + /// Disposes all UI-related objects and unhooks services. /// // Don't need to dispose of designerActionUIService. public void Dispose() @@ -238,7 +238,7 @@ internal DesignerActionGlyph GetDesignerActionGlyph(IComponent comp, DesignerAct } /// - /// We monitor this event so we can update smart tag locations when controls move. + /// We monitor this event so we can update smart tag locations when controls move. /// private void OnComponentChanged(object source, ComponentChangedEventArgs ce) { @@ -366,7 +366,7 @@ private void VerifyGlyphIsInAdorner(DesignerActionGlyph glyph) } /// - /// This event is fired by the DesignerActionService in response to a DesignerActionCollection changing. The event args contains information about the related object, the type of change (added or removed) and the remaining DesignerActionCollection for the object. Note that when new DesignerActions are added, if the related control/ is not yet parented - we add these actions to a "delay" list and they are later created when the control is finally parented. + /// This event is fired by the DesignerActionService in response to a DesignerActionCollection changing. The event args contains information about the related object, the type of change (added or removed) and the remaining DesignerActionCollection for the object. Note that when new DesignerActions are added, if the related control/ is not yet parented - we add these actions to a "delay" list and they are later created when the control is finally parented. /// private void OnDesignerActionsChanged(object sender, DesignerActionListsChangedEventArgs e) { @@ -417,7 +417,7 @@ private void OnDesignerActionUIStateChange(object sender, DesignerActionUIStateC } /// - /// This is the same as DesignerActionChanged, but it is invoked on our control's thread + /// This is the same as DesignerActionChanged, but it is invoked on our control's thread /// private void OnInvokedDesignerActionChanged(object sender, DesignerActionListsChangedEventArgs e) { @@ -456,7 +456,7 @@ private void OnInvokedDesignerActionChanged(object sender, DesignerActionListsCh } /// - /// Called when our KeyShowDesignerActions menu command is fired (a.k.a. Alt+Shift+F10) - we will find the primary selection, see if it has designer actions, and if so - show the menu. + /// Called when our KeyShowDesignerActions menu command is fired (a.k.a. Alt+Shift+F10) - we will find the primary selection, see if it has designer actions, and if so - show the menu. /// private void OnKeyShowDesignerActions(object sender, EventArgs e) { @@ -501,7 +501,7 @@ internal bool ShowDesignerActionPanelForPrimarySelection() } /// - /// When all the DesignerActions have been removed for a particular object, we remove any UI (glyphs) that we may have been managing. + /// When all the DesignerActions have been removed for a particular object, we remove any UI (glyphs) that we may have been managing. /// internal void RemoveActionGlyph(object relatedObject) { @@ -684,7 +684,7 @@ private Point GetGlyphLocationScreenCoord(IComponent relatedComponent, Glyph gly bool _cancelClose = false; /// - /// This shows the actual chrome paenl that is created by the DesignerActionBehavior object. + /// This shows the actual chrome paenl that is created by the DesignerActionBehavior object. /// internal void ShowDesignerActionPanel(IComponent relatedComponent, DesignerActionPanel panel, DesignerActionGlyph glyph) { @@ -949,8 +949,8 @@ protected override void SetVisibleCore(bool visible) } /// - /// General purpose method, based on Control.Contains()... - /// Determines whether a given window (specified using native window handle) is a descendant of this control. This catches both contained descendants and 'owned' windows such as modal dialogs. Using window handles rather than Control objects allows it to catch un-managed windows as well. + /// General purpose method, based on Control.Contains()... + /// Determines whether a given window (specified using native window handle) is a descendant of this control. This catches both contained descendants and 'owned' windows such as modal dialogs. Using window handles rather than Control objects allows it to catch un-managed windows as well. /// private static bool WindowOwnsWindow(IntPtr hWndOwner, IntPtr hWndDescendant) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUIService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUIService.cs index fe12721e52c..bd8b0c01324 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUIService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerActionUIService.cs @@ -32,7 +32,7 @@ internal DesignerActionUIService(IServiceProvider serviceProvider) } /// - /// Disposes all resources and unhooks all events. + /// Disposes all resources and unhooks all events. /// public void Dispose() { @@ -47,7 +47,7 @@ public void Dispose() } /// - /// This event is thrown whenever a request is made to show/hide the ui + /// This event is thrown whenever a request is made to show/hide the ui /// public event DesignerActionUIStateChangeEventHandler DesignerActionUIStateChange { @@ -66,7 +66,7 @@ public void ShowUI(IComponent component) } /// - /// This is a new Helper Method that the service provides to refresh the DesignerActionGlyph as well as DesignerActionPanels. + /// This is a new Helper Method that the service provides to refresh the DesignerActionGlyph as well as DesignerActionPanels. /// public void Refresh(IComponent component) { @@ -74,7 +74,7 @@ public void Refresh(IComponent component) } /// - /// This fires our DesignerActionsChanged event. + /// This fires our DesignerActionsChanged event. /// private void OnDesignerActionUIStateChange(DesignerActionUIStateChangeEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerFrame.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerFrame.cs index c2fe6cd9d41..74d6636bfda 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerFrame.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerFrame.cs @@ -15,14 +15,14 @@ namespace System.Windows.Forms.Design { /// - /// This class implements our design time document. This is the outer window that encompases a designer. It maintains a control hierarchy that looks like this: - /// DesignerFrame + /// This class implements our design time document. This is the outer window that encompases a designer. It maintains a control hierarchy that looks like this: + /// DesignerFrame /// ScrollableControl /// Designer /// Splitter /// ScrollableControl /// Component Tray - /// The splitter and second scrollable control are created on demand when a tray is added. + /// The splitter and second scrollable control are created on demand when a tray is added. /// internal class DesignerFrame : Control, IOverlayService, ISplitWindowService, IContainsThemedScrollbarWindows { @@ -34,7 +34,7 @@ internal class DesignerFrame : Control, IOverlayService, ISplitWindowService, IC private readonly IUIService _uiService; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DesignerFrame(ISite site) { @@ -56,7 +56,7 @@ public DesignerFrame(ISite site) } /// - /// Returns the scroll offset for the scrollable control that manages all overlays. This is needed by the BehaviorService so we can correctly invalidate our AdornerWindow based on scrollposition. + /// Returns the scroll offset for the scrollable control that manages all overlays. This is needed by the BehaviorService so we can correctly invalidate our AdornerWindow based on scrollposition. /// internal Point AutoScrollPosition { @@ -64,7 +64,7 @@ internal Point AutoScrollPosition } /// - /// Demand creates a ptr to the BehaviorService - we do this so we can route keyboard message to it. + /// Demand creates a ptr to the BehaviorService - we do this so we can route keyboard message to it. /// private BehaviorService BehaviorService { @@ -107,7 +107,7 @@ private void ForceDesignerRedraw(bool focus) } /// - /// Initializes this frame with the given designer view. + /// Initializes this frame with the given designer view. /// public void Initialize(Control view) { @@ -123,7 +123,7 @@ public void Initialize(Control view) } /// - /// When we get an lose focus, we need to make sure the form designer knows about it so it'll paint it's caption right. + /// When we get an lose focus, we need to make sure the form designer knows about it so it'll paint it's caption right. /// protected override void OnGotFocus(EventArgs e) { @@ -139,7 +139,7 @@ protected override void OnGotFocus(EventArgs e) } /// - /// When we get an lose focus, we need to make sure the form designer knows about it so it'll paint it's caption right. + /// When we get an lose focus, we need to make sure the form designer knows about it so it'll paint it's caption right. /// protected override void OnLostFocus(EventArgs e) { @@ -171,7 +171,7 @@ void OnUserPreferenceChanged(object sender, UserPreferenceChangedEventArgs e) } /// - /// We override this to do nothing. Otherwise, all the nice keyboard messages we want would get run through the Form's keyboard handling procedure. + /// We override this to do nothing. Otherwise, all the nice keyboard messages we want would get run through the Form's keyboard handling procedure. /// protected override bool ProcessDialogKey(Keys keyData) { @@ -190,7 +190,7 @@ void SyncDesignerUI() } /// - /// Base wndProc. All messages are sent to wndProc after getting filtered through the preProcessMessage function. Inheriting controls should call base.wndProc for any messages that they don't handle. + /// Base wndProc. All messages are sent to wndProc after getting filtered through the preProcessMessage function. Inheriting controls should call base.wndProc for any messages that they don't handle. /// protected override void WndProc(ref Message m) { @@ -262,12 +262,12 @@ protected override void WndProc(ref Message m) } /// - /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. + /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. /// int IOverlayService.PushOverlay(Control control) => _designerRegion.PushOverlay(control); /// - /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. + /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. /// void IOverlayService.RemoveOverlay(Control control) { @@ -275,7 +275,7 @@ void IOverlayService.RemoveOverlay(Control control) } /// - /// Inserts the overlay. + /// Inserts the overlay. /// void IOverlayService.InsertOverlay(Control control, int index) { @@ -283,7 +283,7 @@ void IOverlayService.InsertOverlay(Control control, int index) } /// - /// Invalidate child overlays + /// Invalidate child overlays /// void IOverlayService.InvalidateOverlays(Rectangle screenRectangle) { @@ -291,7 +291,7 @@ void IOverlayService.InvalidateOverlays(Rectangle screenRectangle) } /// - /// Invalidate child overlays + /// Invalidate child overlays /// void IOverlayService.InvalidateOverlays(Region screenRegion) { @@ -299,7 +299,7 @@ void IOverlayService.InvalidateOverlays(Region screenRegion) } /// - /// Requests the service to add a window 'pane'. + /// Requests the service to add a window 'pane'. /// void ISplitWindowService.AddSplitWindow(Control window) { @@ -333,7 +333,7 @@ void ISplitWindowService.AddSplitWindow(Control window) } /// - /// Requests the service to remove a window 'pane'. + /// Requests the service to remove a window 'pane'. /// void ISplitWindowService.RemoveSplitWindow(Control window) { @@ -344,7 +344,7 @@ void ISplitWindowService.RemoveSplitWindow(Control window) } /// - /// Returns IEnumerable of all windows which need to be themed when running inside VS We don't know how to do theming here but we know which windows need to be themed. The two ScrollableControls that hold the designer and the tray need to be themed, all of the children of the designed form should not be themed. The tray contains only conrols which are not visible in the user app but are visible inside VS. As a result, we want to theme all windows within the tray but only the top window for the designer pane. + /// Returns IEnumerable of all windows which need to be themed when running inside VS We don't know how to do theming here but we know which windows need to be themed. The two ScrollableControls that hold the designer and the tray need to be themed, all of the children of the designed form should not be themed. The tray contains only conrols which are not visible in the user app but are visible inside VS. As a result, we want to theme all windows within the tray but only the top window for the designer pane. /// IEnumerable IContainsThemedScrollbarWindows.ThemedScrollbarWindows() { @@ -366,7 +366,7 @@ IEnumerable IContainsThemedScrollbarWindows.ThemedScrollbarWindows() } /// - /// This is a scrollable control that supports additional floating overlay controls. + /// This is a scrollable control that supports additional floating overlay controls. /// private class OverlayControl : ScrollableControl { @@ -376,7 +376,7 @@ private class OverlayControl : ScrollableControl private BehaviorService _behaviorService; /// - /// Creates a new overlay control. + /// Creates a new overlay control. /// public OverlayControl(IServiceProvider provider) { @@ -392,7 +392,7 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Demand creates a ptr to the BehaviorService + /// Demand creates a ptr to the BehaviorService /// private BehaviorService BehaviorService { @@ -407,7 +407,7 @@ private BehaviorService BehaviorService } /// - /// At handle creation time we request the designer's handle and parent it. + /// At handle creation time we request the designer's handle and parent it. /// protected override void OnCreateControl() { @@ -429,7 +429,7 @@ protected override void OnCreateControl() } /// - /// We override onLayout to provide our own custom layout functionality. This just overlaps all of the controls. + /// We override onLayout to provide our own custom layout functionality. This just overlaps all of the controls. /// protected override void OnLayout(LayoutEventArgs e) { @@ -447,7 +447,7 @@ protected override void OnLayout(LayoutEventArgs e) } /// - /// Called to parent an overlay window into our document. This assumes that we call in reverse stack order, as it always pushes to the top of the z-order. + /// Called to parent an overlay window into our document. This assumes that we call in reverse stack order, as it always pushes to the top of the z-order. /// private void ParentOverlay(Control control) { @@ -456,7 +456,7 @@ private void ParentOverlay(Control control) } /// - /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. + /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. /// public int PushOverlay(Control control) { @@ -472,7 +472,7 @@ public int PushOverlay(Control control) } /// - /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. + /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. /// public void RemoveOverlay(Control control) { @@ -483,7 +483,7 @@ public void RemoveOverlay(Control control) } /// - /// Inserts Overlay. + /// Inserts Overlay. /// public void InsertOverlay(Control control, int index) { @@ -496,7 +496,7 @@ public void InsertOverlay(Control control, int index) } /// - /// Invalidates overlays that intersect with the given section of the screen; + /// Invalidates overlays that intersect with the given section of the screen; /// public void InvalidateOverlays(Rectangle screenRectangle) { @@ -515,7 +515,7 @@ public void InvalidateOverlays(Rectangle screenRectangle) } /// - /// Invalidates overlays that intersect with the given section of the screen; + /// Invalidates overlays that intersect with the given section of the screen; /// public void InvalidateOverlays(Region screenRegion) { @@ -538,7 +538,7 @@ public void InvalidateOverlays(Region screenRegion) } } /// - /// Need to know when child windows are created so we can properly set the Z-order + /// Need to know when child windows are created so we can properly set the Z-order /// protected override void WndProc(ref Message m) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerOptions.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerOptions.cs index 30e06031529..990a95c5588 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerOptions.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerOptions.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides access to get and set option values for a designer. + /// Provides access to get and set option values for a designer. /// [ComVisible(true)] public class DesignerOptions @@ -19,7 +19,7 @@ public class DesignerOptions private Size _gridSize = new Size(8, 8); /// - /// Public GridSize property. + /// Public GridSize property. /// [SRCategory(nameof(SR.DesignerOptions_LayoutSettings))] [SRDisplayName(nameof(SR.DesignerOptions_GridSizeDisplayName))] @@ -52,7 +52,7 @@ public virtual Size GridSize } /// - /// Public ShowGrid property. + /// Public ShowGrid property. /// [SRCategory(nameof(SR.DesignerOptions_LayoutSettings))] [SRDisplayName(nameof(SR.DesignerOptions_ShowGridDisplayName))] @@ -60,7 +60,7 @@ public virtual Size GridSize public virtual bool ShowGrid { get; set; } = true; /// - /// Public SnapToGrid property. + /// Public SnapToGrid property. /// [SRCategory(nameof(SR.DesignerOptions_LayoutSettings))] [SRDisplayName(nameof(SR.DesignerOptions_SnapToGridDisplayName))] @@ -68,21 +68,21 @@ public virtual Size GridSize public virtual bool SnapToGrid { get; set; } = true; /// - /// This property enables or disables snaplines in the designer. + /// This property enables or disables snaplines in the designer. /// [SRCategory(nameof(SR.DesignerOptions_LayoutSettings))] [SRDescription(nameof(SR.DesignerOptions_UseSnapLines))] public virtual bool UseSnapLines { get; set; } /// - /// This property enables or disables smart tags in the designer. + /// This property enables or disables smart tags in the designer. /// [SRCategory(nameof(SR.DesignerOptions_LayoutSettings))] [SRDescription(nameof(SR.DesignerOptions_UseSmartTags))] public virtual bool UseSmartTags { get; set; } /// - /// This property enables or disables smart tags in the designer. + /// This property enables or disables smart tags in the designer. /// [SRDisplayName(nameof(SR.DesignerOptions_ObjectBoundSmartTagAutoShowDisplayName))] [SRCategory(nameof(SR.DesignerOptions_ObjectBoundSmartTagSettings))] @@ -90,7 +90,7 @@ public virtual Size GridSize public virtual bool ObjectBoundSmartTagAutoShow { get; set; } = true; /// - /// This property enables or disables the component cache + /// This property enables or disables the component cache /// [SRDisplayName(nameof(SR.DesignerOptions_CodeGenDisplay))] [SRCategory(nameof(SR.DesignerOptions_CodeGenSettings))] @@ -98,7 +98,7 @@ public virtual Size GridSize public virtual bool UseOptimizedCodeGeneration { get; set; } /// - /// This property enables or disables the InSitu Editing for ToolStrips + /// This property enables or disables the InSitu Editing for ToolStrips /// [SRDisplayName(nameof(SR.DesignerOptions_EnableInSituEditingDisplay))] [SRCategory(nameof(SR.DesignerOptions_EnableInSituEditingCat))] diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerToolStripControlHost.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerToolStripControlHost.cs index 04cbbd04afc..acc502098ce 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerToolStripControlHost.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerToolStripControlHost.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// This internal class is used by the new ToolStripDesigner to add a dummy node to the end. This class inherits from ToolStripControlHost and overrides the CanSelect property so that the dummy Node when shown in the designer doesnt show selection on Mouse movements. The image is set to theDummyNodeImage embedded into the resources. + /// This internal class is used by the new ToolStripDesigner to add a dummy node to the end. This class inherits from ToolStripControlHost and overrides the CanSelect property so that the dummy Node when shown in the designer doesnt show selection on Mouse movements. The image is set to theDummyNodeImage embedded into the resources. /// internal class DesignerToolStripControlHost : ToolStripControlHost, IComponent { @@ -26,7 +26,7 @@ public DesignerToolStripControlHost(Control c) : base(c) } /// - /// We need to return Default size for Editor ToolStrip (92, 22). + /// We need to return Default size for Editor ToolStrip (92, 22). /// protected override Size DefaultSize { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerUtils.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerUtils.cs index b9ba609d2ca..a273eb83594 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerUtils.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerUtils.cs @@ -17,7 +17,7 @@ namespace System.Windows.Forms.Design { /// - /// Contains designer utilities. + /// Contains designer utilities. /// internal static class DesignerUtils { @@ -105,7 +105,7 @@ internal static class DesignerUtils public static readonly ContentAlignment anyMiddleAlignment = ContentAlignment.MiddleLeft | ContentAlignment.MiddleCenter | ContentAlignment.MiddleRight; /// - /// Scale all hardcoded sizes if needed + /// Scale all hardcoded sizes if needed /// static DesignerUtils() { @@ -138,7 +138,7 @@ static DesignerUtils() } /// - /// Used when the user clicks and drags a toolbox item onto the documentdesigner - this is the small box that is painted beneath the mouse pointer. + /// Used when the user clicks and drags a toolbox item onto the documentdesigner - this is the small box that is painted beneath the mouse pointer. /// public static Image BoxImage { @@ -158,7 +158,7 @@ public static Image BoxImage } /// - /// Used by Designer action glyphs to render a 'mouse hover' state. + /// Used by Designer action glyphs to render a 'mouse hover' state. /// public static Brush HoverBrush { @@ -166,7 +166,7 @@ public static Brush HoverBrush } /// - /// Demand created size used to determine how far the user needs to drag the mouse before a drag operation starts. + /// Demand created size used to determine how far the user needs to drag the mouse before a drag operation starts. /// public static Size MinDragSize { @@ -215,7 +215,7 @@ public static void SyncBrushes() } /// - /// Draws a ControlDarkDark border around the given image. + /// Draws a ControlDarkDark border around the given image. /// private static void DrawDragBorder(Graphics g, Size imageSize, int borderSize, Color backColor) { @@ -239,7 +239,7 @@ private static void DrawDragBorder(Graphics g, Size imageSize, int borderSize, C } /// - /// Used for drawing the borders around controls that are being resized + /// Used for drawing the borders around controls that are being resized /// public static void DrawResizeBorder(Graphics g, Region resizeBorder, Color backColor) { @@ -253,7 +253,7 @@ public static void DrawResizeBorder(Graphics g, Region resizeBorder, Color backC } /// - /// Used for drawing the frame when doing a mouse drag + /// Used for drawing the frame when doing a mouse drag /// public static void DrawFrame(Graphics g, Region resizeBorder, FrameStyle style, Color backColor) { @@ -278,7 +278,7 @@ public static void DrawFrame(Graphics g, Region resizeBorder, FrameStyle style, } /// - /// Used for drawing the grabhandles around sizeable selected controls and components. + /// Used for drawing the grabhandles around sizeable selected controls and components. /// public static void DrawGrabHandle(Graphics graphics, Rectangle bounds, bool isPrimary, Glyph glyph) { @@ -303,7 +303,7 @@ public static void DrawGrabHandle(Graphics graphics, Rectangle bounds, bool isPr } /// - /// Used for drawing the no-resize handle for non-resizeable selected controls and components. + /// Used for drawing the no-resize handle for non-resizeable selected controls and components. /// public static void DrawNoResizeHandle(Graphics graphics, Rectangle bounds, bool isPrimary, Glyph glyph) { @@ -327,7 +327,7 @@ public static void DrawNoResizeHandle(Graphics graphics, Rectangle bounds, bool } /// - /// Used for drawing the lock handle for locked selected controls and components. + /// Used for drawing the lock handle for locked selected controls and components. /// public static void DrawLockedHandle(Graphics graphics, Rectangle bounds, bool isPrimary, Glyph glyph) { @@ -354,7 +354,7 @@ public static void DrawLockedHandle(Graphics graphics, Rectangle bounds, bool is } /// - /// Uses the lockedBorderBrush to draw a 'locked' border on the given Graphics at the specified bounds. + /// Uses the lockedBorderBrush to draw a 'locked' border on the given Graphics at the specified bounds. /// public static void DrawSelectionBorder(Graphics graphics, Rectangle bounds) { @@ -362,7 +362,7 @@ public static void DrawSelectionBorder(Graphics graphics, Rectangle bounds) } /// - /// Used to generate an image that represents the given control. First, this method will call the 'GenerateSnapShotWithWM_PRINT' method on the control. If we believe that this method did not return us a valid image (caused by some comctl/ax controls not properly responding to a wm_print) then we will attempt to do a bitblt of the control instead. + /// Used to generate an image that represents the given control. First, this method will call the 'GenerateSnapShotWithWM_PRINT' method on the control. If we believe that this method did not return us a valid image (caused by some comctl/ax controls not properly responding to a wm_print) then we will attempt to do a bitblt of the control instead. /// public static void GenerateSnapShot(Control control, ref Image image, int borderSize, double opacity, Color backColor) { @@ -391,7 +391,7 @@ public static void GenerateSnapShot(Control control, ref Image image, int border } /// - /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. + /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. /// public static Size GetAdornmentDimensions(AdornmentType adornmentType) { @@ -451,7 +451,7 @@ public static object GetOptionValue(IServiceProvider provider, string name) } /// - /// Uses BitBlt to geta snapshot of the control + /// Uses BitBlt to geta snapshot of the control /// public static void GenerateSnapShotWithBitBlt(Control control, ref Image image) { @@ -475,7 +475,7 @@ public static void GenerateSnapShotWithBitBlt(Control control, ref Image image) } /// - /// Uses WM_PRINT to get a snapshot of the control. This method will return true if the control properly responded to the wm_print message. + /// Uses WM_PRINT to get a snapshot of the control. This method will return true if the control properly responded to the wm_print message. /// public static bool GenerateSnapShotWithWM_PRINT(Control control, ref Image image) { @@ -512,7 +512,7 @@ public static bool GenerateSnapShotWithWM_PRINT(Control control, ref Image image } /// - /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. + /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. /// public static Rectangle GetBoundsForSelectionType(Rectangle originalBounds, SelectionBorderGlyphType type, int borderSize) { @@ -539,8 +539,8 @@ public static Rectangle GetBoundsForSelectionType(Rectangle originalBounds, Sele } /// - /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. - /// Offset - how many pixels between the border glyph and the control + /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. + /// Offset - how many pixels between the border glyph and the control /// private static Rectangle GetBoundsForSelectionType(Rectangle originalBounds, SelectionBorderGlyphType type, int bordersize, int offset) { @@ -574,7 +574,7 @@ private static Rectangle GetBoundsForSelectionType(Rectangle originalBounds, Sel } /// - /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. + /// Used by the Glyphs and ComponentTray to determine the Top, Left, Right, Bottom and Body bound rects related to their original bounds and bordersize. /// public static Rectangle GetBoundsForSelectionType(Rectangle originalBounds, SelectionBorderGlyphType type) { @@ -587,7 +587,7 @@ public static Rectangle GetBoundsForNoResizeSelectionType(Rectangle originalBoun } /// - /// Identifes where the text baseline for our control which should be based on bounds, padding, font, and textalignment. + /// Identifes where the text baseline for our control which should be based on bounds, padding, font, and textalignment. /// public static int GetTextBaseline(Control ctrl, ContentAlignment alignment) { @@ -635,14 +635,14 @@ public static int GetTextBaseline(Control ctrl, ContentAlignment alignment) } /// - /// Called by the ParentControlDesigner when creating a new - /// control - this will update the new control's bounds with the - /// proper toolbox/snapline information that has been stored - /// off + /// Called by the ParentControlDesigner when creating a new + /// control - this will update the new control's bounds with the + /// proper toolbox/snapline information that has been stored + /// off // - /// isMirrored - Is the ParentControlDesigner mirrored? If so, we need - /// to offset for that. This is because all snapline stuff is done - /// using a LTR coordinate system + /// isMirrored - Is the ParentControlDesigner mirrored? If so, we need + /// to offset for that. This is because all snapline stuff is done + /// using a LTR coordinate system /// public static Rectangle GetBoundsFromToolboxSnapDragDropInfo(ToolboxSnapDragDropEventArgs e, Rectangle originalBounds, bool isMirrored) { @@ -694,7 +694,7 @@ public static Rectangle GetBoundsFromToolboxSnapDragDropInfo(ToolboxSnapDragDrop } /// - /// Determine a unique site name for a component, starting from a base name. Return value should be passed into the Container.Add() method. If null is returned, this just means "let container generate a default name based on component type". + /// Determine a unique site name for a component, starting from a base name. Return value should be passed into the Container.Add() method. If null is returned, this just means "let container generate a default name based on component type". /// public static string GetUniqueSiteName(IDesignerHost host, string name) { @@ -731,7 +731,7 @@ public static string GetUniqueSiteName(IDesignerHost host, string name) } /// - /// Applies the given opacity to the image + /// Applies the given opacity to the image /// private static unsafe void SetImageAlpha(Bitmap b, double opacity) { @@ -775,7 +775,7 @@ private static unsafe void SetImageAlpha(Bitmap b, double opacity) } /// - /// This method removes types that are generics from the input collection + /// This method removes types that are generics from the input collection /// public static ICollection FilterGenericTypes(ICollection types) { @@ -797,7 +797,7 @@ public static ICollection FilterGenericTypes(ICollection types) } /// - /// Checks the given container, substituting any nested container with its owning container. Ensures that a SplitterPanel in a SplitContainer returns the same container as other form components, since SplitContainer sites its two SplitterPanels inside a nested container. + /// Checks the given container, substituting any nested container with its owning container. Ensures that a SplitterPanel in a SplitContainer returns the same container as other form components, since SplitContainer sites its two SplitterPanels inside a nested container. /// public static IContainer CheckForNestedContainer(IContainer container) { @@ -812,7 +812,7 @@ public static IContainer CheckForNestedContainer(IContainer container) } /// - /// Used to create copies of the objects that we are dragging in a drag operation + /// Used to create copies of the objects that we are dragging in a drag operation /// public static ICollection CopyDragObjects(ICollection objects, IServiceProvider svcProvider) { @@ -923,7 +923,7 @@ private static void TreeView_SetExtendedStyle(IntPtr handle, int extendedStyle, } /// - /// Modify a WinForms TreeView control to use the new Explorer style theme + /// Modify a WinForms TreeView control to use the new Explorer style theme /// /// The tree view control to modify public static void ApplyTreeViewThemeStyles(TreeView treeView) @@ -947,7 +947,7 @@ private static void ListView_SetExtendedListViewStyleEx(IntPtr handle, int mask, } /// - /// Modify a WinForms ListView control to use the new Explorer style theme + /// Modify a WinForms ListView control to use the new Explorer style theme /// /// The list view control to modify public static void ApplyListViewThemeStyles(ListView listView) diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerVerbToolStripMenuItem.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerVerbToolStripMenuItem.cs index c887563bc4c..f0b2fbc1ed2 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerVerbToolStripMenuItem.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/DesignerVerbToolStripMenuItem.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// Associates DesignerVerb with ToolStripMenuItem. + /// Associates DesignerVerb with ToolStripMenuItem. /// internal class DesignerVerbToolStripMenuItem : ToolStripMenuItem { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EditorServiceContext.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EditorServiceContext.cs index 214960c964f..5d18340f6c3 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EditorServiceContext.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EditorServiceContext.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides an implementation of IWindowsFormsEditorService and ITypeDescriptorContext. Also provides a static method to invoke a UITypeEditor given a designer, an object and a property name. + /// Provides an implementation of IWindowsFormsEditorService and ITypeDescriptorContext. Also provides a static method to invoke a UITypeEditor given a designer, an object and a property name. /// internal class EditorServiceContext : IWindowsFormsEditorService, ITypeDescriptorContext { @@ -74,7 +74,7 @@ public static object EditValue(ComponentDesigner designer, object objectToChange } /// - /// Our caching property for the IComponentChangeService + /// Our caching property for the IComponentChangeService /// private IComponentChangeService ChangeService { @@ -89,7 +89,7 @@ private IComponentChangeService ChangeService } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// IContainer ITypeDescriptorContext.Container { @@ -104,7 +104,7 @@ IContainer ITypeDescriptorContext.Container } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// void ITypeDescriptorContext.OnComponentChanged() { @@ -112,7 +112,7 @@ void ITypeDescriptorContext.OnComponentChanged() } /// - /// Self-explanitory interface impl. + /// Self-explanitory interface impl. /// bool ITypeDescriptorContext.OnComponentChanging() { @@ -181,7 +181,7 @@ System.Windows.Forms.DialogResult IWindowsFormsEditorService.ShowDialog(Form dia } /// - /// When the verb is invoked, use all the stuff above to show the dialog, etc. + /// When the verb is invoked, use all the stuff above to show the dialog, etc. /// private void OnEditItems(object sender, EventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EventHandlerService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EventHandlerService.cs index 09666c7eabb..e3f258d25fc 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EventHandlerService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/EventHandlerService.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a systematic way to manage event handlers for the current document. + /// Provides a systematic way to manage event handlers for the current document. /// public sealed class EventHandlerService : IEventHandlerService { @@ -20,7 +20,7 @@ public sealed class EventHandlerService : IEventHandlerService private HandlerEntry _handlerHead; /// - /// Initializes a new instance of the EventHandlerService class. + /// Initializes a new instance of the EventHandlerService class. /// /// The which is being designed. public EventHandlerService(Control focusWnd) @@ -29,7 +29,7 @@ public EventHandlerService(Control focusWnd) } /// - /// Fires an OnEventHandlerChanged event. + /// Fires an OnEventHandlerChanged event. /// public event EventHandler EventHandlerChanged { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/FormDocumentDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/FormDocumentDesigner.cs index a01fd9d08ac..34fa0f7745d 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/FormDocumentDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/FormDocumentDesigner.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms.Design { /// - /// The FormDocumentDesigner class builds on the DocumentDesigner. It adds shadowing for form properties that need to be shadowed and it also adds logic to properly paint the form's title bar to match the active document window. + /// The FormDocumentDesigner class builds on the DocumentDesigner. It adds shadowing for form properties that need to be shadowed and it also adds logic to properly paint the form's title bar to match the active document window. /// internal class FormDocumentDesigner : DocumentDesigner { @@ -28,7 +28,7 @@ internal class FormDocumentDesigner : DocumentDesigner private ToolStripAdornerWindowService _toolStripAdornerWindowService = null; /// - /// Shadow the AcceptButton property at design-time so that we can preserve it when the form is rebuilt. Otherwise, form.Controls.Clear() will clear it out when we don't want it to. + /// Shadow the AcceptButton property at design-time so that we can preserve it when the form is rebuilt. Otherwise, form.Controls.Clear() will clear it out when we don't want it to. /// private IButtonControl AcceptButton { @@ -41,7 +41,7 @@ private IButtonControl AcceptButton } /// - /// Shadow the CancelButton property at design-time so that we can preserve it when the form is rebuilt. Otherwise, form.Controls.Clear() will clear it out when we don't want it to. + /// Shadow the CancelButton property at design-time so that we can preserve it when the form is rebuilt. Otherwise, form.Controls.Clear() will clear it out when we don't want it to. /// private IButtonControl CancelButton { @@ -54,7 +54,7 @@ private IButtonControl CancelButton } /// - /// Shadowed version of the AutoScaleBaseSize property. We shadow this so that it always persists. Normally only properties that differ from the default values at instantiation are persisted, but this should always be written. So, we shadow it and add our own ShouldSerialize method. + /// Shadowed version of the AutoScaleBaseSize property. We shadow this so that it always persists. Normally only properties that differ from the default values at instantiation are persisted, but this should always be written. So, we shadow it and add our own ShouldSerialize method. /// private Size AutoScaleBaseSize { @@ -75,7 +75,7 @@ private Size AutoScaleBaseSize } /// - /// We shadow the AutoSize property at design-time so that the form doesn't grow and shrink as users fiddle with autosize related properties. + /// We shadow the AutoSize property at design-time so that the form doesn't grow and shrink as users fiddle with autosize related properties. /// private bool AutoSize { @@ -93,7 +93,7 @@ private bool ShouldSerializeAutoScaleBaseSize() } /// - /// Shadow property for the ClientSize property -- this allows us to intercept client size changes and apply the new menu height if necessary + /// Shadow property for the ClientSize property -- this allows us to intercept client size changes and apply the new menu height if necessary /// private Size ClientSize { @@ -137,7 +137,7 @@ private Size ClientSize } /// - /// Shadow property for the IsMDIContainer property on a form. + /// Shadow property for the IsMDIContainer property on a form. /// private bool IsMdiContainer { @@ -157,7 +157,7 @@ private bool IsMdiContainer } /// - /// Returns true if the active menu is an inherited component. We use this to determine if we need to resize the base control or not. + /// Returns true if the active menu is an inherited component. We use this to determine if we need to resize the base control or not. /// private bool IsMenuInherited { @@ -180,7 +180,7 @@ private bool IsMenuInherited } /// - /// Accessor method for the menu property on control. We shadow this property at design time. + /// Accessor method for the menu property on control. We shadow this property at design time. /// internal MainMenu Menu { @@ -210,7 +210,7 @@ internal MainMenu Menu } /// - /// Opacity property on control. We shadow this property at design time. + /// Opacity property on control. We shadow this property at design time. /// private double Opacity { @@ -227,7 +227,7 @@ private double Opacity } /// - /// Overrides the default implementation of ParentControlDesigner SnapLines. Note that if the Padding property is not set on our Form - we'll special case this and add default Padding values to our SnapLines. This was a usability request specific to the Form itself. Note that a Form only has Padding SnapLines. + /// Overrides the default implementation of ParentControlDesigner SnapLines. Note that if the Padding property is not set on our Form - we'll special case this and add default Padding values to our SnapLines. This was a usability request specific to the Form itself. Note that a Form only has Padding SnapLines. /// public override IList SnapLines { @@ -294,7 +294,7 @@ private Size Size } /// - /// Accessor method for the showInTaskbar property on control. We shadow this property at design time. + /// Accessor method for the showInTaskbar property on control. We shadow this property at design time. /// private bool ShowInTaskbar { @@ -303,7 +303,7 @@ private bool ShowInTaskbar } /// - /// Accessor method for the windowState property on control. We shadow this property at design time. + /// Accessor method for the windowState property on control. We shadow this property at design time. /// private FormWindowState WindowState { @@ -343,7 +343,7 @@ private void ApplyAutoScaling(SizeF baseVar, Form form) } /// - /// Disposes of this designer. + /// Disposes of this designer. /// protected override void Dispose(bool disposing) { @@ -408,7 +408,7 @@ internal override void DoProperMenuSelection(ICollection selComponents) } /// - /// Determines if a MenuEditorService has already been started. If not, this method will create a new instance of the service. We override this because we want to allow any kind of menu to start the service, not just ContextMenus. + /// Determines if a MenuEditorService has already been started. If not, this method will create a new instance of the service. We override this because we want to allow any kind of menu to start the service, not just ContextMenus. /// protected override void EnsureMenuEditorService(IComponent c) { @@ -427,7 +427,7 @@ private void EnsureToolStripWindowAdornerService() } /// - /// Gets the current menu height so we know how much to increment the form size by + /// Gets the current menu height so we know how much to increment the form size by /// private int GetMenuHeight() { @@ -450,7 +450,7 @@ private int GetMenuHeight() } /// - /// Initializes the designer with the given component. The designer can get the component's site and request services from it in this call. + /// Initializes the designer with the given component. The designer can get the component's site and request services from it in this call. /// public override void Initialize(IComponent component) { @@ -474,7 +474,7 @@ public override void Initialize(IComponent component) } /// - /// Called when a component is added to the design container. If the component isn't a control, this will demand create the component tray and add the component to it. + /// Called when a component is added to the design container. If the component isn't a control, this will demand create the component tray and add the component to it. /// private void OnComponentAdded(object source, ComponentEventArgs ce) { @@ -504,7 +504,7 @@ private void OnComponentAdded(object source, ComponentEventArgs ce) } /// - /// Called when a component is removed from the design container. Here, we check if a menu is being removed and handle removing the Form's mainmenu vs. other menus properly. + /// Called when a component is removed from the design container. Here, we check if a menu is being removed and handle removing the Form's mainmenu vs. other menus properly. /// private void OnComponentRemoved(object source, ComponentEventArgs ce) { @@ -541,7 +541,7 @@ private void OnComponentRemoved(object source, ComponentEventArgs ce) } /// - /// We're watching the handle creation in case we have a menu editor. If we do, the menu editor will have to be torn down and recreated. + /// We're watching the handle creation in case we have a menu editor. If we do, the menu editor will have to be torn down and recreated. /// protected override void OnCreateHandle() { @@ -571,7 +571,7 @@ private void OnDesignerActivate(object source, EventArgs evevent) } /// - /// Called by the host when we become inactive. Here we update the title bar of our form so it's the inactive color. + /// Called by the host when we become inactive. Here we update the title bar of our form so it's the inactive color. /// private void OnDesignerDeactivate(object sender, EventArgs e) { @@ -584,7 +584,7 @@ private void OnDesignerDeactivate(object sender, EventArgs e) } /// - /// Called when our code loads. Here we connect us as the selection UI handler for ourselves. This is a special case because for the top level document, we are our own selection UI handler. + /// Called when our code loads. Here we connect us as the selection UI handler for ourselves. This is a special case because for the top level document, we are our own selection UI handler. /// private void OnLoadComplete(object source, EventArgs evevent) { @@ -634,7 +634,7 @@ private void OnLoadComplete(object source, EventArgs evevent) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -668,7 +668,7 @@ protected override void PreFilterProperties(IDictionary properties) } /// - /// Handles the WM_WINDOWPOSCHANGING message + /// Handles the WM_WINDOWPOSCHANGING message /// private unsafe void WmWindowPosChanging(ref Message m) { @@ -692,7 +692,7 @@ private unsafe void WmWindowPosChanging(ref Message m) } /// - /// Overrides our base class WndProc to provide support for the menu editor service. + /// Overrides our base class WndProc to provide support for the menu editor service. /// protected override void WndProc(ref Message m) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IContainsThemedScrollbarWindows.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IContainsThemedScrollbarWindows.cs index 584804cc75c..d314300dd1a 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IContainsThemedScrollbarWindows.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IContainsThemedScrollbarWindows.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// Returns an enumeration of windows and flags of how their scrollbars need to be themed when the designer is running inside Visual Studio. + /// Returns an enumeration of windows and flags of how their scrollbars need to be themed when the designer is running inside Visual Studio. /// public interface IContainsThemedScrollbarWindows { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMenuStatusHandler.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMenuStatusHandler.cs index b472ec881a1..2d07ce1e964 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMenuStatusHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMenuStatusHandler.cs @@ -7,17 +7,17 @@ namespace System.Windows.Forms.Design { /// - /// We plug this interface into the designer event service for overriding menu commands. + /// We plug this interface into the designer event service for overriding menu commands. /// internal interface IMenuStatusHandler { /// - /// CommandSet will check with this handler on each status update to see if the handler wants to override the availability of this command. + /// CommandSet will check with this handler on each status update to see if the handler wants to override the availability of this command. /// bool OverrideInvoke(MenuCommand cmd); /// - /// CommandSet will check with this handler on each status update to see if the handler wants to override the availability of this command. + /// CommandSet will check with this handler on each status update to see if the handler wants to override the availability of this command. /// bool OverrideStatus(MenuCommand cmd); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMouseHandler.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMouseHandler.cs index 720af4fb184..e4030134159 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMouseHandler.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IMouseHandler.cs @@ -9,31 +9,31 @@ namespace System.Windows.Forms.Design internal interface IMouseHandler { /// - /// This is called when the user double clicks on a component. The typical behavior is to create an event handler for the component's default event and navigate to the handler. + /// This is called when the user double clicks on a component. The typical behavior is to create an event handler for the component's default event and navigate to the handler. /// void OnMouseDoubleClick(IComponent component); /// - /// This is called when a mouse button is depressed. This will perform the default drag action for the selected components, which is to move those components around by the mouse. + /// This is called when a mouse button is depressed. This will perform the default drag action for the selected components, which is to move those components around by the mouse. /// void OnMouseDown(IComponent component, MouseButtons button, int x, int y); /// - /// This is called when the mouse momentarially hovers over the view for the given component. + /// This is called when the mouse momentarially hovers over the view for the given component. /// void OnMouseHover(IComponent component); /// - /// This is called for each movement of the mouse. + /// This is called for each movement of the mouse. /// void OnMouseMove(IComponent component, int x, int y); /// - /// This is called when the user releases the mouse from a component. This will update the UI to reflect the release of the mouse. + /// This is called when the user releases the mouse from a component. This will update the UI to reflect the release of the mouse. /// void OnMouseUp(IComponent component, MouseButtons button); /// - /// This is called when the cursor for the given component should be updated. The mouse is always over the given component's view when this is called. + /// This is called when the cursor for the given component should be updated. The mouse is always over the given component's view when this is called. /// void OnSetCursor(IComponent component); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IOverlayService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IOverlayService.cs index 717faf860be..53a9dffe4fc 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IOverlayService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/IOverlayService.cs @@ -7,32 +7,32 @@ namespace System.Windows.Forms.Design { /// - /// IOverlayService is a service that supports adding simple overlay windows to a design surface. Overlay windows can be used to paint extra glyphs on top of existing controls. Once an overlay is added, it will be forced on top of the Z-order for the other controls and overlays. If you want the overlay to be transparent, then you must do this work yourself. A typical way to make an overlay control transparent is to use the method setRegion on the control class to define the non-transparent portion of the control. + /// IOverlayService is a service that supports adding simple overlay windows to a design surface. Overlay windows can be used to paint extra glyphs on top of existing controls. Once an overlay is added, it will be forced on top of the Z-order for the other controls and overlays. If you want the overlay to be transparent, then you must do this work yourself. A typical way to make an overlay control transparent is to use the method setRegion on the control class to define the non-transparent portion of the control. /// internal interface IOverlayService { /// - /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. + /// Pushes the given control on top of the overlay list. This is a "push" operation, meaning that it forces this control to the top of the existing overlay list. /// int PushOverlay(Control control); /// - /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. + /// Removes the given control from the overlay list. Unlike pushOverlay, this can remove a control from the middle of the overlay list. /// void RemoveOverlay(Control control); /// - /// Inserts the given control from the overlay list. You need to pass the index of the overlay. + /// Inserts the given control from the overlay list. You need to pass the index of the overlay. /// void InsertOverlay(Control control, int index); /// - /// Invalidates the overlays + /// Invalidates the overlays /// void InvalidateOverlays(Rectangle screenRectangle); /// - /// Invalidates the overlays + /// Invalidates the overlays /// void InvalidateOverlays(Region screenRegion); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISelectionUIService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISelectionUIService.cs index a07bb34a64c..ddd2239f183 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISelectionUIService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISelectionUIService.cs @@ -7,94 +7,94 @@ namespace System.Windows.Forms.Design { /// - /// The selection UI service is used to provide a standard user interface for selection across designers. Using this service is optional, but is recommended to provide a standard UI component selection. + /// The selection UI service is used to provide a standard user interface for selection across designers. Using this service is optional, but is recommended to provide a standard UI component selection. /// internal interface ISelectionUIService { /// - /// Determines if the selection UI is shown or not. + /// Determines if the selection UI is shown or not. /// bool Visible { get; set; } /// - /// Adds an event handler to the ContainerSelectorActive event. This event is fired whenever the user interacts with the container selector in a manor that would indicate that the selector should continued to be displayed. Since the container selector normally will vanish after a timeout, designers should listen to this event and reset the timeout when this event occurs. + /// Adds an event handler to the ContainerSelectorActive event. This event is fired whenever the user interacts with the container selector in a manor that would indicate that the selector should continued to be displayed. Since the container selector normally will vanish after a timeout, designers should listen to this event and reset the timeout when this event occurs. /// event ContainerSelectorActiveEventHandler ContainerSelectorActive; /// - /// Assigns a selection UI handler to a given component. The handler will be called when the UI service needs information about the component. A single selection UI handler can be assigned to multiple components. When multiple components are dragged, only a single handler may control the drag. Because of this, only components that are assigned the same handler as the primary selection are included in drag operations. A selection UI handler is automatically unassigned when the component is removed from the container or disposed. + /// Assigns a selection UI handler to a given component. The handler will be called when the UI service needs information about the component. A single selection UI handler can be assigned to multiple components. When multiple components are dragged, only a single handler may control the drag. Because of this, only components that are assigned the same handler as the primary selection are included in drag operations. A selection UI handler is automatically unassigned when the component is removed from the container or disposed. /// void AssignSelectionUIHandler(object component, ISelectionUIHandler handler); void ClearSelectionUIHandler(object component, ISelectionUIHandler handler); /// - /// This can be called by an outside party to begin a drag of the currently selected set of components. At least one designer must have added a UI handler or else this method will always return false. + /// This can be called by an outside party to begin a drag of the currently selected set of components. At least one designer must have added a UI handler or else this method will always return false. /// bool BeginDrag(SelectionRules rules, int initialX, int initialY); /// - /// This can be used to determine if the user is in the middle of a drag operation. + /// This can be used to determine if the user is in the middle of a drag operation. /// bool Dragging { get; } /// - /// Called by an outside party to update drag information. This can only be called after a successful call to beginDrag. + /// Called by an outside party to update drag information. This can only be called after a successful call to beginDrag. /// void DragMoved(Rectangle offset); /// - /// Called by an outside party to finish a drag operation. This can only be called after a successful call to beginDrag. + /// Called by an outside party to finish a drag operation. This can only be called after a successful call to beginDrag. /// void EndDrag(bool cancel); /// - /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. + /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. /// object[] FilterSelection(object[] components, SelectionRules selectionRules); /// - /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. + /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. /// Size GetAdornmentDimensions(AdornmentType adornmentType); /// - /// Tests to determine if the given screen coordinate is over an adornment for the specified component. This will only return true if the adornment, and selection UI, is visible. + /// Tests to determine if the given screen coordinate is over an adornment for the specified component. This will only return true if the adornment, and selection UI, is visible. /// bool GetAdornmentHitTest(object component, Point pt); /// - /// Gets a value indicating whether the specified component is the currently selected container. + /// Gets a value indicating whether the specified component is the currently selected container. /// bool GetContainerSelected(object component); /// - /// Retrieves a set of flags that define rules for the selection. Selection rules indicate if the given component can be moved or sized, for example. + /// Retrieves a set of flags that define rules for the selection. Selection rules indicate if the given component can be moved or sized, for example. /// SelectionRules GetSelectionRules(object component); /// - /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. + /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. /// SelectionStyles GetSelectionStyle(object component); /// - /// Changes the container selection status of the specified component. + /// Changes the container selection status of the specified component. /// void SetContainerSelected(object component, bool selected); /// - /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. + /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. /// void SetSelectionStyle(object component, SelectionStyles style); /// - /// This should be called when a component has been moved, sized or re-parented, but the change was not the result of a property change. All property changes are monitored by the selection UI service, so this is automatic most of the time. There are times, however, when a component may be moved without a property change notification occurring. Scrolling an auto scroll Win32 form is an example of this. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. + /// This should be called when a component has been moved, sized or re-parented, but the change was not the result of a property change. All property changes are monitored by the selection UI service, so this is automatic most of the time. There are times, however, when a component may be moved without a property change notification occurring. Scrolling an auto scroll Win32 form is an example of this. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. /// void SyncSelection(); /// - /// This should be called when a component's property changed, that the designer thinks should result in a selection UI change. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. + /// This should be called when a component's property changed, that the designer thinks should result in a selection UI change. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. /// void SyncComponent(object component); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISplitWindowService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISplitWindowService.cs index 5a072d29527..25c8b2d298d 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISplitWindowService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISplitWindowService.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms.Design { /// - /// Supports the hosting of several 'pane' windows separated by splitter bars. + /// Supports the hosting of several 'pane' windows separated by splitter bars. /// internal interface ISplitWindowService { /// - /// Requests the service to add a window 'pane'. + /// Requests the service to add a window 'pane'. /// void AddSplitWindow(Control window); /// - /// Requests the service to remove a window 'pane'. + /// Requests the service to remove a window 'pane'. /// void RemoveSplitWindow(Control window); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISupportInSituService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISupportInSituService.cs index 687f296de27..449fe02dec3 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISupportInSituService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ISupportInSituService.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms.Design { /// - /// Provides an interface for a designer to support Insitu editing for selected components. + /// Provides an interface for a designer to support Insitu editing for selected components. /// [Runtime.InteropServices.ComVisible(true)] internal interface ISupportInSituService { /// - /// Returns if the service is interested in InSitu Edit on Key Messages.. + /// Returns if the service is interested in InSitu Edit on Key Messages.. /// bool IgnoreMessages { get; } /// - /// This method allows the service to handle the first WM_CHAR message. The implementer for this service can perform any tasks that it wants when it gets this message. - /// e.g : ToolStripInSituService shows the Editor for each ToolStripItem in HandleKeyChar() + /// This method allows the service to handle the first WM_CHAR message. The implementer for this service can perform any tasks that it wants when it gets this message. + /// e.g : ToolStripInSituService shows the Editor for each ToolStripItem in HandleKeyChar() /// void HandleKeyChar(); /// - /// Returns the Window Handle that gets all the Keyboarf messages once in InSitu. + /// Returns the Window Handle that gets all the Keyboarf messages once in InSitu. /// IntPtr GetEditWindow(); diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceService.cs index 52a3183ca78..9ee62d46d95 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceService.cs @@ -13,7 +13,7 @@ namespace System.ComponentModel.Design { /// - /// Provides a set of methods for analyzing and identifying inherited components. + /// Provides a set of methods for analyzing and identifying inherited components. /// public class InheritanceService : IInheritanceService, IDisposable { @@ -24,7 +24,7 @@ public class InheritanceService : IInheritanceService, IDisposable private InheritanceAttribute _addingAttribute; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public InheritanceService() { @@ -32,7 +32,7 @@ public InheritanceService() } /// - /// Disposes of the resources (other than memory) used by the . + /// Disposes of the resources (other than memory) used by the . /// public void Dispose() { @@ -49,7 +49,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Adds inherited components to the . + /// Adds inherited components to the . /// public void AddInheritedComponents(IComponent component, IContainer container) { @@ -57,7 +57,7 @@ public void AddInheritedComponents(IComponent component, IContainer container) } /// - /// Adds inherited components to the . + /// Adds inherited components to the . /// protected virtual void AddInheritedComponents(Type type, IComponent component, IContainer container) { @@ -231,7 +231,7 @@ protected virtual void AddInheritedComponents(Type type, IComponent component, I } /// - /// Indicates the inherited members to ignore. + /// Indicates the inherited members to ignore. /// protected virtual bool IgnoreInheritedMember(MemberInfo member, IComponent component) { @@ -249,7 +249,7 @@ protected virtual bool IgnoreInheritedMember(MemberInfo member, IComponent compo } /// - /// Gets the inheritance attribute of the specified component. + /// Gets the inheritance attribute of the specified component. /// public InheritanceAttribute GetInheritanceAttribute(IComponent component) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceUI.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceUI.cs index 2344c976017..f8aef642684 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceUI.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/InheritanceUI.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// This class handles the user interface for inherited components. + /// This class handles the user interface for inherited components. /// internal class InheritanceUI { @@ -18,7 +18,7 @@ internal class InheritanceUI private ToolTip _tooltip; /// - /// The bitmap we use to show inheritance. + /// The bitmap we use to show inheritance. /// public Bitmap InheritanceGlyph { @@ -38,7 +38,7 @@ public Bitmap InheritanceGlyph } /// - /// The rectangle surrounding the glyph. + /// The rectangle surrounding the glyph. /// public Rectangle InheritanceGlyphRectangle { @@ -54,7 +54,7 @@ public Rectangle InheritanceGlyphRectangle } /// - /// Adds an inherited control to our list. This creates a tool tip for that control. + /// Adds an inherited control to our list. This creates a tool tip for that control. /// public void AddInheritedControl(Control c, InheritanceLevel level) { @@ -98,7 +98,7 @@ public void Dispose() } /// - /// Removes a previously added inherited control. + /// Removes a previously added inherited control. /// public void RemoveInheritedControl(Control c) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ItemTypeToolStripMenuItem.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ItemTypeToolStripMenuItem.cs index 89b237fa7b2..b0b5c6ca25e 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ItemTypeToolStripMenuItem.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ItemTypeToolStripMenuItem.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms.Design { /// - /// Associates Type with ToolStripMenuItem. + /// Associates Type with ToolStripMenuItem. /// internal class ItemTypeToolStripMenuItem : ToolStripMenuItem { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/MenuCommands.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/MenuCommands.cs index cb14f082788..3276a838181 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/MenuCommands.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/MenuCommands.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// This class contains command ID's and GUIDS that correspond to the host Command Bar menu layout. + /// This class contains command ID's and GUIDS that correspond to the host Command Bar menu layout. /// public sealed class MenuCommands : StandardCommands { @@ -58,26 +58,26 @@ public sealed class MenuCommands : StandardCommands private const int ECMD_END_EXT = 18; /// - /// This guid corresponds to the standard set of commands for the shell and office. - /// This new giud is added so that the ToolStripDesigner now respond to the F2 command - /// and go into InSitu Edit mode. + /// This guid corresponds to the standard set of commands for the shell and office. + /// This new giud is added so that the ToolStripDesigner now respond to the F2 command + /// and go into InSitu Edit mode. /// private static readonly Guid VSStandardCommandSet97 = new Guid("{5efc7975-14bc-11cf-9b2b-00aa00573819}"); /// - /// This guid corresponds to the menu grouping Windows Forms will use for its menus. This is - /// defined in the Windows Forms menu CTC file, but we need it here so we can define what - /// context menus to use. + /// This guid corresponds to the menu grouping Windows Forms will use for its menus. This is + /// defined in the Windows Forms menu CTC file, but we need it here so we can define what + /// context menus to use. /// private static readonly Guid wfMenuGroup = new Guid("{74D21312-2AEE-11d1-8BFB-00A0C90F26F7}"); /// - /// This guid corresponds to the Windows Forms command set. + /// This guid corresponds to the Windows Forms command set. /// private static readonly Guid wfCommandSet = new Guid("{74D21313-2AEE-11d1-8BFB-00A0C90F26F7}"); /// - /// This guid is the standard vs 2k commands for key bindings + /// This guid is the standard vs 2k commands for key bindings /// private static readonly Guid guidVSStd2K = new Guid("{1496A755-94DE-11D0-8C3F-00C04FC2AAE2}"); diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionManager.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionManager.cs index 165959f7a19..ecd91a2e6f6 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionManager.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionManager.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms.Design { /// - /// The SelectionBehavior is pushed onto the BehaviorStack in response to apositively hit tested SelectionGlyph. The SelectionBehavior performs two main tasks: 1) forward messages to the related ControlDesigner, and 2) calls upon the SelectionManager to push a potention DragBehavior. + /// The SelectionBehavior is pushed onto the BehaviorStack in response to apositively hit tested SelectionGlyph. The SelectionBehavior performs two main tasks: 1) forward messages to the related ControlDesigner, and 2) calls upon the SelectionManager to push a potention DragBehavior. /// internal sealed class SelectionManager : IDisposable { @@ -33,7 +33,7 @@ internal sealed class SelectionManager : IDisposable private bool _selectionChanging; //we dont want the OnSelectionChanged to be recursively called. /// - /// Constructor. Here we query for necessary services and cache them for perf. reasons. We also hook to Component Added/Removed/Changed notifications so we can keep in sync when the designers' components change. Also, we create our custom Adorner and add it to the BehaviorService. + /// Constructor. Here we query for necessary services and cache them for perf. reasons. We also hook to Component Added/Removed/Changed notifications so we can keep in sync when the designers' components change. Also, we create our custom Adorner and add it to the BehaviorService. /// public SelectionManager(IServiceProvider serviceProvider, BehaviorService behaviorService) { @@ -68,7 +68,7 @@ public SelectionManager(IServiceProvider serviceProvider, BehaviorService behavi } /// - /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. + /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. /// internal Adorner BodyGlyphAdorner { @@ -76,7 +76,7 @@ internal Adorner BodyGlyphAdorner } /// - /// There are certain cases like Adding Item to ToolStrips through InSitu Editor, where there is ParentTransaction that has to be cancelled depending upon the user action. When this parent transaction is cancelled, there may be no reason to REFRESH the selectionManager which actually clears all the glyphs and readds them. This REFRESH causes a lot of flicker and can be avoided by setting this property to false. Since this property is checked in the TransactionClosed, the SelectionManager won't REFRESH and hence just eat up the refresh thus avoiding unnecessary flicker. + /// There are certain cases like Adding Item to ToolStrips through InSitu Editor, where there is ParentTransaction that has to be cancelled depending upon the user action. When this parent transaction is cancelled, there may be no reason to REFRESH the selectionManager which actually clears all the glyphs and readds them. This REFRESH causes a lot of flicker and can be avoided by setting this property to false. Since this property is checked in the TransactionClosed, the SelectionManager won't REFRESH and hence just eat up the refresh thus avoiding unnecessary flicker. /// internal bool NeedRefresh { @@ -85,7 +85,7 @@ internal bool NeedRefresh } /// - /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. + /// Returns the Adorner that contains all the BodyGlyphs for the current selection state. /// internal Adorner SelectionGlyphAdorner { @@ -93,7 +93,7 @@ internal Adorner SelectionGlyphAdorner } /// - /// This method fist calls the recursive AddControlGlyphs() method. When finished, we add the final glyph(s) to the root comp. + /// This method fist calls the recursive AddControlGlyphs() method. When finished, we add the final glyph(s) to the root comp. /// private void AddAllControlGlyphs(Control parent, ArrayList selComps, object primarySelection) { @@ -118,7 +118,7 @@ private void AddAllControlGlyphs(Control parent, ArrayList selComps, object prim } /// - /// Recursive method that goes through and adds all the glyphs of every child to our global Adorner. + /// Recursive method that goes through and adds all the glyphs of every child to our global Adorner. /// private void AddControlGlyphs(Control c, GlyphSelectionType selType) { @@ -165,7 +165,7 @@ private void AddControlGlyphs(Control c, GlyphSelectionType selType) } /// - /// Unhook all of our event notifications, clear our adorner and remove it from the Beh.Svc. + /// Unhook all of our event notifications, clear our adorner and remove it from the Beh.Svc. /// public void Dispose() { @@ -205,7 +205,7 @@ public void Dispose() } /// - /// Refreshes all selection Glyphs. + /// Refreshes all selection Glyphs. /// public void Refresh() { @@ -214,7 +214,7 @@ public void Refresh() } /// - /// When a component is added, we get the designer and add it to our hashtable for quick lookup. + /// When a component is added, we get the designer and add it to our hashtable for quick lookup. /// private void OnComponentAdded(object source, ComponentEventArgs ce) { @@ -227,7 +227,7 @@ private void OnComponentAdded(object source, ComponentEventArgs ce) } /// - /// Before a drag, remove all glyphs that are involved in the drag operation and any that don't allow drops. + /// Before a drag, remove all glyphs that are involved in the drag operation and any that don't allow drops. /// private void OnBeginDrag(object source, BehaviorDragDropEventArgs e) { @@ -257,7 +257,7 @@ internal void OnBeginDrag(BehaviorDragDropEventArgs e) } /// - /// When a component is changed - we need to refresh the selection. + /// When a component is changed - we need to refresh the selection. /// private void OnComponentChanged(object source, ComponentChangedEventArgs ce) { @@ -275,7 +275,7 @@ private void OnComponentChanged(object source, ComponentChangedEventArgs ce) } /// - /// When a component is removed - we remove the key & value from our hashtable. + /// When a component is removed - we remove the key & value from our hashtable. /// private void OnComponentRemoved(object source, ComponentEventArgs ce) { @@ -290,7 +290,7 @@ private void OnComponentRemoved(object source, ComponentEventArgs ce) } } /// - /// Computes the region representing the difference between the old selection and the new selection. + /// Computes the region representing the difference between the old selection and the new selection. /// private Region DetermineRegionToRefresh(object primarySelection) { @@ -365,7 +365,7 @@ private Region DetermineRegionToRefresh(object primarySelection) } /// - /// Event handler for the behaviorService's Synchronize event + /// Event handler for the behaviorService's Synchronize event /// private void OnSynchronize(object sender, EventArgs e) { @@ -373,7 +373,7 @@ private void OnSynchronize(object sender, EventArgs e) } /// - /// On every selectionchange, we remove all glyphs, get the newly selected components, and re-add all glyphs back to the Adorner. + /// On every selectionchange, we remove all glyphs, get the newly selected components, and re-add all glyphs back to the Adorner. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -437,7 +437,7 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// When a transaction that involves one of our components closes, refresh to reflect any changes. + /// When a transaction that involves one of our components closes, refresh to reflect any changes. /// private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionRules.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionRules.cs index c5bbe6f634f..c1d871a776c 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionRules.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionRules.cs @@ -7,54 +7,54 @@ namespace System.Windows.Forms.Design { /// - /// Specifies a set of selection rule identifiers that can be used to indicate attributes for a selected component. + /// Specifies a set of selection rule identifiers that can be used to indicate attributes for a selected component. /// // We need to combine the SelectionRules. [Flags] public enum SelectionRules { /// - /// Indicates no special selection attributes. + /// Indicates no special selection attributes. /// None = 0x00000000, /// - /// Indicates the given component supports a location property that allows it to be moved on the screen, and that the selection service is not currently locked. + /// Indicates the given component supports a location property that allows it to be moved on the screen, and that the selection service is not currently locked. /// Moveable = 0x10000000, /// - /// Indicates the given component has some form of visible user interface and the selection service is drawing a selection border around this user interface. If a selected component has this rule set, you can assume that the component implements and that it is associated with a corresponding design instance. + /// Indicates the given component has some form of visible user interface and the selection service is drawing a selection border around this user interface. If a selected component has this rule set, you can assume that the component implements and that it is associated with a corresponding design instance. /// Visible = 0x40000000, /// - /// Indicates the given component is locked to its container. Overrides the moveable and sizeable properties of this enum. + /// Indicates the given component is locked to its container. Overrides the moveable and sizeable properties of this enum. /// Locked = unchecked((int)0x80000000), /// - /// Indicates the given component supports resize from the top. This bit will be ignored unless the Sizeable bit is also set. + /// Indicates the given component supports resize from the top. This bit will be ignored unless the Sizeable bit is also set. /// TopSizeable = 0x00000001, /// - /// Indicates the given component supports resize from the bottom. This bit will be ignored unless the Sizeable bit is also set. + /// Indicates the given component supports resize from the bottom. This bit will be ignored unless the Sizeable bit is also set. /// BottomSizeable = 0x00000002, /// - /// Indicates the given component supports resize from the left. This bit will be ignored unless the Sizeable bit is also set. + /// Indicates the given component supports resize from the left. This bit will be ignored unless the Sizeable bit is also set. /// LeftSizeable = 0x00000004, /// - /// Indicates the given component supports resize from the right. This bit will be ignored unless the Sizeable bit is also set. + /// Indicates the given component supports resize from the right. This bit will be ignored unless the Sizeable bit is also set. /// RightSizeable = 0x00000008, /// - /// Indicates the given component supports sizing in all directions, and the selection service is not currently locked. + /// Indicates the given component supports sizing in all directions, and the selection service is not currently locked. /// AllSizeable = TopSizeable | BottomSizeable | LeftSizeable | RightSizeable } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionStyles.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionStyles.cs index 03d66484741..dc4d8ce04dc 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionStyles.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionStyles.cs @@ -5,21 +5,21 @@ namespace System.Windows.Forms.Design { /// - /// Specifies identifiers to use to indicate the style of the selection frame of a component. + /// Specifies identifiers to use to indicate the style of the selection frame of a component. /// [Flags] internal enum SelectionStyles { /// - /// The component is not currently selected. + /// The component is not currently selected. /// None = 0, /// - /// A component is selected and may be dragged around + /// A component is selected and may be dragged around /// Selected = 0x01, /// - /// An alternative selection border, indicating that a component is in active editing mode and that clicking and dragging on the component affects the component itself, not its position in the designer. + /// An alternative selection border, indicating that a component is in active editing mode and that clicking and dragging on the component affects the component itself, not its position in the designer. /// Active = 0x02, diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionUIService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionUIService.cs index c0b2ab48313..80b89d83e24 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionUIService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/SelectionUIService.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms.Design { /// - /// The selection manager handles selection within a form. There is one selection manager for each form or top level designer. A selection consists of an array of components. One component is designated the "primary" selection and is displayed with different grab handles. An individual selection may or may not have UI associated with it. If the selection manager can find a suitable designer that is representing the selection, it will highlight the designer's border. If the merged property set has a location property, the selection's rules will allow movement. Also, if the property set has a size property, the selection's rules will allow for sizing. Grab handles may be drawn around the designer and user interactions involving the selection frame and grab handles are initiated here, but the actual movement of the objects is done in a designer object that implements the ISelectionHandler interface. + /// The selection manager handles selection within a form. There is one selection manager for each form or top level designer. A selection consists of an array of components. One component is designated the "primary" selection and is displayed with different grab handles. An individual selection may or may not have UI associated with it. If the selection manager can find a suitable designer that is representing the selection, it will highlight the designer's border. If the merged property set has a location property, the selection's rules will allow movement. Also, if the property set has a size property, the selection's rules will allow for sizing. Grab handles may be drawn around the designer and user interactions involving the selection frame and grab handles are initiated here, but the actual movement of the objects is done in a designer object that implements the ISelectionHandler interface. /// internal sealed class SelectionUIService : Control, ISelectionUIService { @@ -49,7 +49,7 @@ internal sealed class SelectionUIService : Control, ISelectionUIService private DesignerTransaction _dragTransaction; /// - /// Creates a new selection manager object. The selection manager manages all selection of all designers under the current form file. + /// Creates a new selection manager object. The selection manager manages all selection of all designers under the current form file. /// public SelectionUIService(IDesignerHost host) : base() { @@ -84,7 +84,7 @@ public SelectionUIService(IDesignerHost host) : base() } /// - /// override of control. + /// override of control. /// protected override CreateParams CreateParams { @@ -97,7 +97,7 @@ protected override CreateParams CreateParams } /// - /// Called to initiate a mouse drag on the selection overlay. We cache some state here. + /// Called to initiate a mouse drag on the selection overlay. We cache some state here. /// private void BeginMouseDrag(Point anchor, int hitTest) { @@ -111,7 +111,7 @@ private void BeginMouseDrag(Point anchor, int hitTest) } /// - /// Displays the given exception to the user. + /// Displays the given exception to the user. /// private void DisplayError(Exception e) { @@ -132,7 +132,7 @@ private void DisplayError(Exception e) } /// - /// Disposes the entire selection UI manager. + /// Disposes the entire selection UI manager. /// protected override void Dispose(bool disposing) { @@ -168,7 +168,7 @@ protected override void Dispose(bool disposing) } /// - /// Called when we want to finish a mouse drag and clean up our variables. We call this from multiple places, depending on the state of the finish. This does NOT end the drag -- for that must call EndDrag. This just cleans up the state of the mouse. + /// Called when we want to finish a mouse drag and clean up our variables. We call this from multiple places, depending on the state of the finish. This does NOT end the drag -- for that must call EndDrag. This just cleans up the state of the mouse. /// private void EndMouseDrag(Point position) { @@ -188,7 +188,7 @@ private void EndMouseDrag(Point position) } /// - /// Determines the selection hit test at the given point. The point should be in screen coordinates. + /// Determines the selection hit test at the given point. The point should be in screen coordinates. /// private HitTestInfo GetHitTest(Point value, int flags) { @@ -232,7 +232,7 @@ private HitTestInfo GetHitTest(Point value, int flags) private ISelectionUIHandler GetHandler(object component) => (ISelectionUIHandler)_selectionHandlers[component]; /// - /// This method returns a well-formed name for a drag transaction based on the rules it is given. + /// This method returns a well-formed name for a drag transaction based on the rules it is given. /// public static string GetTransactionName(SelectionRules rules, object[] objects) { @@ -292,7 +292,7 @@ public static string GetTransactionName(SelectionRules rules, object[] objects) } /// - /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. + /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. /// private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArgs e) { @@ -313,7 +313,7 @@ private void OnTransactionClosed(object sender, DesignerTransactionCloseEventArg } /// - /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. + /// Called by the designer host when it is entering or leaving a batch operation. Here we queue up selection notification and we turn off our UI. /// private void OnTransactionOpened(object sender, EventArgs e) { @@ -321,7 +321,7 @@ private void OnTransactionOpened(object sender, EventArgs e) } /// - /// update our window region on first create. We shouldn't do this before the handle is created or else we will force creation. + /// update our window region on first create. We shouldn't do this before the handle is created or else we will force creation. /// protected override void OnHandleCreated(EventArgs e) { @@ -332,7 +332,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Called whenever a component changes. Here we update our selection information so that the selection rectangles are all up to date. + /// Called whenever a component changes. Here we update our selection information so that the selection rectangles are all up to date. /// private void OnComponentChanged(object sender, ComponentChangedEventArgs ccevent) { @@ -347,7 +347,7 @@ private void OnComponentChanged(object sender, ComponentChangedEventArgs ccevent } /// - /// called by the formcore when someone has removed a component. This will remove any selection on the component without disturbing the rest of the selection + /// called by the formcore when someone has removed a component. This will remove any selection on the component without disturbing the rest of the selection /// private void OnComponentRemove(object sender, ComponentEventArgs ce) { @@ -357,7 +357,7 @@ private void OnComponentRemove(object sender, ComponentEventArgs ce) } /// - /// Called to invoke the container active event, if a designer has bound to it. + /// Called to invoke the container active event, if a designer has bound to it. /// private void OnContainerSelectorActive(ContainerSelectorActiveEventArgs e) { @@ -365,7 +365,7 @@ private void OnContainerSelectorActive(ContainerSelectorActiveEventArgs e) } /// - /// Called when the selection changes. We sync up the UI with the selection at this point. + /// Called when the selection changes. We sync up the UI with the selection at this point. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -413,17 +413,17 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// User setting requires that we repaint. + /// User setting requires that we repaint. /// private void OnSystemSettingChanged(object sender, EventArgs e) => Invalidate(); /// - /// User setting requires that we repaint. + /// User setting requires that we repaint. /// private void OnUserPreferenceChanged(object sender, UserPreferenceChangedEventArgs e) => Invalidate(); /// - /// Inheriting classes should override this method to handle this event. Call super.onDragEnter to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. Call super.onDragEnter to send this event to any registered event listeners. /// protected override void OnDragEnter(DragEventArgs devent) { @@ -435,7 +435,7 @@ protected override void OnDragEnter(DragEventArgs devent) } /// - /// Inheriting classes should override this method to handle this event. Call super.onDragOver to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. Call super.onDragOver to send this event to any registered event listeners. /// protected override void OnDragOver(DragEventArgs devent) { @@ -446,7 +446,7 @@ protected override void OnDragOver(DragEventArgs devent) } } /// - /// Inheriting classes should override this method to handle this event. Call super.onDragLeave to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. Call super.onDragLeave to send this event to any registered event listeners. /// protected override void OnDragLeave(EventArgs e) { @@ -458,7 +458,7 @@ protected override void OnDragLeave(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. Call super.onDragDrop to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. Call super.onDragDrop to send this event to any registered event listeners. /// protected override void OnDragDrop(DragEventArgs devent) { @@ -470,7 +470,7 @@ protected override void OnDragDrop(DragEventArgs devent) } /// - /// Inheriting classes should override this method to handle this event. Call base.OnDoiubleClick to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. Call base.OnDoiubleClick to send this event to any registered event listeners. /// protected override void OnDoubleClick(EventArgs devent) { @@ -491,7 +491,7 @@ protected override void OnDoubleClick(EventArgs devent) } /// - /// Overrides Control to handle our selection grab handles. + /// Overrides Control to handle our selection grab handles. /// // Standard 'catch all - rethrow critical' exception pattern protected override void OnMouseDown(MouseEventArgs me) @@ -583,7 +583,7 @@ protected override void OnMouseDown(MouseEventArgs me) } /// - /// Overrides Control to handle our selection grab handles. + /// Overrides Control to handle our selection grab handles. /// protected override void OnMouseMove(MouseEventArgs me) { @@ -688,7 +688,7 @@ protected override void OnMouseMove(MouseEventArgs me) } /// - /// Overrides Control to handle our selection grab handles. + /// Overrides Control to handle our selection grab handles. /// // Standard 'catch all - rethrow critical' exception pattern protected override void OnMouseUp(MouseEventArgs me) @@ -732,7 +732,7 @@ protected override void OnMouseUp(MouseEventArgs me) } /// - /// If the selection manager move, this indicates that the form has autoscolling enabled and has been scrolled. We have to invalidate here because we may get moved before the rest of the components so we may draw the selection in the wrong spot. + /// If the selection manager move, this indicates that the form has autoscolling enabled and has been scrolled. We have to invalidate here because we may get moved before the rest of the components so we may draw the selection in the wrong spot. /// protected override void OnMove(EventArgs e) { @@ -741,7 +741,7 @@ protected override void OnMove(EventArgs e) } /// - /// overrides control.onPaint. here we paint the selection handles. The window's region was setup earlier. + /// overrides control.onPaint. here we paint the selection handles. The window's region was setup earlier. /// protected override void OnPaint(PaintEventArgs e) { @@ -765,7 +765,7 @@ protected override void OnPaint(PaintEventArgs e) } /// - /// Sets the appropriate selection cursor at the given point. + /// Sets the appropriate selection cursor at the given point. /// private void SetSelectionCursor(Point pt) { @@ -816,7 +816,7 @@ private void SetSelectionCursor(Point pt) } /// - /// called when the overlay region is invalid and should be updated + /// called when the overlay region is invalid and should be updated /// private void UpdateWindowRegion() { @@ -830,7 +830,7 @@ private void UpdateWindowRegion() } /// - /// Override of our control's WNDPROC. We diddle with capture a bit, and it's important to turn this off if the capture changes. + /// Override of our control's WNDPROC. We diddle with capture a bit, and it's important to turn this off if the capture changes. /// protected override void WndProc(ref Message m) { @@ -859,7 +859,7 @@ protected override void WndProc(ref Message m) } /// - /// This can be used to determine if the user is in the middle of a drag operation. + /// This can be used to determine if the user is in the middle of a drag operation. /// bool ISelectionUIService.Dragging { @@ -867,7 +867,7 @@ bool ISelectionUIService.Dragging } /// - /// Determines if the selection UI is shown or not. + /// Determines if the selection UI is shown or not. /// bool ISelectionUIService.Visible { @@ -876,7 +876,7 @@ bool ISelectionUIService.Visible } /// - /// Adds an event handler to the ContainerSelectorActive event. This event is fired whenever the user interacts with the container selector in a manor that would indicate that the selector should continued to be displayed. Since the container selector normally will vanish after a timeout, designers should listen to this event and reset the timeout when this event occurs. + /// Adds an event handler to the ContainerSelectorActive event. This event is fired whenever the user interacts with the container selector in a manor that would indicate that the selector should continued to be displayed. Since the container selector normally will vanish after a timeout, designers should listen to this event and reset the timeout when this event occurs. /// event ContainerSelectorActiveEventHandler ISelectionUIService.ContainerSelectorActive { @@ -885,7 +885,7 @@ event ContainerSelectorActiveEventHandler ISelectionUIService.ContainerSelectorA } /// - /// Assigns a selection UI handler to a given component. The handler will be called when the UI service needs information about the component. A single selection UI handler can be assigned to multiple components. When multiple components are dragged, only a single handler may control the drag. Because of this, only components that are assigned the same handler as the primary selection are included in drag operations. A selection UI handler is automatically unassigned when the component is removed from the container or disposed. + /// Assigns a selection UI handler to a given component. The handler will be called when the UI service needs information about the component. A single selection UI handler can be assigned to multiple components. When multiple components are dragged, only a single handler may control the drag. Because of this, only components that are assigned the same handler as the primary selection are included in drag operations. A selection UI handler is automatically unassigned when the component is removed from the container or disposed. /// void ISelectionUIService.AssignSelectionUIHandler(object component, ISelectionUIHandler handler) { @@ -921,7 +921,7 @@ void ISelectionUIService.ClearSelectionUIHandler(object component, ISelectionUIH } /// - /// This can be called by an outside party to begin a drag of the currently selected set of components. + /// This can be called by an outside party to begin a drag of the currently selected set of components. /// // Standard 'catch all - rethrow critical' exception pattern bool ISelectionUIService.BeginDrag(SelectionRules rules, int initialX, int initialY) @@ -1030,7 +1030,7 @@ bool ISelectionUIService.BeginDrag(SelectionRules rules, int initialX, int initi } /// - /// Called by an outside party to update drag information. This can only be called after a successful call to beginDrag. + /// Called by an outside party to update drag information. This can only be called after a successful call to beginDrag. /// void ISelectionUIService.DragMoved(Rectangle offset) { @@ -1068,7 +1068,7 @@ void ISelectionUIService.DragMoved(Rectangle offset) } /// - /// Called by an outside party to finish a drag operation. This can only be called after a successful call to beginDrag. + /// Called by an outside party to finish a drag operation. This can only be called after a successful call to beginDrag. /// // Standard 'catch all - rethrow critical' exception pattern void ISelectionUIService.EndDrag(bool cancel) @@ -1130,7 +1130,7 @@ void ISelectionUIService.EndDrag(bool cancel) } /// - /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. + /// Filters the set of selected components. The selection service will retrieve all components that are currently selected. This method allows you to filter this set down to components that match your criteria. The selectionRules parameter must contain one or more flags from the SelectionRules class. These flags allow you to constrain the set of selected objects to visible, movable, sizeable or all objects. /// object[] ISelectionUIService.FilterSelection(object[] components, SelectionRules selectionRules) { @@ -1160,7 +1160,7 @@ object[] ISelectionUIService.FilterSelection(object[] components, SelectionRules } /// - /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. + /// Retrieves the width and height of a selection border grab handle. Designers may need this to properly position their user interfaces. /// Size ISelectionUIService.GetAdornmentDimensions(AdornmentType adornmentType) { @@ -1176,17 +1176,17 @@ Size ISelectionUIService.GetAdornmentDimensions(AdornmentType adornmentType) } /// - /// Tests to determine if the given screen coordinate is over an adornment for the specified component. This will only return true if the adornment, and selection UI, is visible. + /// Tests to determine if the given screen coordinate is over an adornment for the specified component. This will only return true if the adornment, and selection UI, is visible. /// bool ISelectionUIService.GetAdornmentHitTest(object component, Point value) => GetHitTest(value, HITTEST_DEFAULT).hitTest != SelectionUIItem.NOHIT; /// - /// Determines if the component is currently "container" selected. Container selection is a visual aid for selecting containers. It doesn't affect the normal "component" selection. + /// Determines if the component is currently "container" selected. Container selection is a visual aid for selecting containers. It doesn't affect the normal "component" selection. /// bool ISelectionUIService.GetContainerSelected(object component) => (component != null && _selectionItems[component] is ContainerSelectionUIItem); /// - /// Retrieves a set of flags that define rules for the selection. Selection rules indicate if the given component can be moved or sized, for example. + /// Retrieves a set of flags that define rules for the selection. Selection rules indicate if the given component can be moved or sized, for example. /// SelectionRules ISelectionUIService.GetSelectionRules(object component) { @@ -1200,7 +1200,7 @@ SelectionRules ISelectionUIService.GetSelectionRules(object component) } /// - /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. + /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. /// SelectionStyles ISelectionUIService.GetSelectionStyle(object component) { @@ -1213,7 +1213,7 @@ SelectionStyles ISelectionUIService.GetSelectionStyle(object component) } /// - /// Changes the container selection status of the given component. Container selection is a visual aid for selecting containers. It doesn't affect the normal "component" selection. + /// Changes the container selection status of the given component. Container selection is a visual aid for selecting containers. It doesn't affect the normal "component" selection. /// void ISelectionUIService.SetContainerSelected(object component, bool selected) { @@ -1254,7 +1254,7 @@ void ISelectionUIService.SetContainerSelected(object component, bool selected) } /// - /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. + /// Allows you to configure the style of the selection frame that a component uses. This is useful if your component supports different modes of operation (such as an in-place editing mode and a static design mode). Where possible, you should leave the selection style as is and use the design-time hit testing feature of the IDesigner interface to provide features at design time. The value of style must be one of the SelectionStyle enum values. The selection style is only valid for the duration that the component is selected. /// void ISelectionUIService.SetSelectionStyle(object component, SelectionStyles style) { @@ -1274,7 +1274,7 @@ void ISelectionUIService.SetSelectionStyle(object component, SelectionStyles sty } /// - /// This should be called when a component has been moved, sized or re-parented, but the change was not the result of a property change. All property changes are monitored by the selection UI service, so this is automatic most of the time. There are times, however, when a component may be moved without a property change notification occurring. Scrolling an auto scroll Win32 form is an example of this. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. + /// This should be called when a component has been moved, sized or re-parented, but the change was not the result of a property change. All property changes are monitored by the selection UI service, so this is automatic most of the time. There are times, however, when a component may be moved without a property change notification occurring. Scrolling an auto scroll Win32 form is an example of this. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. /// void ISelectionUIService.SyncSelection() { @@ -1302,7 +1302,7 @@ void ISelectionUIService.SyncSelection() } /// - /// This should be called when a component's property changed, that the designer thinks should result in a selection UI change. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. + /// This should be called when a component's property changed, that the designer thinks should result in a selection UI change. This method simply re-queries all currently selected components for their bounds and udpates the selection handles for any that have changed. /// void ISelectionUIService.SyncComponent(object component) { @@ -1327,7 +1327,7 @@ void ISelectionUIService.SyncComponent(object component) } /// - /// This class represents a single selected object. + /// This class represents a single selected object. /// private class SelectionUIItem { @@ -1383,7 +1383,7 @@ private class SelectionUIItem private SelectionRules _selectionRules; private readonly ISelectionUIHandler _handler; // the components selection UI handler (can be null) - /// Its ok to call virtual method as this is a private class. + /// Its ok to call virtual method as this is a private class. public SelectionUIItem(SelectionUIService selUIsvc, object component) { _selUIsvc = selUIsvc; @@ -1406,7 +1406,7 @@ public SelectionUIItem(SelectionUIService selUIsvc, object component) } /// - /// Retrieves the style of the selection frame for this selection. + /// Retrieves the style of the selection frame for this selection. /// public virtual SelectionStyles Style { @@ -1426,7 +1426,7 @@ public virtual SelectionStyles Style } /// - /// paints the selection + /// paints the selection /// public virtual void DoPaint(Graphics gr) { @@ -1496,7 +1496,7 @@ public virtual void DoPaint(Graphics gr) } /// - /// Retrieves an appropriate cursor at the given point. If there is no appropriate cursor here (ie, the point lies outside the selection rectangle), then this will return null. + /// Retrieves an appropriate cursor at the given point. If there is no appropriate cursor here (ie, the point lies outside the selection rectangle), then this will return null. /// public virtual Cursor GetCursorAtPoint(Point pt) { @@ -1529,7 +1529,7 @@ public virtual Cursor GetCursorAtPoint(Point pt) } /// - /// returns the hit test code of the given point. This may be one of: + /// returns the hit test code of the given point. This may be one of: /// public virtual int GetHitTest(Point pt) { @@ -1550,7 +1550,7 @@ public virtual int GetHitTest(Point pt) } /// - /// gets the array offset of the handle at the given point + /// gets the array offset of the handle at the given point /// private int GetHandleIndexOfPoint(Point pt) { @@ -1630,7 +1630,7 @@ private int GetHandleIndexOfPoint(Point pt) } /// - /// returns a region handle that defines this selection. This is used to piece together a paint region for the surface that we draw our selection handles on + /// returns a region handle that defines this selection. This is used to piece together a paint region for the surface that we draw our selection handles on /// public virtual Region GetRegion() { @@ -1659,7 +1659,7 @@ public virtual Region GetRegion() } /// - /// Retrieves the rules associated with this selection. + /// Retrieves the rules associated with this selection. /// public SelectionRules GetRules() => _selectionRules; @@ -1673,7 +1673,7 @@ public void Dispose() } /// - /// Invalidates the region for this selection glyph. + /// Invalidates the region for this selection glyph. /// public void Invalidate() { @@ -1684,7 +1684,7 @@ public void Invalidate() } /// - /// Part of our hit testing logic; determines if the point is somewhere within our selection. + /// Part of our hit testing logic; determines if the point is somewhere within our selection. /// protected bool PointWithinSelection(Point pt) { @@ -1712,7 +1712,7 @@ protected bool PointWithinSelection(Point pt) } /// - /// Updates the available grab handle settings based on the current rules. + /// Updates the available grab handle settings based on the current rules. /// private void UpdateGrabSettings() { @@ -1768,7 +1768,7 @@ private void UpdateGrabSettings() } /// - /// Updates our cached selection rules based on current handler values. + /// Updates our cached selection rules based on current handler values. /// public void UpdateRules() { @@ -1789,7 +1789,7 @@ public void UpdateRules() } /// - /// rebuilds the inner and outer rectangles based on the current selItem.component dimensions. We could calcuate this every time, but that would be expensive for functions like getHitTest that are called a lot (like on every mouse move) + /// rebuilds the inner and outer rectangles based on the current selItem.component dimensions. We could calcuate this every time, but that would be expensive for functions like getHitTest that are called a lot (like on every mouse move) /// public virtual bool UpdateSize() { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardCommandToolStripMenuItem.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardCommandToolStripMenuItem.cs index 3c45c69d832..d9fcbb0de6c 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardCommandToolStripMenuItem.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardCommandToolStripMenuItem.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// Associates standard command with ToolStripMenuItem. + /// Associates standard command with ToolStripMenuItem. /// internal class StandardCommandToolStripMenuItem : ToolStripMenuItem { @@ -53,7 +53,7 @@ public void RefreshItem() } /// - /// Retrieves the menu editor service, which we cache for speed. + /// Retrieves the menu editor service, which we cache for speed. /// public IMenuCommandService MenuService { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardMenuStripVerb.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardMenuStripVerb.cs index 9d7db442600..b1b9a6c4b45 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardMenuStripVerb.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StandardMenuStripVerb.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms.Design { /// - /// Internal class to provide 'Insert Standard Items" verb for ToolStrips & MenuStrips. + /// Internal class to provide 'Insert Standard Items" verb for ToolStrips & MenuStrips. /// internal class StandardMenuStripVerb { @@ -23,7 +23,7 @@ internal class StandardMenuStripVerb private readonly IServiceProvider _provider; /// - /// Create one of these things... + /// Create one of these things... /// internal StandardMenuStripVerb(ToolStripDesigner designer) { @@ -35,7 +35,7 @@ internal StandardMenuStripVerb(ToolStripDesigner designer) } /// - /// When the verb is invoked, use all the stuff above to show the dialog, etc. + /// When the verb is invoked, use all the stuff above to show the dialog, etc. /// public void InsertItems() { @@ -64,7 +64,7 @@ public void InsertItems() } /// - /// Here is where all the fun stuff starts. We create the structure and apply the naming here. + /// Here is where all the fun stuff starts. We create the structure and apply the naming here. /// private void CreateStandardMenuStrip(System.ComponentModel.Design.IDesignerHost host, MenuStrip tool) { @@ -248,7 +248,7 @@ private void CreateStandardMenuStrip(System.ComponentModel.Design.IDesignerHost } /// - /// Here is where all the fun stuff starts. We create the structure and apply the naming here. + /// Here is where all the fun stuff starts. We create the structure and apply the naming here. /// private void CreateStandardToolStrip(IDesignerHost host, ToolStrip tool) { @@ -400,7 +400,7 @@ private void CreateStandardToolStrip(IDesignerHost host, ToolStrip tool) } /// - /// Helper Function to get Images from types. + /// Helper Function to get Images from types. /// private Bitmap GetImage(string name) { @@ -445,7 +445,7 @@ private Bitmap GetImage(string name) } /// - /// Computes a name from a text label by removing all spaces and non-alphanumeric characters. + /// Computes a name from a text label by removing all spaces and non-alphanumeric characters. /// private string NameFromText(string text, Type itemType, INameCreationService nameCreationService, bool adjustCapitalization) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StatusCommandUI.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StatusCommandUI.cs index c97fcc2e773..8e0500ee381 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StatusCommandUI.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/StatusCommandUI.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// This class provides a single entrypoint used by the Behaviors, KeySize and KeyMoves (in CommandSets) and SelectionService to update the StatusBar Information. + /// This class provides a single entrypoint used by the Behaviors, KeySize and KeyMoves (in CommandSets) and SelectionService to update the StatusBar Information. /// internal class StatusCommandUI { @@ -23,7 +23,7 @@ public StatusCommandUI(IServiceProvider provider) } /// - /// Retrieves the menu editor service, which we cache for speed. + /// Retrieves the menu editor service, which we cache for speed. /// private IMenuCommandService MenuService { @@ -38,7 +38,7 @@ private IMenuCommandService MenuService } /// - /// Retrieves the actual StatusRectCommand, which we cache for speed. + /// Retrieves the actual StatusRectCommand, which we cache for speed. /// private MenuCommand StatusRectCommand { @@ -56,7 +56,7 @@ private MenuCommand StatusRectCommand } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Component selectedComponent, Point location) { @@ -89,7 +89,7 @@ public void SetStatusInformation(Component selectedComponent, Point location) } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Component selectedComponent) { @@ -117,7 +117,7 @@ public void SetStatusInformation(Component selectedComponent) } /// - /// Actual Function which invokes the command. + /// Actual Function which invokes the command. /// public void SetStatusInformation(Rectangle bounds) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/TemplateNodeCustomMenuItemCollection.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/TemplateNodeCustomMenuItemCollection.cs index f3425e5e0f8..d9063a84725 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/TemplateNodeCustomMenuItemCollection.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/TemplateNodeCustomMenuItemCollection.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// Custom ContextMenu section for ToolStripMenuItems. + /// Custom ContextMenu section for ToolStripMenuItems. /// internal class TemplateNodeCustomMenuItemCollection : CustomMenuItemCollection { @@ -27,7 +27,7 @@ public TemplateNodeCustomMenuItemCollection(IServiceProvider provider, Component } /// - /// Immediate parent - can be ToolStrip if the Item is on the toplevel + /// Immediate parent - can be ToolStrip if the Item is on the toplevel /// private ToolStrip ParentTool { @@ -58,7 +58,7 @@ private void InsertItem(Type t) } /// - /// Insert Item into ToolStrip. + /// Insert Item into ToolStrip. /// // Standard 'catch all - rethrow critical' exception pattern private void InsertToolStripItem(Type t) diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ThemedScrollbarMode.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ThemedScrollbarMode.cs index af40c680ac9..eecad9a921b 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ThemedScrollbarMode.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ThemedScrollbarMode.cs @@ -7,17 +7,17 @@ namespace System.Windows.Forms.Design public enum ThemedScrollbarMode { /// - /// The window and all of its children will have themed scrollbars + /// The window and all of its children will have themed scrollbars /// All = 1, /// - /// The window and all of its children will be un-themed + /// The window and all of its children will be un-themed /// None = 2, /// - /// The window will have themed scrollbars but all of its children will be un-themed + /// The window will have themed scrollbars but all of its children will be un-themed /// OnlyTopLevel = 3 }; diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripActionList.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripActionList.cs index bf0005d03bd..d322bda74c4 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripActionList.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripActionList.cs @@ -31,7 +31,7 @@ public ToolStripActionList(ToolStripDesigner designer) : base(designer.Component } /// - /// False if were inherited and can't be modified. + /// False if were inherited and can't be modified. /// private bool CanAddItems { @@ -85,7 +85,7 @@ private void ChangeProperty(string propertyName, object value) } /// - /// Controls whether the Chrome is Automatically shown on selection + /// Controls whether the Chrome is Automatically shown on selection /// public override bool AutoShow { @@ -152,7 +152,7 @@ private void InvokeInsertStandardItemsVerb() } /// - /// The Main method to group the ActionItems and pass it to the Panel. + /// The Main method to group the ActionItems and pass it to the Panel. /// public override DesignerActionItemCollection GetSortedActionItems() { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripAdornerWindowService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripAdornerWindowService.cs index 3611d73a4ce..1e1eeebb8b3 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripAdornerWindowService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripAdornerWindowService.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms.Design { /// - /// Transparent Window to parent the DropDowns. + /// Transparent Window to parent the DropDowns. /// internal sealed class ToolStripAdornerWindowService : IDisposable { @@ -22,7 +22,7 @@ internal sealed class ToolStripAdornerWindowService : IDisposable private readonly IOverlayService _overlayService; /// - /// This constructor is called from DocumentDesigner's Initialize method. + /// This constructor is called from DocumentDesigner's Initialize method. /// internal ToolStripAdornerWindowService(IServiceProvider serviceProvider, Control windowFrame) { @@ -50,7 +50,7 @@ internal ToolStripAdornerWindowService(IServiceProvider serviceProvider, Control } /// - /// Returns the actual Control that represents the transparent AdornerWindow. + /// Returns the actual Control that represents the transparent AdornerWindow. /// internal Control ToolStripAdornerWindowControl { @@ -58,7 +58,7 @@ internal Control ToolStripAdornerWindowControl } /// - /// Creates and returns a Graphics object for the AdornerWindow + /// Creates and returns a Graphics object for the AdornerWindow /// public Graphics ToolStripAdornerWindowGraphics { @@ -71,7 +71,7 @@ internal Adorner DropDownAdorner } /// - /// Disposes the behavior service. + /// Disposes the behavior service. /// public void Dispose() { @@ -93,7 +93,7 @@ public void Dispose() } /// - /// Translates a point in the AdornerWindow to screen coords. + /// Translates a point in the AdornerWindow to screen coords. /// public Point AdornerWindowPointToScreen(Point p) { @@ -102,7 +102,7 @@ public Point AdornerWindowPointToScreen(Point p) } /// - /// Gets the location (upper-left corner) of the AdornerWindow in screen coords. + /// Gets the location (upper-left corner) of the AdornerWindow in screen coords. /// public Point AdornerWindowToScreen() { @@ -111,7 +111,7 @@ public Point AdornerWindowToScreen() } /// - /// Returns the location of a Control translated to AdornerWidnow coords. + /// Returns the location of a Control translated to AdornerWidnow coords. /// public Point ControlToAdornerWindow(Control c) { @@ -126,7 +126,7 @@ public Point ControlToAdornerWindow(Control c) } /// - /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. + /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. /// public void Invalidate() { @@ -134,7 +134,7 @@ public void Invalidate() } /// - /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. + /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. /// public void Invalidate(Rectangle rect) { @@ -142,7 +142,7 @@ public void Invalidate(Rectangle rect) } /// - /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. + /// Invalidates the BehaviorService's AdornerWindow. This will force a refesh of all Adorners and, in turn, all Glyphs. /// public void Invalidate(Region r) { @@ -163,7 +163,7 @@ internal ArrayList DropDowns } /// - /// ControlDesigner calls this internal method in response to a WmPaint. We need to know when a ControlDesigner paints - 'cause we will need to re-paint any glyphs above of this Control. + /// ControlDesigner calls this internal method in response to a WmPaint. We need to know when a ControlDesigner paints - 'cause we will need to re-paint any glyphs above of this Control. /// internal void ProcessPaintMessage(Rectangle paintRect) { @@ -172,7 +172,7 @@ internal void ProcessPaintMessage(Rectangle paintRect) } /// - /// The AdornerWindow is a transparent window that resides ontop of the Designer's Frame. This window is used by the ToolStripAdornerWindowService to parent the MenuItem DropDowns. + /// The AdornerWindow is a transparent window that resides ontop of the Designer's Frame. This window is used by the ToolStripAdornerWindowService to parent the MenuItem DropDowns. /// private class ToolStripAdornerWindow : Control { @@ -188,7 +188,7 @@ internal ToolStripAdornerWindow(Control designerFrame) } /// - /// The key here is to set the appropriate TransparetWindow style. + /// The key here is to set the appropriate TransparetWindow style. /// protected override CreateParams CreateParams { @@ -202,7 +202,7 @@ protected override CreateParams CreateParams } /// - /// We'll use CreateHandle as our notification for creating our mouse attacher. + /// We'll use CreateHandle as our notification for creating our mouse attacher. /// protected override void OnHandleCreated(EventArgs e) { @@ -210,7 +210,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Unhook and null out our mouseHook. + /// Unhook and null out our mouseHook. /// protected override void OnHandleDestroyed(EventArgs e) { @@ -218,7 +218,7 @@ protected override void OnHandleDestroyed(EventArgs e) } /// - /// Null out our mouseHook and unhook any events. + /// Null out our mouseHook and unhook any events. /// protected override void Dispose(bool disposing) { @@ -234,7 +234,7 @@ protected override void Dispose(bool disposing) } /// - /// Returns true if the DesignerFrame is created & not being disposed. + /// Returns true if the DesignerFrame is created & not being disposed. /// private bool DesignerFrameValid { @@ -249,7 +249,7 @@ private bool DesignerFrameValid } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow() { @@ -261,7 +261,7 @@ internal void InvalidateAdornerWindow() } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow(Region region) { @@ -273,7 +273,7 @@ internal void InvalidateAdornerWindow(Region region) } /// - /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. + /// Invalidates the transparent AdornerWindow by asking the Designer Frame beneath it to invalidate. Note the they use of the .Update() call for perf. purposes. /// internal void InvalidateAdornerWindow(Rectangle rectangle) { @@ -285,7 +285,7 @@ internal void InvalidateAdornerWindow(Rectangle rectangle) } /// - /// The AdornerWindow intercepts all designer-related messages and forwards them to the BehaviorService for appropriate actions. Note that Paint and HitTest messages are correctly parsed and translated to AdornerWindow coords. + /// The AdornerWindow intercepts all designer-related messages and forwards them to the BehaviorService for appropriate actions. Note that Paint and HitTest messages are correctly parsed and translated to AdornerWindow coords. /// protected override void WndProc(ref Message m) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesigner.cs index 3d09e0d7f87..0c24c3cb9f2 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesigner.cs @@ -16,7 +16,7 @@ namespace System.Windows.Forms.Design { /// - /// Designer for the ToolStrip class. + /// Designer for the ToolStrip class. /// internal class ToolStripDesigner : ControlDesigner { @@ -60,7 +60,7 @@ internal class ToolStripDesigner : ControlDesigner private bool _addingDummyItem = false; //When the dummyItem is added the toolStrip might resize (as in the Vertival Layouts). In this case we dont want the Resize to cause SyncSelection and Layouts. /// - /// Adds designer actions to the ActionLists collection. + /// Adds designer actions to the ActionLists collection. /// public override DesignerActionListCollection ActionLists { @@ -87,7 +87,7 @@ public override DesignerActionListCollection ActionLists } /// - /// Compute the rect for the "Add New Item" button. + /// Compute the rect for the "Add New Item" button. /// private Rectangle AddItemRect { @@ -104,7 +104,7 @@ private Rectangle AddItemRect } /// - /// Accessor for Shadow Property for AllowDrop. + /// Accessor for Shadow Property for AllowDrop. /// private bool AllowDrop { @@ -120,7 +120,7 @@ private bool AllowDrop } /// - /// Accessor for Shadow Property for AllowItemReorder. + /// Accessor for Shadow Property for AllowItemReorder. /// private bool AllowItemReorder { @@ -136,7 +136,7 @@ private bool AllowItemReorder } /// - /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. + /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. /// public override System.Collections.ICollection AssociatedComponents { @@ -155,7 +155,7 @@ public override System.Collections.ICollection AssociatedComponents } /// - /// CacheItems is set to TRUE by the ToolStripMenuItemDesigner, when the Transaction of setting the DropDown property is undone. In this case the Undo adds the original items to the Main MenustripDesigners Items collection and later are moved to to the appropriate ToolStripMenuItem + /// CacheItems is set to TRUE by the ToolStripMenuItemDesigner, when the Transaction of setting the DropDown property is undone. In this case the Undo adds the original items to the Main MenustripDesigners Items collection and later are moved to to the appropriate ToolStripMenuItem /// public bool CacheItems { @@ -164,7 +164,7 @@ public bool CacheItems } /// - /// False if were inherited and can't be modified. + /// False if were inherited and can't be modified. /// private bool CanAddItems { @@ -196,7 +196,7 @@ internal override bool ControlSupportsSnaplines } /// - /// DesignerContextMenu that is shown on the ToolStrip/MenuStrip/StatusStrip. + /// DesignerContextMenu that is shown on the ToolStrip/MenuStrip/StatusStrip. /// private ContextMenuStrip DesignerContextMenu { @@ -214,7 +214,7 @@ private ContextMenuStrip DesignerContextMenu } /// - /// Used by ToolStripTemplateNode. When the ToolStrip gains selection the Overflow is closed. But when an item is added through the TemplateNode which itself is on the Overflow, we should not close the Overflow as this caused weird artifacts and flicker. Hence this boolean property. + /// Used by ToolStripTemplateNode. When the ToolStrip gains selection the Overflow is closed. But when an item is added through the TemplateNode which itself is on the Overflow, we should not close the Overflow as this caused weird artifacts and flicker. Hence this boolean property. /// public bool DontCloseOverflow { @@ -223,7 +223,7 @@ public bool DontCloseOverflow } /// - /// Since the Itemglyphs are recreated on the SelectionChanged, we need to cache in the "MouseDown" while the item Drag-Drop operation. + /// Since the Itemglyphs are recreated on the SelectionChanged, we need to cache in the "MouseDown" while the item Drag-Drop operation. /// public Rectangle DragBoxFromMouseDown { @@ -232,7 +232,7 @@ public Rectangle DragBoxFromMouseDown } /// - /// Set by the ToolStripItemCollectionEditor when it's launched for this ToolStrip so we won't pick up it's items when added. We count this so that we can deal with nestings. + /// Set by the ToolStripItemCollectionEditor when it's launched for this ToolStrip so we won't pick up it's items when added. We count this so that we can deal with nestings. /// internal bool EditingCollection { @@ -252,7 +252,7 @@ internal bool EditingCollection } /// - /// EditManager for the ToolStrip Designer. This EditorManager controls the Insitu Editing. + /// EditManager for the ToolStrip Designer. This EditorManager controls the Insitu Editing. /// public ToolStripEditorManager EditManager { @@ -260,7 +260,7 @@ public ToolStripEditorManager EditManager } /// - /// The TemplateNode. This is the object that actually creates miniToolStrip and manages InSitu editing. + /// The TemplateNode. This is the object that actually creates miniToolStrip and manages InSitu editing. /// internal ToolStripTemplateNode Editor { @@ -268,7 +268,7 @@ internal ToolStripTemplateNode Editor } /// - /// This is the ToolStripControlHost that hosts the ToolStripTemplateNode's miniToolStrip. + /// This is the ToolStripControlHost that hosts the ToolStripTemplateNode's miniToolStrip. /// public DesignerToolStripControlHost EditorNode { @@ -276,7 +276,7 @@ public DesignerToolStripControlHost EditorNode } /// - /// This is the ToolStripTemplateNode's miniToolStrip. + /// This is the ToolStripTemplateNode's miniToolStrip. /// internal ToolStrip EditorToolStrip { @@ -290,7 +290,7 @@ internal ToolStrip EditorToolStrip } /// - /// This will be set through ToolStripItemDesigner.SetItemVisible( ) if we find there is atleast one time that toggled from Visible==false to Visible==true In such a case we need to call BehaviorService.SyncSelection( ) toupdate the glyphs. + /// This will be set through ToolStripItemDesigner.SetItemVisible( ) if we find there is atleast one time that toggled from Visible==false to Visible==true In such a case we need to call BehaviorService.SyncSelection( ) toupdate the glyphs. /// public bool FireSyncSelection { @@ -299,7 +299,7 @@ public bool FireSyncSelection } /// - /// Since the Itemglyphs are recreated on the SelectionChanged, we need to cache in the "index" of last MouseDown while the item Drag-Drop operation. + /// Since the Itemglyphs are recreated on the SelectionChanged, we need to cache in the "index" of last MouseDown while the item Drag-Drop operation. /// public int IndexOfItemUnderMouseToDrag { @@ -308,7 +308,7 @@ public int IndexOfItemUnderMouseToDrag } /// - /// ToolStrips if inherited act as ReadOnly. + /// ToolStrips if inherited act as ReadOnly. /// protected override InheritanceAttribute InheritanceAttribute { @@ -323,7 +323,7 @@ protected override InheritanceAttribute InheritanceAttribute } /// - /// This is the insert Transaction. Now insert can happen at Main Menu level or the DropDown Level. This transaction is used to keep both in sync. + /// This is the insert Transaction. Now insert can happen at Main Menu level or the DropDown Level. This transaction is used to keep both in sync. /// public DesignerTransaction InsertTansaction { @@ -332,7 +332,7 @@ public DesignerTransaction InsertTansaction } /// - /// Checks if there is a seleciton of the ToolStrip or one of it's items. + /// Checks if there is a seleciton of the ToolStrip or one of it's items. /// private bool IsToolStripOrItemSelected { @@ -340,7 +340,7 @@ private bool IsToolStripOrItemSelected } /// - /// CacheItems is set to TRUE by the ToolStripMenuItemDesigner, when the Transaction of setting the DropDown property is undone. In this case the Undo adds the original items to the Main MenustripDesigners Items collection and later are moved to to the appropriate ToolStripMenuItem. This is the Items Collection. + /// CacheItems is set to TRUE by the ToolStripMenuItemDesigner, when the Transaction of setting the DropDown property is undone. In this case the Undo adds the original items to the Main MenustripDesigners Items collection and later are moved to to the appropriate ToolStripMenuItem. This is the Items Collection. /// public ArrayList Items { @@ -355,7 +355,7 @@ public ArrayList Items } /// - /// This is the new item Transaction. This is used when the Insitu editor adds new Item. + /// This is the new item Transaction. This is used when the Insitu editor adds new Item. /// public DesignerTransaction NewItemTransaction { @@ -364,7 +364,7 @@ public DesignerTransaction NewItemTransaction } /// - /// Compute the rect for the "OverFlow" button. + /// Compute the rect for the "OverFlow" button. /// private Rectangle OverFlowButtonRect { @@ -383,7 +383,7 @@ private Rectangle OverFlowButtonRect } /// - /// Get and cache the selection service + /// Get and cache the selection service /// internal ISelectionService SelectionService { @@ -411,7 +411,7 @@ public bool SupportEditing } /// - /// Handy way of gettting our ToolStrip + /// Handy way of gettting our ToolStrip /// protected ToolStrip ToolStrip { @@ -419,7 +419,7 @@ protected ToolStrip ToolStrip } /// - /// Get and cache the toolStripKeyBoard service + /// Get and cache the toolStripKeyBoard service /// private ToolStripKeyboardHandlingService KeyboardHandlingService { @@ -439,7 +439,7 @@ private ToolStripKeyboardHandlingService KeyboardHandlingService } /// - /// There are certain containers (like ToolStrip) that require PerformLayout to be serialized in the code gen. + /// There are certain containers (like ToolStrip) that require PerformLayout to be serialized in the code gen. /// internal override bool SerializePerformLayout { @@ -447,7 +447,7 @@ internal override bool SerializePerformLayout } /// - /// Un - ShadowProperty. + /// Un - ShadowProperty. /// internal bool Visible { @@ -464,7 +464,7 @@ internal bool Visible } /// - /// This will add BodyGlyphs for the Items on the OverFlow. Since ToolStripItems are component we have to manage Adding and Deleting the glyphs ourSelves. + /// This will add BodyGlyphs for the Items on the OverFlow. Since ToolStripItems are component we have to manage Adding and Deleting the glyphs ourSelves. /// private void AddBodyGlyphsForOverflow() { @@ -484,7 +484,7 @@ private void AddBodyGlyphsForOverflow() } /// - /// This will add BodyGlyphs for the Items on the OverFlow. Since ToolStripItems are component we have to manage Adding and Deleting the glyphs ourSelves. Called by AddBodyGlyphsForOverflow() + /// This will add BodyGlyphs for the Items on the OverFlow. Since ToolStripItems are component we have to manage Adding and Deleting the glyphs ourSelves. Called by AddBodyGlyphsForOverflow() /// private void AddItemBodyGlyph(ToolStripItem item) { @@ -509,7 +509,7 @@ private void AddItemBodyGlyph(ToolStripItem item) } /// - /// Fired when a new item is chosen from the AddItems menu from the Template Node. + /// Fired when a new item is chosen from the AddItems menu from the Template Node. /// private ToolStripItem AddNewItem(Type t) { @@ -890,7 +890,7 @@ internal bool Commit() } /// - /// Make sure the AddNewItem button is setup properly. + /// Make sure the AddNewItem button is setup properly. /// private void Control_HandleCreated(object sender, EventArgs e) { @@ -898,7 +898,7 @@ private void Control_HandleCreated(object sender, EventArgs e) } /// - /// Fired after a component has been added. Here, we add it to the ToolStrip and select it. + /// Fired after a component has been added. Here, we add it to the ToolStrip and select it. /// private void ComponentChangeSvc_ComponentAdded(object sender, ComponentEventArgs e) { @@ -973,7 +973,7 @@ private void ComponentChangeSvc_ComponentAdded(object sender, ComponentEventArgs } /// - /// Checks if the component being added is a child ToolStripItem. + /// Checks if the component being added is a child ToolStripItem. /// private void ComponentChangeSvc_ComponentAdding(object sender, ComponentEventArgs e) { @@ -1019,7 +1019,7 @@ private void ComponentChangeSvc_ComponentAdding(object sender, ComponentEventArg } /// - /// Required to check if we need to show the Overflow, if any change has caused the item to go into the overflow. + /// Required to check if we need to show the Overflow, if any change has caused the item to go into the overflow. /// private void ComponentChangeSvc_ComponentChanged(object sender, ComponentChangedEventArgs e) { @@ -1043,7 +1043,7 @@ private void ComponentChangeSvc_ComponentChanged(object sender, ComponentChanged } /// - /// After a ToolStripItem is removed, remove it from the ToolStrip and select the next item. + /// After a ToolStripItem is removed, remove it from the ToolStrip and select the next item. /// private void ComponentChangeSvc_ComponentRemoved(object sender, ComponentEventArgs e) { @@ -1120,7 +1120,7 @@ private void ComponentChangeSvc_ComponentRemoved(object sender, ComponentEventAr } /// - /// Before a ToolStripItem is removed, open a transaction to batch the operation. + /// Before a ToolStripItem is removed, open a transaction to batch the operation. /// private void ComponentChangeSvc_ComponentRemoving(object sender, ComponentEventArgs e) { @@ -1150,7 +1150,7 @@ private void ComponentChangeSvc_ComponentRemoving(object sender, ComponentEventA } /// - /// Clean up the mess we've made! + /// Clean up the mess we've made! /// protected override void Dispose(bool disposing) { @@ -1219,7 +1219,7 @@ protected override void Dispose(bool disposing) } /// - /// Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location in preparation to assign the default action. + /// Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location in preparation to assign the default action. /// public override void DoDefaultAction() { @@ -1253,7 +1253,7 @@ public override void DoDefaultAction() } /// - /// We add our BodyGlyphs as well as bodyGlyphs for the ToolStripItems here. + /// We add our BodyGlyphs as well as bodyGlyphs for the ToolStripItems here. /// protected override ControlBodyGlyph GetControlGlyph(GlyphSelectionType selectionType) { @@ -1339,7 +1339,7 @@ protected override ControlBodyGlyph GetControlGlyph(GlyphSelectionType selection } /// - /// We add our SelectionGlyphs here. Since ToolStripItems are components we add the SelectionGlyphs for those in this call as well. + /// We add our SelectionGlyphs here. Since ToolStripItems are components we add the SelectionGlyphs for those in this call as well. /// public override GlyphCollection GetGlyphs(GlyphSelectionType selType) { @@ -1386,7 +1386,7 @@ public override GlyphCollection GetGlyphs(GlyphSelectionType selType) } /// - /// Allow hit testing over the AddNewItem button only. + /// Allow hit testing over the AddNewItem button only. /// protected override bool GetHitTest(Point point) { @@ -1406,7 +1406,7 @@ protected override bool GetHitTest(Point point) } /// - /// Get the designer set up to run. + /// Get the designer set up to run. /// // EditorServiceContext is newed up to add Edit Items verb. public override void Initialize(IComponent component) @@ -1462,7 +1462,7 @@ public override void Initialize(IComponent component) } /// - /// ControlDesigner overrides this method. It will look at the default property for the control and, if it is of type string, it will set this property's value to the name of the component. It only does this if the designer has been configured with this option in the options service. This method also connects the control to its parent and positions it. If you override this method, you should always call base. + /// ControlDesigner overrides this method. It will look at the default property for the control and, if it is of type string, it will set this property's value to the name of the component. It only does this if the designer has been configured with this option in the options service. This method also connects the control to its parent and positions it. If you override this method, you should always call base. /// public override void InitializeNewComponent(IDictionary defaultValues) { @@ -1493,7 +1493,7 @@ public override void InitializeNewComponent(IDictionary defaultValues) } } - /// set up parenting and all the base stuff... + /// set up parenting and all the base stuff... if (parentPanel == null || ToolStrip is MenuStrip) { base.InitializeNewComponent(defaultValues); @@ -1594,7 +1594,7 @@ public override void InitializeNewComponent(IDictionary defaultValues) } /// - /// Setup the "AddNewItem" button + /// Setup the "AddNewItem" button /// private void InitializeNewItemDropDown() { @@ -1609,7 +1609,7 @@ private void InitializeNewItemDropDown() } /// - /// This is called to ascertain if the Glyph is totally visible. This is called from ToolStripMenuItemDesigner too. + /// This is called to ascertain if the Glyph is totally visible. This is called from ToolStripMenuItemDesigner too. /// internal static bool IsGlyphTotallyVisible(Rectangle itemBounds, Rectangle parentBounds) { @@ -1617,7 +1617,7 @@ internal static bool IsGlyphTotallyVisible(Rectangle itemBounds, Rectangle paren } /// - /// Returns true if the item is on the overflow. + /// Returns true if the item is on the overflow. /// private bool ItemParentIsOverflow(ToolStripItem item) { @@ -1641,7 +1641,7 @@ private bool ItemParentIsOverflow(ToolStripItem item) } /// - /// Sets up the add new button, and invalidates the behavior glyphs if needed so they always stay in sync. + /// Sets up the add new button, and invalidates the behavior glyphs if needed so they always stay in sync. /// private void LayoutToolStrip() { @@ -1667,7 +1667,7 @@ internal static string NameFromText(string text, Type componentType, IServicePro } /// - /// Computes a name from a text label by removing all spaces and non-alphanumeric characters. + /// Computes a name from a text label by removing all spaces and non-alphanumeric characters. /// internal static string NameFromText(string text, Type componentType, IServiceProvider serviceProvider) { @@ -1781,7 +1781,7 @@ internal static string NameFromText(string text, Type componentType, IServicePro } /// - /// DesignerContextMenu should be shown when the ToolStripDesigner. + /// DesignerContextMenu should be shown when the ToolStripDesigner. /// protected override void OnContextMenu(int x, int y) { @@ -1805,7 +1805,7 @@ protected override void OnDragOver(DragEventArgs de) } /// - /// Add item on Drop and it its a MenuItem, open its dropDown. + /// Add item on Drop and it its a MenuItem, open its dropDown. /// protected override void OnDragDrop(DragEventArgs de) { @@ -1961,7 +1961,7 @@ protected override void OnDragDrop(DragEventArgs de) } /// - /// Everytime we add Item .. the TemplateNode needs to go at the end if its not there. + /// Everytime we add Item .. the TemplateNode needs to go at the end if its not there. /// private void OnItemAdded(object sender, ToolStripItemEventArgs e) { @@ -1980,7 +1980,7 @@ private void OnItemAdded(object sender, ToolStripItemEventArgs e) } /// - /// Overriden so that the ToolStrip honors dragging only through container selector glyph. + /// Overriden so that the ToolStrip honors dragging only through container selector glyph. /// protected override void OnMouseDragMove(int x, int y) { @@ -1991,7 +1991,7 @@ protected override void OnMouseDragMove(int x, int y) } /// - /// Controls the dismissal of the drop down, here - we just cancel it + /// Controls the dismissal of the drop down, here - we just cancel it /// private void OnOverflowDropDownClosing(object sender, ToolStripDropDownClosingEventArgs e) { @@ -2000,7 +2000,7 @@ private void OnOverflowDropDownClosing(object sender, ToolStripDropDownClosingEv } /// - /// Remove the Glyphs for Items on the overflow when the Overflow closes. + /// Remove the Glyphs for Items on the overflow when the Overflow closes. /// private void OnOverFlowDropDownClosed(object sender, EventArgs e) { @@ -2021,7 +2021,7 @@ private void OnOverFlowDropDownClosed(object sender, EventArgs e) } /// - /// Add Glyphs when the OverFlow opens .... + /// Add Glyphs when the OverFlow opens .... /// private void OnOverFlowDropDownOpened(object sender, EventArgs e) { @@ -2051,7 +2051,7 @@ private void OnOverFlowDropDownOpened(object sender, EventArgs e) } /// - /// In Order to Draw the Selection Glyphs we need to reforce painting on the the AdonerWindow.This method forces the repaint + /// In Order to Draw the Selection Glyphs we need to reforce painting on the the AdonerWindow.This method forces the repaint /// private void OnOverFlowDropDownPaint(object sender, System.Windows.Forms.PaintEventArgs e) { @@ -2077,7 +2077,7 @@ private void OnOverFlowDropDownPaint(object sender, System.Windows.Forms.PaintEv } /// - /// Change the parent of the overFlow so that it is parented to the ToolStripAdornerWindow + /// Change the parent of the overFlow so that it is parented to the ToolStripAdornerWindow /// private void OnOverFlowDropDownOpening(object sender, EventArgs e) { @@ -2096,7 +2096,7 @@ private void OnOverFlowDropDownOpening(object sender, EventArgs e) } /// - /// When Items change the size, Recalculate the glyph sizes. + /// When Items change the size, Recalculate the glyph sizes. /// private void OnOverflowDropDownResize(object sender, EventArgs e) { @@ -2115,7 +2115,7 @@ private void OnOverflowDropDownResize(object sender, EventArgs e) } /// - /// Set proper cursor + /// Set proper cursor /// protected override void OnSetCursor() { @@ -2131,11 +2131,11 @@ protected override void OnSetCursor() } /// - /// ResumeLayout after Undone. + /// ResumeLayout after Undone. /// private void OnUndone(object source, EventArgs e) { - /// IMPORTANT : The Undo Unit .. Clears of the ITems.... + /// IMPORTANT : The Undo Unit .. Clears of the ITems.... if (_editorNode != null && (ToolStrip.Items.IndexOf(_editorNode) == -1)) { ToolStrip.Items.Add(_editorNode); @@ -2160,7 +2160,7 @@ private void OnUndone(object source, EventArgs e) } /// - /// SuspendLayout before unDoing. + /// SuspendLayout before unDoing. /// private void OnUndoing(object source, EventArgs e) { @@ -2172,7 +2172,7 @@ private void OnUndoing(object source, EventArgs e) } /// - /// SyncSelection on ToolStrip move. + /// SyncSelection on ToolStrip move. /// private void OnToolStripMove(object sender, System.EventArgs e) { @@ -2183,7 +2183,7 @@ private void OnToolStripMove(object sender, System.EventArgs e) } /// - /// Remove all the glyphs we were are not visible.. + /// Remove all the glyphs we were are not visible.. /// private void OnToolStripVisibleChanged(object sender, System.EventArgs e) { @@ -2204,7 +2204,7 @@ private void OnToolStripVisibleChanged(object sender, System.EventArgs e) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -2227,7 +2227,7 @@ protected override void PreFilterProperties(IDictionary properties) } /// - /// Remove the glyphs for individual items on the DropDown. + /// Remove the glyphs for individual items on the DropDown. /// private void RemoveBodyGlyphsForOverflow() { @@ -2276,7 +2276,7 @@ private void ResetVisible() } /// - /// When the Drag Data does not contain ToolStripItem; change the dragEffect to None; This will result current cursor to change into NO-SMOKING cursor + /// When the Drag Data does not contain ToolStripItem; change the dragEffect to None; This will result current cursor to change into NO-SMOKING cursor /// private void SetDragDropEffects(DragEventArgs de) { @@ -2294,7 +2294,7 @@ private void SetDragDropEffects(DragEventArgs de) } /// - /// When selection changes to the ToolStrip, show the "AddItemsButton", when it leaves, hide it. + /// When selection changes to the ToolStrip, show the "AddItemsButton", when it leaves, hide it. /// private void SelSvc_SelectionChanging(object sender, EventArgs e) { @@ -2333,7 +2333,7 @@ private void SelSvc_SelectionChanging(object sender, EventArgs e) } /// - /// When selection changes to the ToolStrip, show the "AddItemsButton", when it leaves, hide it. + /// When selection changes to the ToolStrip, show the "AddItemsButton", when it leaves, hide it. /// private void SelSvc_SelectionChanged(object sender, EventArgs e) { @@ -2496,7 +2496,7 @@ private void ToolStrip_LayoutCompleted(object sender, EventArgs e) } /// - /// Make sure the AddItem button stays in the right spot. + /// Make sure the AddItem button stays in the right spot. /// private void ToolStrip_Resize(object sender, EventArgs e) { @@ -2511,7 +2511,7 @@ private void ToolStrip_Resize(object sender, EventArgs e) } /// - /// Handle lower level mouse input. + /// Handle lower level mouse input. /// protected override void WndProc(ref Message m) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesignerUtils.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesignerUtils.cs index 004efa5fe68..fad5986cfc3 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesignerUtils.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDesignerUtils.cs @@ -79,9 +79,9 @@ public static void GetAdjustedBounds(ToolStripItem item, ref Rectangle r) } /// - /// If IComponent is ToolStrip return ToolStrip - /// If IComponent is ToolStripItem return the Owner ToolStrip - /// If IComponent is ToolStripDropDownItem return the child DropDown ToolStrip + /// If IComponent is ToolStrip return ToolStrip + /// If IComponent is ToolStripItem return the Owner ToolStrip + /// If IComponent is ToolStripDropDownItem return the child DropDown ToolStrip /// private static ToolStrip GetToolStripFromComponent(IComponent component) { @@ -168,7 +168,7 @@ public static Bitmap GetToolboxBitmap(Type itemType) } /// - /// Fishes out the display name attribute from the Toolbox item if not present, uses Type.Name + /// Fishes out the display name attribute from the Toolbox item if not present, uses Type.Name /// public static string GetToolboxDescription(Type itemType) { @@ -190,7 +190,7 @@ public static string GetToolboxDescription(Type itemType) } /// - /// The first item returned should be the DefaultItem to create on the ToolStrip + /// The first item returned should be the DefaultItem to create on the ToolStrip /// public static Type[] GetStandardItemTypes(IComponent component) { @@ -314,7 +314,7 @@ public static Type[] GetCustomItemTypes(IComponent component, ITypeDiscoveryServ } /// - /// wraps the result of GetStandardItemTypes in ItemTypeToolStripMenuItems. + /// wraps the result of GetStandardItemTypes in ItemTypeToolStripMenuItems. /// public static ToolStripItem[] GetStandardItemMenuItems(IComponent component, EventHandler onClick, bool convertTo) { @@ -336,7 +336,7 @@ public static ToolStripItem[] GetStandardItemMenuItems(IComponent component, Eve } /// - /// wraps the result of GetCustomItemTypes in ItemTypeToolStripMenuItems. + /// wraps the result of GetCustomItemTypes in ItemTypeToolStripMenuItems. /// public static ToolStripItem[] GetCustomItemMenuItems(IComponent component, EventHandler onClick, bool convertTo, IServiceProvider serviceProvider) { @@ -358,7 +358,7 @@ public static ToolStripItem[] GetCustomItemMenuItems(IComponent component, Event } /// - /// build up a list of standard items separated by the custom items + /// build up a list of standard items separated by the custom items /// public static NewItemsContextMenuStrip GetNewItemDropDown(IComponent component, ToolStripItem currentItem, EventHandler onClick, bool convertTo, IServiceProvider serviceProvider, bool populateCustom) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownDesigner.cs index 3665d6dc2fd..610752578d1 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownDesigner.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms.Design { /// - /// Designer for ToolStripDropDowns...just provides the Edit... verb. + /// Designer for ToolStripDropDowns...just provides the Edit... verb. /// internal class ToolStripDropDownDesigner : ComponentDesigner { @@ -33,7 +33,7 @@ internal class ToolStripDropDownDesigner : ComponentDesigner private UndoEngine undoEngine = null; /// - /// ShadowProperty. + /// ShadowProperty. /// private bool AutoClose { @@ -48,7 +48,7 @@ private bool AllowDrop } /// - /// Adds designer actions to the ActionLists collection. + /// Adds designer actions to the ActionLists collection. /// public override DesignerActionListCollection ActionLists { @@ -74,7 +74,7 @@ public override DesignerActionListCollection ActionLists } /// - /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. + /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. /// public override System.Collections.ICollection AssociatedComponents { @@ -88,8 +88,8 @@ public ToolStripMenuItem DesignerMenuItem } /// - /// Set by the ToolStripItemCollectionEditor when it's launched for this The Items property doesnt open another instance - /// of collectioneditor. We count this so that we can deal with nestings. + /// Set by the ToolStripItemCollectionEditor when it's launched for this The Items property doesnt open another instance + /// of collectioneditor. We count this so that we can deal with nestings. /// internal bool EditingCollection { @@ -121,7 +121,7 @@ protected override InheritanceAttribute InheritanceAttribute } /// - /// Prefilter this property so that we can set the right To Left on the Design Menu... + /// Prefilter this property so that we can set the right To Left on the Design Menu... /// private RightToLeft RightToLeft { @@ -156,7 +156,7 @@ private RightToLeft RightToLeft } /// - /// shadowing the SettingsKey so we can default it to be RootComponent.Name + "." + Control.Name + /// shadowing the SettingsKey so we can default it to be RootComponent.Name + "." + Control.Name /// private string SettingsKey { @@ -230,7 +230,7 @@ internal void AddSelectionGlyphs() } /// - /// Disposes of this designer. + /// Disposes of this designer. /// protected override void Dispose(bool disposing) { @@ -262,7 +262,7 @@ protected override void Dispose(bool disposing) } /// - /// Disposes of this dummy menuItem and its designer.. + /// Disposes of this dummy menuItem and its designer.. /// private void DisposeMenu() { @@ -347,7 +347,7 @@ private void HideMenu() } /// - /// Initialize the item. + /// Initialize the item. /// // EditorServiceContext is newed up to add Edit Items verb. public override void Initialize(IComponent component) @@ -499,7 +499,7 @@ private bool IsContextMenuStripItemSelected(ISelectionService selectionService) } /// - /// Listens SelectionChanging to Show the MenuDesigner. + /// Listens SelectionChanging to Show the MenuDesigner. /// private void OnSelectionChanging(object sender, EventArgs e) { @@ -513,7 +513,7 @@ private void OnSelectionChanging(object sender, EventArgs e) } /// - /// Listens SelectionChanged to Show the MenuDesigner. + /// Listens SelectionChanged to Show the MenuDesigner. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -557,7 +557,7 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -625,7 +625,7 @@ private void ResetRightToLeft() } /// - /// Show the MenuDesigner; used by ToolStripmenuItemdesigner to show the menu when the user selects the dropDown item through the PG or Document outline. The editor node will be selected by default. + /// Show the MenuDesigner; used by ToolStripmenuItemdesigner to show the menu when the user selects the dropDown item through the PG or Document outline. The editor node will be selected by default. /// public void ShowMenu() { @@ -641,7 +641,7 @@ public void ShowMenu() } /// - /// Show the MenuDesigner; used by ToolStripmenuItemdesigner to show the menu when the user selects the dropDown item through the PG or Document outline. The input toolstrip item will be selected. + /// Show the MenuDesigner; used by ToolStripmenuItemdesigner to show the menu when the user selects the dropDown item through the PG or Document outline. The input toolstrip item will be selected. /// public void ShowMenu(ToolStripItem selectedItem) { @@ -746,7 +746,7 @@ public void ShowMenu(ToolStripItem selectedItem) private bool ShouldSerializeRightToLeft() => RightToLeft != RightToLeft.No; /// - /// ResumeLayout after Undone. + /// ResumeLayout after Undone. /// private void OnUndone(object source, EventArgs e) { @@ -758,7 +758,7 @@ private void OnUndone(object source, EventArgs e) } /// - /// This is an internal class which provides the Behavior for our MenuStrip Body Glyph. This will just eat the MouseUps... + /// This is an internal class which provides the Behavior for our MenuStrip Body Glyph. This will just eat the MouseUps... /// internal class ContextMenuStripBehavior : System.Windows.Forms.Design.Behavior.Behavior { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownItemDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownItemDesigner.cs index 000a4254095..26108e5a1c6 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownItemDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripDropDownItemDesigner.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms.Design { /// - /// Designer for ToolStripDropDownItems. This is here so only the dropdown items get the "Edit Items..." verb. + /// Designer for ToolStripDropDownItems. This is here so only the dropdown items get the "Edit Items..." verb. /// internal class ToolStripDropDownItemDesigner : ToolStripItemDesigner { /// - /// Initialize the item. + /// Initialize the item. /// public override void Initialize(IComponent component) { @@ -20,7 +20,7 @@ public override void Initialize(IComponent component) } /// - /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. + /// The ToolStripItems are the associated components. We want those to come with in any cut, copy opreations. /// public override System.Collections.ICollection AssociatedComponents { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripEditorManager.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripEditorManager.cs index c92255cfc8d..fd9cbbf0c8e 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripEditorManager.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripEditorManager.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// This internal Class is used by all TOPLEVEL ToolStripItems to show the InSitu Editor. When the ToolStripItem receives the MouseDown on its Glyph it calls the "ActivateEditor" Function on this EditorManager. The ActivateEditor Function checks for any existing "EDITOR" active, closes that down and now opens the new editor on the "AdornerWindow". This class is also responsible for "hookingup" to the F2 Command on VS. + /// This internal Class is used by all TOPLEVEL ToolStripItems to show the InSitu Editor. When the ToolStripItem receives the MouseDown on its Glyph it calls the "ActivateEditor" Function on this EditorManager. The ActivateEditor Function checks for any existing "EDITOR" active, closes that down and now opens the new editor on the "AdornerWindow". This class is also responsible for "hookingup" to the F2 Command on VS. /// internal class ToolStripEditorManager { @@ -41,7 +41,7 @@ public ToolStripEditorManager(IComponent comp) } /// - /// Activates the editor for the given item.If there's still an editor around for the previous-edited item, it is deactivated. Pass in 'null' to deactivate and remove the current editor, if any. + /// Activates the editor for the given item.If there's still an editor around for the previous-edited item, it is deactivated. Pass in 'null' to deactivate and remove the current editor, if any. /// internal void ActivateEditor(ToolStripItem item, bool clicked) { @@ -91,14 +91,14 @@ internal void ActivateEditor(ToolStripItem item, bool clicked) } /// - /// This will remove the Command for F2. + /// This will remove the Command for F2. /// internal void CloseManager() { } /// - /// This LISTENs to the Editor Resize for resizing the Insitu edit on the Adorner Window ... CURRENTLY DISABLED. + /// This LISTENs to the Editor Resize for resizing the Insitu edit on the Adorner Window ... CURRENTLY DISABLED. /// private void OnEditorResize(object sender, EventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripInSituService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripInSituService.cs index 95e8a37026a..d68f22762fe 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripInSituService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripInSituService.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.Design { /// - /// This class implements the ISupportInSituService which enables some designers to go into InSitu Editing when Keys are pressed while the Component is Selected. + /// This class implements the ISupportInSituService which enables some designers to go into InSitu Editing when Keys are pressed while the Component is Selected. /// internal class ToolStripInSituService : ISupportInSituService, IDisposable { @@ -21,7 +21,7 @@ internal class ToolStripInSituService : ISupportInSituService, IDisposable private ToolStripKeyboardHandlingService _toolStripKeyBoardService; /// - /// The constructor for this class which takes the serviceprovider used to get the selectionservice. This ToolStripInSituService is ToolStrip specific. + /// The constructor for this class which takes the serviceprovider used to get the selectionservice. This ToolStripInSituService is ToolStrip specific. /// public ToolStripInSituService(IServiceProvider provider) { @@ -41,7 +41,7 @@ public ToolStripInSituService(IServiceProvider provider) } /// - /// Disposes of this object, removing all commands from the menu service. + /// Disposes of this object, removing all commands from the menu service. /// public void Dispose() { @@ -75,7 +75,7 @@ private ToolStripKeyboardHandlingService ToolStripKeyBoardService } /// - /// Returning true for IgnoreMessages means that this service is interested in getting the KeyBoard characters. + /// Returning true for IgnoreMessages means that this service is interested in getting the KeyBoard characters. /// public bool IgnoreMessages { @@ -166,7 +166,7 @@ public bool IgnoreMessages } /// - /// This function is called on the service when the PBRSFORWARD gets the first WM_CHAR message. + /// This function is called on the service when the PBRSFORWARD gets the first WM_CHAR message. /// public void HandleKeyChar() { @@ -208,7 +208,7 @@ public void HandleKeyChar() } /// - /// This function returns the Window handle that should get all the Keyboard messages. + /// This function returns the Window handle that should get all the Keyboard messages. /// public IntPtr GetEditWindow() { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemBehavior.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemBehavior.cs index f55b6b6ad51..63fee437d26 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemBehavior.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemBehavior.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms.Design { /// - /// The behavior for the glpyh that covers the items themselves. This selects the items when they are clicked, and will (when implemented) do the dragging/reordering of them. + /// The behavior for the glpyh that covers the items themselves. This selects the items when they are clicked, and will (when implemented) do the dragging/reordering of them. /// internal class ToolStripItemBehavior : Behavior.Behavior { @@ -55,7 +55,7 @@ private bool CommonParent(ToolStripItem oldSelection, ToolStripItem newSelection } /// - /// Clears the insertion mark when items are being reordered + /// Clears the insertion mark when items are being reordered /// private void ClearInsertionMark(ToolStripItem item) { @@ -446,7 +446,7 @@ public override bool OnMouseDown(Glyph g, MouseButtons button, Point mouseLoc) } /// - /// Overriden to paint the border on mouse enter..... + /// Overriden to paint the border on mouse enter..... /// public override bool OnMouseEnter(Glyph g) { @@ -471,7 +471,7 @@ public override bool OnMouseEnter(Glyph g) } /// - /// overriden to "clear" the boundary-paint when the mouse leave the item + /// overriden to "clear" the boundary-paint when the mouse leave the item /// public override bool OnMouseLeave(Glyph g) { @@ -495,7 +495,7 @@ public override bool OnMouseLeave(Glyph g) } /// - /// When any MouseMove message enters the BehaviorService's AdornerWindow (mousemove, ncmousemove) it is first passed here, to the top-most Behavior in the BehaviorStack. Returning 'true' from this function signifies that the Message was 'handled' by the Behavior and should not continue to be processed. + /// When any MouseMove message enters the BehaviorService's AdornerWindow (mousemove, ncmousemove) it is first passed here, to the top-most Behavior in the BehaviorStack. Returning 'true' from this function signifies that the Message was 'handled' by the Behavior and should not continue to be processed. /// public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) { @@ -603,7 +603,7 @@ public override bool OnMouseMove(Glyph g, MouseButtons button, Point mouseLoc) // OLE DragDrop virtual methods /// - /// OnDragDrop can be overridden so that a Behavior can specify its own Drag/Drop rules. + /// OnDragDrop can be overridden so that a Behavior can specify its own Drag/Drop rules. /// public override void OnDragDrop(Glyph g, DragEventArgs e) { @@ -795,7 +795,7 @@ public override void OnDragDrop(Glyph g, DragEventArgs e) } /// - /// OnDragEnter can be overridden so that a Behavior can specify its own Drag/Drop rules. + /// OnDragEnter can be overridden so that a Behavior can specify its own Drag/Drop rules. /// public override void OnDragEnter(Glyph g, DragEventArgs e) { @@ -822,7 +822,7 @@ public override void OnDragEnter(Glyph g, DragEventArgs e) } /// - /// OnDragLeave can be overridden so that a Behavior can specify its own Drag/Drop rules. + /// OnDragLeave can be overridden so that a Behavior can specify its own Drag/Drop rules. /// public override void OnDragLeave(Glyph g, EventArgs e) { @@ -831,7 +831,7 @@ public override void OnDragLeave(Glyph g, EventArgs e) } /// - /// OnDragOver can be overridden so that a Behavior can specify its own Drag/Drop rules. + /// OnDragOver can be overridden so that a Behavior can specify its own Drag/Drop rules. /// public override void OnDragOver(Glyph g, DragEventArgs e) { @@ -850,7 +850,7 @@ public override void OnDragOver(Glyph g, DragEventArgs e) } /// - /// Paints the insertion mark when items are being reordered + /// Paints the insertion mark when items are being reordered /// private void PaintInsertionMark(ToolStripItem item) { @@ -896,7 +896,7 @@ private void PaintInsertionMark(ToolStripItem item) } /// - /// QueryContinueDrag can be overridden so that a Behavior can specify its own Drag/Drop rules. + /// QueryContinueDrag can be overridden so that a Behavior can specify its own Drag/Drop rules. /// private void QueryContinueDrag(object sender, QueryContinueDragEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemCustomMenuItemCollection.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemCustomMenuItemCollection.cs index c69e3b62fdc..4e1526babdd 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemCustomMenuItemCollection.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemCustomMenuItemCollection.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Design { /// - /// Custom ContextMenu section for ToolStripMenuItems. + /// Custom ContextMenu section for ToolStripMenuItems. /// internal class ToolStripItemCustomMenuItemCollection : CustomMenuItemCollection { @@ -54,7 +54,7 @@ public ToolStripItemCustomMenuItemCollection(IServiceProvider provider, Componen } /// - /// Parent ToolStrip. + /// Parent ToolStrip. /// private ToolStrip ParentTool { @@ -62,7 +62,7 @@ private ToolStrip ParentTool } /// - /// creates a item representing an item, respecting Browsable. + /// creates a item representing an item, respecting Browsable. /// private ToolStripMenuItem CreatePropertyBasedItem(string text, string propertyName, string imageName) { @@ -87,7 +87,7 @@ private ToolStripMenuItem CreatePropertyBasedItem(string text, string propertyNa } /// - /// creates an item that when clicked changes the enum value. + /// creates an item that when clicked changes the enum value. /// private ToolStripMenuItem CreateEnumValueItem(string propertyName, string name, object value) { @@ -318,7 +318,7 @@ private void InsertItem(Type t) } /// - /// Insert MenuItem into ToolStrip. + /// Insert MenuItem into ToolStrip. /// private void InsertStripItem(Type t) { @@ -333,7 +333,7 @@ private void InsertStripItem(Type t) } /// - /// Insert MenuItem into ToolStrip. + /// Insert MenuItem into ToolStrip. /// private void InsertMenuItem(Type t) { @@ -363,7 +363,7 @@ private void TryCancelTransaction(ref DesignerTransaction transaction) } /// - /// Insert Item into DropDownMenu. + /// Insert Item into DropDownMenu. /// private void InsertIntoDropDown(ToolStripDropDown parent, Type t) { @@ -431,7 +431,7 @@ private void InsertIntoDropDown(ToolStripDropDown parent, Type t) } /// - /// Insert Item into Main MenuStrip. + /// Insert Item into Main MenuStrip. /// private void InsertIntoMainMenu(MenuStrip parent, Type t) { @@ -476,7 +476,7 @@ private void InsertIntoMainMenu(MenuStrip parent, Type t) } /// - /// Insert Item into StatusStrip. + /// Insert Item into StatusStrip. /// private void InsertIntoStatusStrip(StatusStrip parent, Type t) { @@ -521,7 +521,7 @@ private void InsertIntoStatusStrip(StatusStrip parent, Type t) } /// - /// Insert Item into ToolStrip. + /// Insert Item into ToolStrip. /// private void InsertToolStripItem(Type t) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemDesigner.cs index 8bef446c87f..fcbb1495285 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemDesigner.cs @@ -67,7 +67,7 @@ private string AccessibleName } /// - /// Associated Parent Designer + /// Associated Parent Designer /// internal override bool CanBeAssociatedWith(IDesigner parentDesigner) { @@ -75,7 +75,7 @@ internal override bool CanBeAssociatedWith(IDesigner parentDesigner) } /// - /// Designer Custom ContextMenu. + /// Designer Custom ContextMenu. /// private ContextMenuStrip DesignerContextMenu { @@ -114,7 +114,7 @@ private ContextMenuStrip DesignerContextMenu } /// - /// ToolStripEditorManager used this internal property to Activate the editor. + /// ToolStripEditorManager used this internal property to Activate the editor. /// internal virtual ToolStripTemplateNode Editor { @@ -136,7 +136,7 @@ protected override InheritanceAttribute InheritanceAttribute } /// - /// ToolStripEditorManager used this internal property to set the the desinger's IsEditorActive to notify if this item has entered or exited the InSitu Edit Mode. + /// ToolStripEditorManager used this internal property to set the the desinger's IsEditorActive to notify if this item has entered or exited the InSitu Edit Mode. /// internal bool IsEditorActive { @@ -145,7 +145,7 @@ internal bool IsEditorActive } /// - /// When the ToolStripItem is created we dont want InitializeNewComponent to set the "text" we do it ourselves from the Text the User has provided in the InSitu Edit Mode. Reason being the item and the Parent unnecessarily Layout and cause flicker. + /// When the ToolStripItem is created we dont want InitializeNewComponent to set the "text" we do it ourselves from the Text the User has provided in the InSitu Edit Mode. Reason being the item and the Parent unnecessarily Layout and cause flicker. /// internal bool InternalCreate { @@ -228,7 +228,7 @@ protected override IComponent ParentComponent } /// - /// Easy method for getting to the ToolStripItem + /// Easy method for getting to the ToolStripItem /// public ToolStripItem ToolStripItem { @@ -246,7 +246,7 @@ protected bool Visible } /// - /// This method adds the Parent Hierarchy to arraylist and returns that arraylist to the Base ContextMenu provider. This way the ToolStripItem can show the right parents in the contextMenu + /// This method adds the Parent Hierarchy to arraylist and returns that arraylist to the Base ContextMenu provider. This way the ToolStripItem can show the right parents in the contextMenu /// internal ArrayList AddParentTree() { @@ -309,7 +309,7 @@ internal ArrayList AddParentTree() } /// - /// Creates the InSitu Edit Node (which is called the TemplateNode). + /// Creates the InSitu Edit Node (which is called the TemplateNode). /// private void CreateDummyNode() { @@ -317,7 +317,7 @@ private void CreateDummyNode() } /// - /// This is called by the TemplateNode to Commit the Edit. This Function Simply changes the "Text and Image" property of the current ToolStripItem. + /// This is called by the TemplateNode to Commit the Edit. This Function Simply changes the "Text and Image" property of the current ToolStripItem. /// // Standard 'catch all - rethrow critical' exception pattern internal virtual void CommitEdit(Type type, string text, bool commit, bool enterKeyPressed, bool tabKeyPressed) @@ -462,7 +462,7 @@ internal virtual void CommitEdit(Type type, string text, bool commit, bool enter } /// - /// Disposes of this designer. + /// Disposes of this designer. /// protected override void Dispose(bool disposing) { @@ -515,7 +515,7 @@ protected override void Dispose(bool disposing) } /// - /// Returns the owner of the current ToolStripItem. + /// Returns the owner of the current ToolStripItem. /// protected virtual Component GetOwnerForActionList() => (ToolStripItem.Placement == ToolStripItemPlacement.Main) ? ToolStripItem.GetCurrentParent() : ToolStripItem.Owner; @@ -614,7 +614,7 @@ public void GetGlyphs(ref GlyphCollection glyphs, System.Windows.Forms.Design.Be } /// - /// Returns the root dropdown in the chain. + /// Returns the root dropdown in the chain. /// internal ToolStripDropDown GetFirstDropDown(ToolStripItem currentItem) { @@ -632,7 +632,7 @@ internal ToolStripDropDown GetFirstDropDown(ToolStripItem currentItem) } /// - /// This helper function resets the AutoSize property so that the item SNAPS back to its "preferredSize". + /// This helper function resets the AutoSize property so that the item SNAPS back to its "preferredSize". /// private void HideDummyNode() { @@ -645,7 +645,7 @@ private void HideDummyNode() } /// - /// Get the designer set up to run. + /// Get the designer set up to run. /// public override void Initialize(IComponent component) { @@ -675,7 +675,7 @@ public override void Initialize(IComponent component) } /// - /// Overriden to always Initialise the ToolStripItem with Text property. + /// Overriden to always Initialise the ToolStripItem with Text property. /// public override void InitializeNewComponent(IDictionary defaultValues) { @@ -717,7 +717,7 @@ public override void InitializeNewComponent(IDictionary defaultValues) } /// - /// This will morph the current item to the provided type "t" of the item... + /// This will morph the current item to the provided type "t" of the item... /// internal virtual ToolStripItem MorphCurrentItem(Type t) { @@ -920,7 +920,7 @@ internal virtual ToolStripItem MorphCurrentItem(Type t) } /// - /// Raised when a component's name changes. Here we update the AccessibleName Property to match the newName. + /// Raised when a component's name changes. Here we update the AccessibleName Property to match the newName. /// private void OnComponentRename(object sender, ComponentRenameEventArgs e) { @@ -931,7 +931,7 @@ private void OnComponentRename(object sender, ComponentRenameEventArgs e) } /// - /// This can be used for OVERFLOW !!! + /// This can be used for OVERFLOW !!! /// private void OnItemPaint(object sender, System.Windows.Forms.PaintEventArgs e) { @@ -960,7 +960,7 @@ private void OnItemPaint(object sender, System.Windows.Forms.PaintEventArgs e) } /// - /// For ToolStripItems that are not MenuItems and are on Dropdown we need ot update Selection Rect. + /// For ToolStripItems that are not MenuItems and are on Dropdown we need ot update Selection Rect. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -1063,7 +1063,7 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -1232,7 +1232,7 @@ internal void SetItemVisible(bool toolStripSelected, ToolStripDesigner designer) private bool ShouldSerializeOverflow() => (ShadowProperties["Overflow"] != null); /// - /// This Function is called thru the ToolStripEditorManager which is listening for the F2 command. + /// This Function is called thru the ToolStripEditorManager which is listening for the F2 command. /// internal virtual void ShowEditNode(bool clicked) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemGlyph.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemGlyph.cs index 8b5d3fafdf6..2d9a6b836cb 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemGlyph.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripItemGlyph.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms.Design { /// - /// The glyph we put over the items. Basically this sets the hit-testable area of the item itself. + /// The glyph we put over the items. Basically this sets the hit-testable area of the item itself. /// internal class ToolStripItemGlyph : ControlBodyGlyph { @@ -39,7 +39,7 @@ public ToolStripItemDesigner ItemDesigner } /// - /// Abstract method that forces Glyph implementations to provide hit test logic. Given any point - if the Glyph has decided to be involved with that location, the Glyph will need to return a valid Cursor. Otherwise, returning null will cause the the BehaviorService to simply ignore it. + /// Abstract method that forces Glyph implementations to provide hit test logic. Given any point - if the Glyph has decided to be involved with that location, the Glyph will need to return a valid Cursor. Otherwise, returning null will cause the the BehaviorService to simply ignore it. /// public override Cursor GetHitTest(Point p) { @@ -51,7 +51,7 @@ public override Cursor GetHitTest(Point p) } /// - /// Control host dont draw on Invalidation... + /// Control host dont draw on Invalidation... /// public override void Paint(PaintEventArgs pe) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripKeyboardHandlingService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripKeyboardHandlingService.cs index d8948502916..d2167f93ce7 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripKeyboardHandlingService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripKeyboardHandlingService.cs @@ -44,7 +44,7 @@ internal class ToolStripKeyboardHandlingService private object _ownerItemAfterCut = null; // This value is set only of the ToolStripMenuItem is cut and now we need to reopen the dropDown which was closed in the previous CUT operation. /// - /// This creates a service for handling the keyboard navigation at desgin time. + /// This creates a service for handling the keyboard navigation at desgin time. /// public ToolStripKeyboardHandlingService(IServiceProvider serviceProvider) { @@ -116,7 +116,7 @@ internal bool CutOrDeleteInProgress } /// - /// Retrieves the selection service, which tthis service uses while selecting the toolStrip Item. + /// Retrieves the selection service, which tthis service uses while selecting the toolStrip Item. /// private IDesignerHost Host { @@ -124,7 +124,7 @@ private IDesignerHost Host } /// - /// Retrieves the menu editor service, which we cache for speed. + /// Retrieves the menu editor service, which we cache for speed. /// private IMenuCommandService MenuService { @@ -191,7 +191,7 @@ internal object ShiftPrimaryItem } /// - /// Retrieves the selection service, which tthis service uses while selecting the toolStrip Item. + /// Retrieves the selection service, which tthis service uses while selecting the toolStrip Item. /// private ISelectionService SelectionService { @@ -289,7 +289,7 @@ private ToolStripItem GetNextItem(ToolStrip parent, ToolStripItem startItem, Arr } /// - /// This is the private helper function which gets the next control in the TabOrder.. + /// This is the private helper function which gets the next control in the TabOrder.. /// private Control GetNextControlInTab(Control basectl, Control ctl, bool forward) { @@ -884,7 +884,7 @@ private void OnKeyDefault(object sender, EventArgs e) } /// - /// This is a function which gets called when the item goes into InSitu Edit mode. + /// This is a function which gets called when the item goes into InSitu Edit mode. /// private void OnKeyEdit(object sender, EventArgs e) { @@ -944,7 +944,7 @@ private void OnKeyEdit(object sender, EventArgs e) } /// - /// This is a function which gets called when the arrow keys are used at design time on ToolStrips. + /// This is a function which gets called when the arrow keys are used at design time on ToolStrips. /// private void OnKeyMove(object sender, EventArgs e) { @@ -1017,7 +1017,7 @@ private void OnKeyMove(object sender, EventArgs e) } /// - /// This is a function which gets called when Cancel is pressed when we are on ToolStripItem. + /// This is a function which gets called when Cancel is pressed when we are on ToolStripItem. /// private void OnKeyCancel(object sender, EventArgs e) { @@ -1053,7 +1053,7 @@ private void OnKeyCancel(object sender, EventArgs e) } /// - /// This function allows the CommandSet to select the right item when the Tab and Arrow keys are used. + /// This function allows the CommandSet to select the right item when the Tab and Arrow keys are used. /// private void OnKeySelect(object sender, EventArgs e) { @@ -1063,7 +1063,7 @@ private void OnKeySelect(object sender, EventArgs e) } /// - /// Called when the current selection changes. Here we determine what commands can and can't be enabled. + /// Called when the current selection changes. Here we determine what commands can and can't be enabled. /// private void OnSelectionChanging(object sender, EventArgs e) { @@ -1091,7 +1091,7 @@ private void OnSelectionChanging(object sender, EventArgs e) } /// - /// Called when the current selection changes. Here we determine what commands can and can't be enabled. + /// Called when the current selection changes. Here we determine what commands can and can't be enabled. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -1153,7 +1153,7 @@ public void ProcessKeySelect(bool reverse, MenuCommand cmd) } /// - /// This is the private helper function which is used to select the toolStripItem in the 'right' direction. + /// This is the private helper function which is used to select the toolStripItem in the 'right' direction. /// private bool ProcessRightLeft(bool right) { @@ -1276,7 +1276,7 @@ private bool ProcessRightLeft(bool right) } /// - /// This is the private helper function which is used to select the toolStripItem in the 'down' direction. + /// This is the private helper function which is used to select the toolStripItem in the 'down' direction. /// public void ProcessUpDown(bool down) { @@ -1586,7 +1586,7 @@ internal void ResetActiveTemplateNodeSelectionState() } /// - /// Disposes of this object, removing all commands from the menu service. + /// Disposes of this object, removing all commands from the menu service. /// public void RemoveCommands() { @@ -1644,7 +1644,7 @@ public void RemoveCommands() } /// - /// This function allows the service to select the parent for the selected Item. + /// This function allows the service to select the parent for the selected Item. /// private void RotateParent(bool backwards) { @@ -1744,7 +1744,7 @@ private void RotateParent(bool backwards) } /// - /// This function allows the service to rotate the TabSelection when TAB key is pressed. + /// This function allows the service to rotate the TabSelection when TAB key is pressed. /// // Okay to suppress because of complex code path public void RotateTab(bool backwards) diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripMenuItemDesigner.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripMenuItemDesigner.cs index 04e7afc3302..d5bbe94d599 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripMenuItemDesigner.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripMenuItemDesigner.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms.Design { /// - /// Designer for ToolStripMenuItems. + /// Designer for ToolStripMenuItems. /// internal class ToolStripMenuItemDesigner : ToolStripDropDownItemDesigner { @@ -68,8 +68,8 @@ internal class ToolStripMenuItemDesigner : ToolStripDropDownItemDesigner private bool dropDownSetFailed = false; /// - /// The ToolStripDropDownItems are the associated components. - /// We want those to come with in any cut, copy opreations. + /// The ToolStripDropDownItems are the associated components. + /// We want those to come with in any cut, copy opreations. /// public override ICollection AssociatedComponents { @@ -92,7 +92,7 @@ public override ICollection AssociatedComponents } /// - /// ShadowProperty. + /// ShadowProperty. /// private bool CheckOnClick { @@ -188,8 +188,8 @@ private ToolStripDropDown DropDown } /// - /// ToolStripEditorManager used this internal property to - /// Activate the editor. + /// ToolStripEditorManager used this internal property to + /// Activate the editor. /// internal override ToolStripTemplateNode Editor { @@ -209,7 +209,7 @@ internal override ToolStripTemplateNode Editor } /// - /// True if the MenuItem is on ContextMenu. + /// True if the MenuItem is on ContextMenu. /// private bool IsOnContextMenu { @@ -225,7 +225,7 @@ private bool IsOnContextMenu } /// - /// Easy method for getting to the ToolStripDropDownItem + /// Easy method for getting to the ToolStripDropDownItem /// private ToolStripDropDownItem MenuItem { @@ -233,7 +233,7 @@ private ToolStripDropDownItem MenuItem } /// - /// This property is true when the OwnerItem is selected during COPY & PASTE operations. + /// This property is true when the OwnerItem is selected during COPY & PASTE operations. /// private bool MenuItemSelected { @@ -305,7 +305,7 @@ private ToolStripKeyboardHandlingService KeyboardHandlingService } /// - /// ParentComponent in case of MenuItems on the DropDown is the OwnerItem of the DropDown and not the ToolStripDropDown (since the DropDowns are not sited) + /// ParentComponent in case of MenuItems on the DropDown is the OwnerItem of the DropDown and not the ToolStripDropDown (since the DropDowns are not sited) /// protected override IComponent ParentComponent { @@ -335,7 +335,7 @@ protected override IComponent ParentComponent } /// - /// Adds the dummy node for InSitu Edit. + /// Adds the dummy node for InSitu Edit. /// internal void AddNewTemplateNode(ToolStripDropDown dropDown) { @@ -401,7 +401,7 @@ private void AddBodyGlyphs(ToolStripDropDownItem item) } /// - /// This is called by the TemplateNode to Commit the Edit. This function creates a NEW ToolStripDropDownItem if we are committing a dummy node or else just replaces the TEXT and IMAGE if we are changing an existing MenuItem. + /// This is called by the TemplateNode to Commit the Edit. This function creates a NEW ToolStripDropDownItem if we are committing a dummy node or else just replaces the TEXT and IMAGE if we are changing an existing MenuItem. /// internal override void CommitEdit(Type type, string text, bool commit, bool enterKeyPressed, bool tabKeyPressed) { @@ -416,7 +416,7 @@ internal override void CommitEdit(Type type, string text, bool commit, bool ente bool dummyItem = dummyItemAdded; dummyItemAdded = false; MenuItem.DropDown.SuspendLayout(); - if (commitedEditorNode != null) /// this means we have a valid node and we just changed some properties.. + if (commitedEditorNode != null) /// this means we have a valid node and we just changed some properties.. { index = MenuItem.DropDownItems.IndexOf(commitedEditorNode); ToolStripItem editedItem = (ToolStripItem)MenuItem.DropDownItems[index + 1]; @@ -610,7 +610,7 @@ internal override void CommitEdit(Type type, string text, bool commit, bool ente } else //we come here if we have not committed so revert our state... { - if (commitedEditorNode != null) /// we just changed some properties which we want to revert... + if (commitedEditorNode != null) /// we just changed some properties which we want to revert... { MenuItem.DropDown.SuspendLayout(); bool dummyItem = dummyItemAdded; @@ -665,8 +665,8 @@ internal override void CommitEdit(Type type, string text, bool commit, bool ente if (dummyItem) { SelectionManager selMgr = (SelectionManager)GetService(typeof(SelectionManager)); - /// Since the operation is cancelled and there is no change of glyphs, Set SelectionManager.NeedRefresh to false so that it doesnt REFRESH, - /// when the transaction is cancelled. + /// Since the operation is cancelled and there is no change of glyphs, Set SelectionManager.NeedRefresh to false so that it doesnt REFRESH, + /// when the transaction is cancelled. selMgr.NeedRefresh = false; if (newMenuItemTransaction != null) { @@ -694,7 +694,7 @@ internal override void CommitEdit(Type type, string text, bool commit, bool ente } /// - /// Creates the dummy node for InSitu Edit. + /// Creates the dummy node for InSitu Edit. /// private void CreatetypeHereNode() { @@ -718,7 +718,7 @@ private void CreatetypeHereNode() } /// - /// This Function is called by EnterInSituEdit where in we Swap the typeHereNode by the TemplateNode (the Insitu Editor). Since the TemplateNode had a EditorToolStrip we can just HOST that ToolStrip as a ToolStripContorlHost and add it to the DropDown. + /// This Function is called by EnterInSituEdit where in we Swap the typeHereNode by the TemplateNode (the Insitu Editor). Since the TemplateNode had a EditorToolStrip we can just HOST that ToolStrip as a ToolStripContorlHost and add it to the DropDown. /// private void CreateDummyMenuItem(ToolStripItem item, string text, Image image) { @@ -735,7 +735,7 @@ private void CreateDummyMenuItem(ToolStripItem item, string text, Image image) } /// - /// This helper function creates a dummyItem for Insitu editing. + /// This helper function creates a dummyItem for Insitu editing. /// private ToolStripItem CreateDummyItem(Type t, int dummyIndex) { @@ -811,7 +811,7 @@ private ToolStripItem CreateDummyItem(Type t, int dummyIndex) } /// - /// Asks the host to create a new DropDownItem, inserts the item into the collection & selects it. + /// Asks the host to create a new DropDownItem, inserts the item into the collection & selects it. /// private ToolStripItem CreateNewItem(Type t, int dummyIndex, string newText) { @@ -899,7 +899,7 @@ private ToolStripItem CreateNewItem(Type t, int dummyIndex, string newText) } /// - /// Helper function to find whether the passed in DropDownItems have same owner. + /// Helper function to find whether the passed in DropDownItems have same owner. /// private bool CheckSameOwner(ToolStripDropDownItem lastSelected, ToolStripDropDownItem currentSelected) { @@ -952,7 +952,7 @@ internal void Commit() } /// - /// Disposes of this designer. + /// Disposes of this designer. /// protected override void Dispose(bool disposing) { @@ -1180,7 +1180,7 @@ private void DropDownResize(object sender, EventArgs e) } /// - /// Called when a menuItem wants to go into InSitu Editing Mode. + /// Called when a menuItem wants to go into InSitu Editing Mode. /// internal void EditTemplateNode(bool clicked) { @@ -1284,7 +1284,7 @@ internal void EditTemplateNode(bool clicked) } /// - /// Called from OnDoubleClickTimerTick to Enter in InsituMode + /// Called from OnDoubleClickTimerTick to Enter in InsituMode /// private void EnterInSituMode() { @@ -1307,7 +1307,7 @@ private void EnterInSituMode() } /// - /// This method replaces the menItem with an in-situ TemplateNode. + /// This method replaces the menItem with an in-situ TemplateNode. /// internal void EnterInSituEdit(ToolStripItem toolItem) { @@ -1350,7 +1350,7 @@ internal void EnterInSituEdit(ToolStripItem toolItem) } /// - /// Get the Insertion Index to drop the current drag-drop item. + /// Get the Insertion Index to drop the current drag-drop item. /// - /// Returns the DropDown for this MenuItem else returns the Parent(Owner). + /// Returns the DropDown for this MenuItem else returns the Parent(Owner). /// protected override Component GetOwnerForActionList() { @@ -1387,7 +1387,7 @@ internal override ToolStrip GetMainToolStrip() } /// - /// Helper function to Hide the Active Dropdown from the given DropDownItem. + /// Helper function to Hide the Active Dropdown from the given DropDownItem. /// // Standard 'catch all - rethrow critical' exception pattern private void HideAllDropDowns(ToolStripDropDownItem item) @@ -1424,7 +1424,7 @@ private void HideAllDropDowns(ToolStripDropDownItem item) } /// - /// Helper function to Hide the Active Dropdown for all the siblings of the given DropDownItem. + /// Helper function to Hide the Active Dropdown for all the siblings of the given DropDownItem. /// private void HideSiblingDropDowns(ToolStripDropDownItem item) { @@ -1454,7 +1454,7 @@ private void HideSiblingDropDowns(ToolStripDropDownItem item) } /// - /// This will listen to the necessary dropDown events... now we add the events on selection and unhook when the dropDown is closed. + /// This will listen to the necessary dropDown events... now we add the events on selection and unhook when the dropDown is closed. /// internal void HookEvents() { @@ -1473,7 +1473,7 @@ internal void HookEvents() } /// - /// Initializes the ToolStripDropDownItem Designer. + /// Initializes the ToolStripDropDownItem Designer. /// public override void Initialize(IComponent component) { @@ -1519,7 +1519,7 @@ public override void Initialize(IComponent component) } /// - /// Important function that initializes the dropDown with the typeHereNode , hooks the events and then shows the dropDown. + /// Important function that initializes the dropDown with the typeHereNode , hooks the events and then shows the dropDown. /// internal void InitializeDropDown() { @@ -1613,7 +1613,7 @@ private bool IsParentDropDown(ToolStripDropDown currentDropDown) } /// - /// This will morph the current item to the provided type "t" of the item... + /// This will morph the current item to the provided type "t" of the item... /// internal override ToolStripItem MorphCurrentItem(Type t) { @@ -1636,7 +1636,7 @@ internal override ToolStripItem MorphCurrentItem(Type t) } /// - /// Fired after a component has been added. Here, we add it to the ToolStrip and select it. + /// Fired after a component has been added. Here, we add it to the ToolStrip and select it. /// private void ComponentChangeSvc_ComponentAdded(object sender, ComponentEventArgs e) { @@ -1804,7 +1804,7 @@ private void CommitInsertTransaction(bool commit) } /// - /// Checks if the component being added is a child ToolStripItem. + /// Checks if the component being added is a child ToolStripItem. /// private void ComponentChangeSvc_ComponentAdding(object sender, ComponentEventArgs e) { @@ -1838,7 +1838,7 @@ private void ComponentChangeSvc_ComponentAdding(object sender, ComponentEventArg } /// - /// After a ToolStripItem is removed, remove it from the ToolStrip and select the next item. + /// After a ToolStripItem is removed, remove it from the ToolStrip and select the next item. /// private void ComponentChangeSvc_ComponentRemoved(object sender, ComponentEventArgs e) { @@ -1918,7 +1918,7 @@ private void ComponentChangeSvc_ComponentRemoved(object sender, ComponentEventAr } /// - /// Before a ToolStripItem is removed, open a transaction to batch the operation. + /// Before a ToolStripItem is removed, open a transaction to batch the operation. /// private void ComponentChangeSvc_ComponentRemoving(object sender, ComponentEventArgs e) { @@ -1963,7 +1963,7 @@ private void ComponentChangeSvc_ComponentRemoving(object sender, ComponentEventA } /// - /// Controls the dismissal of the drop down, here - we just cancel it + /// Controls the dismissal of the drop down, here - we just cancel it /// private void OnDropDownClosing(object sender, ToolStripDropDownClosingEventArgs e) { @@ -1972,7 +1972,7 @@ private void OnDropDownClosing(object sender, ToolStripDropDownClosingEventArgs } /// - /// When DropDown is disposed; nullify the dropDown. + /// When DropDown is disposed; nullify the dropDown. /// private void OnDropDownDisposed(object sender, EventArgs e) { @@ -1988,7 +1988,7 @@ private void OnDropDownDisposed(object sender, EventArgs e) } /// - /// When a item is added, re-arrange the elements to make sure that the templateNode is at the end.. + /// When a item is added, re-arrange the elements to make sure that the templateNode is at the end.. /// private void OnItemAdded(object sender, ToolStripItemEventArgs e) { @@ -2017,7 +2017,7 @@ private void OnItemAdded(object sender, ToolStripItemEventArgs e) } /// - /// Called during Undo (this is used for DropDown Property) + /// Called during Undo (this is used for DropDown Property) /// private void OnUndone(object source, EventArgs e) { @@ -2055,7 +2055,7 @@ private void OnUndone(object source, EventArgs e) } /// - /// Called during Undo (this is used for DropDown Property) + /// Called during Undo (this is used for DropDown Property) /// private void OnUndoing(object source, EventArgs e) { @@ -2082,7 +2082,7 @@ private void OnUndoing(object source, EventArgs e) } /// - /// Once a menuitem designer has selection - be sure to expand and collapse all necessary child/parent items Implements the Selection Paint Logic by adding Text to Tag property. Also Hides Unnecessary DropDowns. + /// Once a menuitem designer has selection - be sure to expand and collapse all necessary child/parent items Implements the Selection Paint Logic by adding Text to Tag property. Also Hides Unnecessary DropDowns. /// private void OnSelectionChanged(object sender, EventArgs e) { @@ -2213,7 +2213,7 @@ private void OnSelectionChanged(object sender, EventArgs e) } /// - /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. + /// Allows a designer to filter the set of properties the component it is designing will expose through the TypeDescriptor object. This method is called immediately before its corresponding "Post" method. If you are overriding this method you should call the base implementation before you perform your own filtering. /// protected override void PreFilterProperties(IDictionary properties) { @@ -2286,7 +2286,7 @@ internal void RemoveTypeHereNode(ToolStripDropDownItem ownerItem) } /// - /// This private function is called to ROLLBACK the current Insitu editing mode. + /// This private function is called to ROLLBACK the current Insitu editing mode. /// private void RollBack() { @@ -2315,7 +2315,7 @@ private void RollBack() } /// - /// Remove Body glyphs when the dropDown is closed. + /// Remove Body glyphs when the dropDown is closed. /// private void RemoveBodyGlyphs(ToolStripDropDownItem item) { @@ -2338,7 +2338,7 @@ private void RemoveBodyGlyphs(ToolStripDropDownItem item) } /// - /// Remove glyphs per item + /// Remove glyphs per item /// internal void RemoveItemBodyGlyph(ToolStripItem item) { @@ -2358,7 +2358,7 @@ internal void RemoveItemBodyGlyph(ToolStripItem item) } /// - /// Helper function to remove and then re-add the glyphs. + /// Helper function to remove and then re-add the glyphs. /// internal void ResetGlyphs(ToolStripDropDownItem item) { @@ -2371,7 +2371,7 @@ internal void ResetGlyphs(ToolStripDropDownItem item) } /// - /// Set the Selection after a insitu edit is complete. + /// Set the Selection after a insitu edit is complete. /// internal override bool SetSelection(bool enterKeyPressed) { @@ -2407,27 +2407,27 @@ internal override bool SetSelection(bool enterKeyPressed) } /// - /// Returns true if the visible property should be persisted in code gen. + /// Returns true if the visible property should be persisted in code gen. /// private bool ShouldSerializeDoubleClickEnabled() => (bool)ShadowProperties["DoubleClickEnabled"]; /// - /// Returns true if the CheckOnClick property should be persisted in code gen. + /// Returns true if the CheckOnClick property should be persisted in code gen. /// private bool ShouldSerializeCheckOnClick() => (bool)ShadowProperties["CheckOnClick"]; /// - /// Returns true if the CheckOnClick property should be persisted in code gen. + /// Returns true if the CheckOnClick property should be persisted in code gen. /// private bool ShouldSerializeDropDown() => (customDropDown != null); /// - /// Returns true if the visible property should be persisted in code gen. + /// Returns true if the visible property should be persisted in code gen. /// private bool ShouldSerializeVisible() => !Visible; /// - /// This Function is called thru the ToolStripEditorManager which is listening for the F2 command. + /// This Function is called thru the ToolStripEditorManager which is listening for the F2 command. /// internal override void ShowEditNode(bool clicked) { @@ -2471,7 +2471,7 @@ internal override void ShowEditNode(bool clicked) } /// - /// This Function would select all items starting form oldSelection to the Current MenuItem. + /// This Function would select all items starting form oldSelection to the Current MenuItem. /// private void SelectItems(ToolStripDropDownItem oldSelection, ISelectionService selSvc) { @@ -2491,7 +2491,7 @@ private void SelectItems(ToolStripDropDownItem oldSelection, ISelectionService s } /// - /// Shows ALL the owner DropDowns if passed in MenuItem is Selected + /// Shows ALL the owner DropDowns if passed in MenuItem is Selected /// internal void ShowOwnerDropDown(ToolStripDropDownItem currentSelection) { @@ -2520,7 +2520,7 @@ internal void ShowOwnerDropDown(ToolStripDropDownItem currentSelection) } /// - /// This will listen to the necessary dropDown events... now we add the events on selection and unhook when the dropDown is closed. + /// This will listen to the necessary dropDown events... now we add the events on selection and unhook when the dropDown is closed. /// internal void UnHookEvents() { @@ -2539,7 +2539,7 @@ internal void UnHookEvents() } /// - /// The glyph we put over the items. Basically this sets the hit-testable area of the item itself. + /// The glyph we put over the items. Basically this sets the hit-testable area of the item itself. /// internal class ToolStripDropDownGlyph : Glyph { @@ -2550,7 +2550,7 @@ internal ToolStripDropDownGlyph(Rectangle bounds, System.Windows.Forms.Design.Be } /// - /// Abstract method that forces Glyph implementations to provide hit test logic. Given any point - if the Glyph has decided to be involved with that location, the Glyph will need to return a valid Cursor. Otherwise, returning null will cause the the BehaviorService to simply ignore it. + /// Abstract method that forces Glyph implementations to provide hit test logic. Given any point - if the Glyph has decided to be involved with that location, the Glyph will need to return a valid Cursor. Otherwise, returning null will cause the the BehaviorService to simply ignore it. /// public override Cursor GetHitTest(Point p) { @@ -2562,7 +2562,7 @@ public override Cursor GetHitTest(Point p) } /// - /// Overrides Glyph::Paint - this implementation does nothing. + /// Overrides Glyph::Paint - this implementation does nothing. /// public override void Paint(PaintEventArgs pe) { @@ -2570,12 +2570,12 @@ public override void Paint(PaintEventArgs pe) } /// - /// The transparent behavior on top of the DropDownGlyphs. + /// The transparent behavior on top of the DropDownGlyphs. /// internal class DropDownBehavior : ControlDesigner.TransparentBehavior { /// - /// Constructor that accepts the related ControlDesigner. + /// Constructor that accepts the related ControlDesigner. /// private readonly ToolStripMenuItemDesigner menuItemDesigner; @@ -2585,7 +2585,7 @@ internal DropDownBehavior(ControlDesigner designer, ToolStripMenuItemDesigner me } /// - /// Drag drop support on the DropDown... + /// Drag drop support on the DropDown... /// public override void OnDragEnter(Glyph g, DragEventArgs e) { @@ -2600,7 +2600,7 @@ public override void OnDragEnter(Glyph g, DragEventArgs e) } /// - /// Drag drop support on the DropDown... + /// Drag drop support on the DropDown... /// public override void OnDragOver(Glyph g, DragEventArgs e) { @@ -2615,7 +2615,7 @@ public override void OnDragOver(Glyph g, DragEventArgs e) } /// - /// Drag drop support on the DropDown... + /// Drag drop support on the DropDown... /// public override void OnDragDrop(Glyph g, DragEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripTemplateNode.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripTemplateNode.cs index 365685eb658..fe79b07fbc0 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripTemplateNode.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/ToolStripTemplateNode.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms.Design { /// - /// This internal class wraps the InSitu Editor. The editor is a runtime ToolStrip control which contains a leftButton (for image), centerLabel (for text) which gets swaped by a centerTextBox (when InSitu is ON). The ToolStripTemplateNode is also responsible for intercepting the Escape and Enter keys and implements the IMenuStatusHandler so that it can commit and rollback as required. Finally this ToolStripTemplateNode has a private class ItemTypeToolStripMenuItem for adding ToolStripItem types to the Dropdown for addItemButton. + /// This internal class wraps the InSitu Editor. The editor is a runtime ToolStrip control which contains a leftButton (for image), centerLabel (for text) which gets swaped by a centerTextBox (when InSitu is ON). The ToolStripTemplateNode is also responsible for intercepting the Escape and Enter keys and implements the IMenuStatusHandler so that it can commit and rollback as required. Finally this ToolStripTemplateNode has a private class ItemTypeToolStripMenuItem for adding ToolStripItem types to the Dropdown for addItemButton. /// internal class ToolStripTemplateNode : IMenuStatusHandler { @@ -143,7 +143,7 @@ public ToolStripTemplateNode(IComponent component, string text, Image image) } /// - /// This property enables / disables Menu Command Handler. + /// This property enables / disables Menu Command Handler. /// public bool Active { @@ -250,7 +250,7 @@ public event EventHandler Activated } /// - /// Returns the Bounds of this ToolStripTemplateNode. + /// Returns the Bounds of this ToolStripTemplateNode. /// public Rectangle Bounds { @@ -265,7 +265,7 @@ public DesignerToolStripControlHost ControlHost } /// - /// This is the designer contextMenu that pops when rightclicked on the TemplateNode. + /// This is the designer contextMenu that pops when rightclicked on the TemplateNode. /// private ContextMenuStrip DesignerContextMenu { @@ -301,7 +301,7 @@ public event EventHandler Closed } /// - /// This property returns the actual editor ToolStrip. + /// This property returns the actual editor ToolStrip. /// public ToolStrip EditorToolStrip { @@ -309,7 +309,7 @@ public ToolStrip EditorToolStrip } /// - /// This property returns the actual editor ToolStrip. + /// This property returns the actual editor ToolStrip. /// internal TextBox EditBox { @@ -317,7 +317,7 @@ internal TextBox EditBox } /// - /// HotRegion within the templateNode. this is the region which responds to the mouse. + /// HotRegion within the templateNode. this is the region which responds to the mouse. /// public Rectangle HotRegion { @@ -326,7 +326,7 @@ public Rectangle HotRegion } /// - /// value to suggest if IME mode is set. + /// value to suggest if IME mode is set. /// public bool IMEModeSet { @@ -335,7 +335,7 @@ public bool IMEModeSet } /// - /// KeyBoardHandling service. + /// KeyBoardHandling service. /// private ToolStripKeyboardHandlingService KeyboardService { @@ -350,7 +350,7 @@ private ToolStripKeyboardHandlingService KeyboardService } /// - /// SelectionService. + /// SelectionService. /// private ISelectionService SelectionService { @@ -377,7 +377,7 @@ private BehaviorService BehaviorService } /// - /// Type of the new Item to be added. + /// Type of the new Item to be added. /// public Type ToolStripItemType { @@ -386,7 +386,7 @@ public Type ToolStripItemType } /// - /// Is system context menu for the insitu edit box displayed?. + /// Is system context menu for the insitu edit box displayed?. /// internal bool IsSystemContextMenuDisplayed { @@ -395,7 +395,7 @@ internal bool IsSystemContextMenuDisplayed } /// - /// Helper function to add new Item when the DropDownItem (in the ToolStripTemplateNode) is clicked + /// Helper function to add new Item when the DropDownItem (in the ToolStripTemplateNode) is clicked /// private void AddNewItemClick(object sender, EventArgs e) { @@ -457,7 +457,7 @@ private void AddNewItemClick(object sender, EventArgs e) } /// - /// Called when the user clicks the CenterLabel of the ToolStripTemplateNode. + /// Called when the user clicks the CenterLabel of the ToolStripTemplateNode. /// private void CenterLabelClick(object sender, MouseEventArgs e) { @@ -582,7 +582,7 @@ private void CenterLabelClick(object sender, MouseEventArgs e) } /// - /// Painting of the templateNode on MouseEnter. + /// Painting of the templateNode on MouseEnter. /// private void CenterLabelMouseEnter(object sender, EventArgs e) { @@ -597,7 +597,7 @@ private void CenterLabelMouseEnter(object sender, EventArgs e) } /// - /// Painting of the templateNode on MouseMove + /// Painting of the templateNode on MouseMove /// private void CenterLabelMouseMove(object sender, MouseEventArgs e) { @@ -619,7 +619,7 @@ private void CenterLabelMouseMove(object sender, MouseEventArgs e) } /// - /// Painting of the templateNode on MouseLeave + /// Painting of the templateNode on MouseLeave /// private void CenterLabelMouseLeave(object sender, EventArgs e) { @@ -638,7 +638,7 @@ private void CenterLabelMouseLeave(object sender, EventArgs e) } /// - /// Painting of the templateNode on MouseEnter + /// Painting of the templateNode on MouseEnter /// private void CenterTextBoxMouseEnter(object sender, EventArgs e) { @@ -650,7 +650,7 @@ private void CenterTextBoxMouseEnter(object sender, EventArgs e) } /// - /// Painting of the templateNode on TextBox mouseLeave (in case of MenuStrip) + /// Painting of the templateNode on TextBox mouseLeave (in case of MenuStrip) /// private void CenterTextBoxMouseLeave(object sender, EventArgs e) { @@ -662,7 +662,7 @@ private void CenterTextBoxMouseLeave(object sender, EventArgs e) } /// - /// This Internal function is called from the ToolStripItemDesigner to relinquish the resources used by the EditorToolStrip. This Fucntion disposes the ToolStrip and its components and also clears the event handlers associated. + /// This Internal function is called from the ToolStripItemDesigner to relinquish the resources used by the EditorToolStrip. This Fucntion disposes the ToolStrip and its components and also clears the event handlers associated. /// internal void CloseEditor() { @@ -730,7 +730,7 @@ internal void CloseEditor() } /// - /// This internal Function is called by item designers to ROLLBACK the current Insitu editing mode. + /// This internal Function is called by item designers to ROLLBACK the current Insitu editing mode. /// internal void Commit(bool enterKeyPressed, bool tabKeyPressed) { @@ -750,7 +750,7 @@ internal void Commit(bool enterKeyPressed, bool tabKeyPressed) } /// - /// Internal function that would commit the TemplateNode + /// Internal function that would commit the TemplateNode /// internal void CommitAndSelect() { @@ -793,7 +793,7 @@ private void CommitTextToDesigner(string text, bool commit, bool enterKeyPressed } /// - /// This private function performs the job of commiting the current InSitu Editor. This will call the CommitEdit(...) function for the appropriate designers so that they can actually do their own Specific things for commiting (or ROLLBACKING) the Insitu Edit mode. The commit flag is used for commit or rollback. BE SURE TO ALWAYS call ExitInSituEdit from this function to put the EditorToolStrip in a sane "NON EDIT" mode. + /// This private function performs the job of commiting the current InSitu Editor. This will call the CommitEdit(...) function for the appropriate designers so that they can actually do their own Specific things for commiting (or ROLLBACKING) the Insitu Edit mode. The commit flag is used for commit or rollback. BE SURE TO ALWAYS call ExitInSituEdit from this function to put the EditorToolStrip in a sane "NON EDIT" mode. /// private void CommitEditor(bool commit, bool enterKeyPressed, bool tabKeyPressed) { @@ -828,7 +828,7 @@ private void CommitEditor(bool commit, bool enterKeyPressed, bool tabKeyPressed) } /// - /// The ToolStripTemplateNode enters into InSitu Edit Mode through this Function. This Function is called by FocusEditor( ) which starts the InSitu. The centerLabel is SWAPPED by centerTextBox and the ToolStripTemplateNode is Ready for Text. Settting "Active = true" pushes the IEventHandler which now intercepts the Escape and Enter keys to ROLLBACK or COMMIT the InSitu Editing respectively. + /// The ToolStripTemplateNode enters into InSitu Edit Mode through this Function. This Function is called by FocusEditor( ) which starts the InSitu. The centerLabel is SWAPPED by centerTextBox and the ToolStripTemplateNode is Ready for Text. Settting "Active = true" pushes the IEventHandler which now intercepts the Escape and Enter keys to ROLLBACK or COMMIT the InSitu Editing respectively. /// private void EnterInSituEdit() { @@ -906,7 +906,7 @@ private void EnterInSituEdit() } /// - /// The ToolStripTemplateNode exits from InSitu Edit Mode through this Function. This Function is called by CommitEditor( ) which stops the InSitu. The centerTextBox is SWAPPED by centerLabel and the ToolStripTemplateNode is exits the InSitu Mode. Settting "Active = false" pops the IEventHandler. + /// The ToolStripTemplateNode exits from InSitu Edit Mode through this Function. This Function is called by CommitEditor( ) which stops the InSitu. The centerTextBox is SWAPPED by centerLabel and the ToolStripTemplateNode is exits the InSitu Mode. Settting "Active = false" pops the IEventHandler. /// private void ExitInSituEdit() { @@ -953,7 +953,7 @@ private void ExitInSituEdit() } /// - /// This internal function is called from ToolStripItemDesigner to put the current item into InSitu Edit Mode. + /// This internal function is called from ToolStripItemDesigner to put the current item into InSitu Edit Mode. /// internal void FocusEditor(ToolStripItem currentItem) { @@ -965,7 +965,7 @@ internal void FocusEditor(ToolStripItem currentItem) } /// - /// Called when the user enters into the InSitu edit mode.This keeps the fdesigner Form Active..... + /// Called when the user enters into the InSitu edit mode.This keeps the fdesigner Form Active..... /// private void FocusForm() { @@ -997,7 +997,7 @@ protected void OnClosed(EventArgs e) } /// - /// Painting of the templateNode on when the contextMenu is closed + /// Painting of the templateNode on when the contextMenu is closed /// private void OnContextMenuClosed(object sender, ToolStripDropDownClosedEventArgs e) { @@ -1017,7 +1017,7 @@ private void OnContextMenuClosing(object sender, ToolStripDropDownClosingEventAr } /// - /// Set the KeyBoardService member, so the designer knows that the "ContextMenu" is opened. + /// Set the KeyBoardService member, so the designer knows that the "ContextMenu" is opened. /// private void OnContextMenuOpened(object sender, EventArgs e) { @@ -1034,7 +1034,7 @@ protected void OnDeactivated(EventArgs e) } /// - /// Called by the design surface when it is being flushed. This will save any changes made to TemplateNode. + /// Called by the design surface when it is being flushed. This will save any changes made to TemplateNode. /// private void OnLoaderFlushed(object sender, EventArgs e) { @@ -1042,7 +1042,7 @@ private void OnLoaderFlushed(object sender, EventArgs e) } /// - /// This is small HACK. For some reason if the InSituEditor's textbox has focus the escape key is lost and the menu service doesnt get it.... but the textbox gets it. So need to check for the escape key here and call CommitEditor(false) which will ROLLBACK the edit. + /// This is small HACK. For some reason if the InSituEditor's textbox has focus the escape key is lost and the menu service doesnt get it.... but the textbox gets it. So need to check for the escape key here and call CommitEditor(false) which will ROLLBACK the edit. /// private void OnKeyUp(object sender, KeyEventArgs e) { @@ -1078,7 +1078,7 @@ private void OnKeyUp(object sender, KeyEventArgs e) } /// - /// Select text on KeyDown. + /// Select text on KeyDown. /// private void OnKeyDown(object sender, KeyEventArgs e) { @@ -1096,7 +1096,7 @@ private void OnKeyDown(object sender, KeyEventArgs e) } /// - /// Check for the Enter key here and call CommitEditor(true) which will COMMIT the edit. + /// Check for the Enter key here and call CommitEditor(true) which will COMMIT the edit. /// private void OnKeyDefaultAction(object sender, EventArgs e) { @@ -1118,14 +1118,14 @@ private void OnKeyDefaultAction(object sender, EventArgs e) } /// - /// Called when the delete menu item is selected. + /// Called when the delete menu item is selected. /// private void OnMenuCut(object sender, EventArgs e) { } /// - /// Show ContextMenu if the Right Mouse button was pressed and we have received the following MouseUp + /// Show ContextMenu if the Right Mouse button was pressed and we have received the following MouseUp /// private void OnMouseUp(object sender, MouseEventArgs e) { @@ -1142,7 +1142,7 @@ private void OnMouseUp(object sender, MouseEventArgs e) } /// - /// Set the selection to the component. + /// Set the selection to the component. /// private void OnMouseDown(object sender, MouseEventArgs e) { @@ -1154,7 +1154,7 @@ private void OnMouseDown(object sender, MouseEventArgs e) } /// - /// Painting on the button for mouse Move. + /// Painting on the button for mouse Move. /// private void OnMouseMove(object sender, MouseEventArgs e) { @@ -1177,7 +1177,7 @@ private void OnMouseMove(object sender, MouseEventArgs e) } /// - /// Painting on the button for mouse Leave. + /// Painting on the button for mouse Leave. /// private void OnMouseLeave(object sender, EventArgs e) { @@ -1209,7 +1209,7 @@ private void OnRightToLeftChanged(object sender, EventArgs e) } /// - /// Intercept invokation of specific commands and keys + /// Intercept invokation of specific commands and keys /// public bool OverrideInvoke(MenuCommand cmd) { @@ -1228,7 +1228,7 @@ public bool OverrideInvoke(MenuCommand cmd) } /// - /// Intercept invokation of specific commands and keys + /// Intercept invokation of specific commands and keys /// public bool OverrideStatus(MenuCommand cmd) { @@ -1245,7 +1245,7 @@ public bool OverrideStatus(MenuCommand cmd) } /// - /// This internal Function is called by item designers to ROLLBACK the current Insitu editing mode. + /// This internal Function is called by item designers to ROLLBACK the current Insitu editing mode. /// internal void RollBack() { @@ -1319,7 +1319,7 @@ internal void ShowDropDownMenu() } /// - /// This function sets up the MenuStrip specific TemplateNode. + /// This function sets up the MenuStrip specific TemplateNode. /// private void SetUpMenuTemplateNode(ToolStripTemplateNode owner, string text, Image image, IComponent currentItem) { @@ -1350,7 +1350,7 @@ private void SetUpMenuTemplateNode(ToolStripTemplateNode owner, string text, Ima } /// - /// This function sets up TemplateNode for ToolStrip, StatusStrip, ContextMenuStrip. + /// This function sets up TemplateNode for ToolStrip, StatusStrip, ContextMenuStrip. /// private void SetUpToolTemplateNode(ToolStripTemplateNode owner, string text, Image image, IComponent component) { @@ -1413,7 +1413,7 @@ private void SetUpToolTemplateNode(ToolStripTemplateNode owner, string text, Ima } /// - /// This method does actual edit node creation. + /// This method does actual edit node creation. /// private void SetupNewEditNode(ToolStripTemplateNode owner, string text, Image image, IComponent currentItem) { @@ -1459,7 +1459,7 @@ private void SetupNewEditNode(ToolStripTemplateNode owner, string text, Image im } /// - /// This method does sets the width of the Editor (_miniToolStrip) based on the text passed in. + /// This method does sets the width of the Editor (_miniToolStrip) based on the text passed in. /// internal void SetWidth(string text) { @@ -1475,7 +1475,7 @@ internal void SetWidth(string text) } /// - /// Private class that implements the textBox for the InSitu Editor. + /// Private class that implements the textBox for the InSitu Editor. /// private class TemplateTextBox : TextBox { @@ -1492,7 +1492,7 @@ public TemplateTextBox(TransparentToolStrip parent, ToolStripTemplateNode owner) } /// - /// Get Parent Handle. + /// Get Parent Handle. /// private bool IsParentWindow(IntPtr hWnd) { @@ -1515,7 +1515,7 @@ protected override bool IsInputKey(Keys keyData) } /// - /// Process the IMEMode message.. + /// Process the IMEMode message.. /// protected override bool ProcessDialogKey(Keys keyData) { @@ -1532,7 +1532,7 @@ protected override bool ProcessDialogKey(Keys keyData) } /// - /// Process the WNDPROC for WM_KILLFOCUS to commit the Insitu Editor.. + /// Process the WNDPROC for WM_KILLFOCUS to commit the Insitu Editor.. /// protected override void WndProc(ref Message m) { @@ -1563,7 +1563,7 @@ protected override void WndProc(ref Message m) } /// - /// Private class to Change the ToolStrip to a TransparentToolStrip. Our EditorToolStrip is a TranparentToolStrip so that it picks up the itemColor. + /// Private class to Change the ToolStrip to a TransparentToolStrip. Our EditorToolStrip is a TranparentToolStrip so that it picks up the itemColor. /// public class TransparentToolStrip : ToolStrip { @@ -1582,7 +1582,7 @@ public TransparentToolStrip(ToolStripTemplateNode owner) } /// - /// Owner TemplateNode.. + /// Owner TemplateNode.. /// public ToolStripTemplateNode TemplateNode { @@ -1590,7 +1590,7 @@ public ToolStripTemplateNode TemplateNode } /// - /// Commit the node and move to next selection. + /// Commit the node and move to next selection. /// private void CommitAndSelectNext(bool forward) { @@ -1602,7 +1602,7 @@ private void CommitAndSelectNext(bool forward) } /// - /// get current selection. + /// get current selection. /// private ToolStripItem GetSelectedItem() { @@ -1631,7 +1631,7 @@ public override Size GetPreferredSize(Size proposedSize) } /// - /// Process the Tab Key.. + /// Process the Tab Key.. /// private bool ProcessTabKey(bool forward) { @@ -1647,7 +1647,7 @@ private bool ProcessTabKey(bool forward) } /// - /// Process the Dialog Keys for the Templatenode ToolStrip.. + /// Process the Dialog Keys for the Templatenode ToolStrip.. /// protected override bool ProcessDialogKey(Keys keyData) { @@ -1766,7 +1766,7 @@ public void Collapse() */ /// - /// Private class that implements the custom Renderer for the TemplateNode ToolStrip. + /// Private class that implements the custom Renderer for the TemplateNode ToolStrip. /// public class MiniToolStripRenderer : ToolStripSystemRenderer { @@ -1791,7 +1791,7 @@ public MiniToolStripRenderer(ToolStripTemplateNode owner) : base() } /// - /// Current state of the TemplateNode UI.. + /// Current state of the TemplateNode UI.. /// public int State { @@ -1800,7 +1800,7 @@ public int State } /// - /// Custom method to draw DOWN arrow on the DropDown. + /// Custom method to draw DOWN arrow on the DropDown. /// private void DrawArrow(Graphics g, Rectangle bounds) { @@ -1809,7 +1809,7 @@ private void DrawArrow(Graphics g, Rectangle bounds) } /// - /// Drawing different DropDown states. + /// Drawing different DropDown states. /// private void DrawDropDown(Graphics g, Rectangle bounds, int state) { @@ -1852,7 +1852,7 @@ protected override void OnRenderToolStripBackground(ToolStripRenderEventArgs e) } /// - /// Render ToolStrip Border + /// Render ToolStrip Border /// protected override void OnRenderToolStripBorder(ToolStripRenderEventArgs e) { @@ -1865,7 +1865,7 @@ protected override void OnRenderToolStripBorder(ToolStripRenderEventArgs e) } /// - /// Render the Center Label on the TemplateNode ToolStrip. + /// Render the Center Label on the TemplateNode ToolStrip. /// protected override void OnRenderLabelBackground(ToolStripItemRenderEventArgs e) { @@ -1947,7 +1947,7 @@ protected override void OnRenderLabelBackground(ToolStripItemRenderEventArgs e) } /// - /// Render the splitButton on the TemplateNode ToolStrip.. + /// Render the splitButton on the TemplateNode ToolStrip.. /// protected override void OnRenderSplitButtonBackground(ToolStripItemRenderEventArgs e) { diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/UndoEngine.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/UndoEngine.cs index 24a1f792877..881a191ac4a 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/UndoEngine.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/UndoEngine.cs @@ -12,12 +12,12 @@ namespace System.ComponentModel.Design { /// - /// The UndoEngine is a class that can be instantiated to support automatic undo. - /// Normally, to support undo, a developer must create individual undo units that consist of an undo action and a redo action. - /// This is fragile because each and every action the user performs must be wrapped in an undo unit. - /// Worse, if a user action is not wrapped in an undo unit its absence on the undo stack will break undo because each individual unit always assumes that the previous unit's state is maintained. - /// The UndoEngine, on the other hand, listens to change events and can create undo and redo actions automatically. - /// All that is necessary to implement undo is to add these actions to an undo/redo stack and instantiate this class. + /// The UndoEngine is a class that can be instantiated to support automatic undo. + /// Normally, to support undo, a developer must create individual undo units that consist of an undo action and a redo action. + /// This is fragile because each and every action the user performs must be wrapped in an undo unit. + /// Worse, if a user action is not wrapped in an undo unit its absence on the undo stack will break undo because each individual unit always assumes that the previous unit's state is maintained. + /// The UndoEngine, on the other hand, listens to change events and can create undo and redo actions automatically. + /// All that is necessary to implement undo is to add these actions to an undo/redo stack and instantiate this class. /// public abstract class UndoEngine : IDisposable { @@ -35,10 +35,10 @@ public abstract class UndoEngine : IDisposable private bool _enabled; /// - /// Creates a new UndoEngine. UndoEngine requires a service provider for access to various services. The following services must be available or else UndoEngine will throw an exception: - /// IDesignerHost - /// IComponentChangeService - /// IDesignerSerializationService + /// Creates a new UndoEngine. UndoEngine requires a service provider for access to various services. The following services must be available or else UndoEngine will throw an exception: + /// IDesignerHost + /// IComponentChangeService + /// IDesignerSerializationService /// protected UndoEngine(IServiceProvider provider) { @@ -64,7 +64,7 @@ protected UndoEngine(IServiceProvider provider) } /// - /// Retrieves the current unit from the stack. + /// Retrieves the current unit from the stack. /// private UndoUnit CurrentUnit { @@ -79,7 +79,7 @@ private UndoUnit CurrentUnit } /// - /// This property indicates if an undo is in progress. + /// This property indicates if an undo is in progress. /// public bool UndoInProgress { @@ -87,12 +87,12 @@ public bool UndoInProgress } /// - /// This property returns true if the Undo engine is currently enabled. When enabled, the undo engine tracks changes made to the designer. When disabled, changes are ignored. - /// If the UndoEngine is set to disabled while in the middle of processing change notifications from the designer, the undo engine will only ignore additional changes. - /// That is, it will finish recording the changes that are in process and only ignore additional changes. - /// Caution should be used when disabling undo. If undo is disabled it is easy to make a change that would cause other undo actions to become invalid. - /// For example, if myButton.Text was changed, and then myButton was renamed while undo was disabled, attempting to undo the text change would fail because there is no longer a control called myButton. - /// Generally, you should never make changes to components with undo disabled unless you are certain to put the components back the way they were before undo was disabled. An example of this would be to replace one instance of "Button" with another, say "SuperButton", fixing up all the property values as you go. The result is a new component, but because it has the same component name and property values, undo state will still be consistent. + /// This property returns true if the Undo engine is currently enabled. When enabled, the undo engine tracks changes made to the designer. When disabled, changes are ignored. + /// If the UndoEngine is set to disabled while in the middle of processing change notifications from the designer, the undo engine will only ignore additional changes. + /// That is, it will finish recording the changes that are in process and only ignore additional changes. + /// Caution should be used when disabling undo. If undo is disabled it is easy to make a change that would cause other undo actions to become invalid. + /// For example, if myButton.Text was changed, and then myButton was renamed while undo was disabled, attempting to undo the text change would fail because there is no longer a control called myButton. + /// Generally, you should never make changes to components with undo disabled unless you are certain to put the components back the way they were before undo was disabled. An example of this would be to replace one instance of "Button" with another, say "SuperButton", fixing up all the property values as you go. The result is a new component, but because it has the same component name and property values, undo state will still be consistent. /// public bool Enabled { @@ -101,7 +101,7 @@ public bool Enabled } /// - /// This event is raised immediately before an undo action is performed. + /// This event is raised immediately before an undo action is performed. /// public event EventHandler Undoing { @@ -110,7 +110,7 @@ public event EventHandler Undoing } /// - /// This event is raised immediately after an undo action is performed. It will always be raised even if an exception is thrown. + /// This event is raised immediately after an undo action is performed. It will always be raised even if an exception is thrown. /// public event EventHandler Undone { @@ -119,25 +119,25 @@ public event EventHandler Undone } /// - /// Adds the given undo unit into the undo stack. UndoEngine does not maintain its own undo stack, so you must implement this method yourself. + /// Adds the given undo unit into the undo stack. UndoEngine does not maintain its own undo stack, so you must implement this method yourself. /// protected abstract void AddUndoUnit(UndoUnit unit); /// - /// This method will check to see if the current undo unit needs to be popped from the stack. If it does, it will pop it and add it to the undo stack. - /// There must be at least one unit on the stack to call this method. + /// This method will check to see if the current undo unit needs to be popped from the stack. If it does, it will pop it and add it to the undo stack. + /// There must be at least one unit on the stack to call this method. /// - /// When calling CheckPopUnit you must supply a reason for the call. - /// There are three reasons: + /// When calling CheckPopUnit you must supply a reason for the call. + /// There are three reasons: /// - /// Normal - /// Call with Normal if you are not calling in response to a closing transaction. For normal pop reasons, the unit will be popped if there is no current transaction. If the unit is not empty it will be added to the undo engine. If there is a transaction in progress, this method will do nothing. + /// Normal + /// Call with Normal if you are not calling in response to a closing transaction. For normal pop reasons, the unit will be popped if there is no current transaction. If the unit is not empty it will be added to the undo engine. If there is a transaction in progress, this method will do nothing. /// - /// TransactionCommit - /// Call with TransactionCommit if you are calling in response to a transaction closing, and if that transaction is marked as being committed. CheckPopUnit will pop the unit off of the stack and add it to the undo engine if it is not empty. + /// TransactionCommit + /// Call with TransactionCommit if you are calling in response to a transaction closing, and if that transaction is marked as being committed. CheckPopUnit will pop the unit off of the stack and add it to the undo engine if it is not empty. /// - /// TransactionCancel - /// Call with TransactionCancel if you are calling in response to a transaction closing, and if that transaction is marked as being cancelled. CheckPopUnit will pop the unit off of the stack. If the unit is not empty Undo will be called on the unit to roll back the transaction work. The unit will never be added to the undo engine. + /// TransactionCancel + /// Call with TransactionCancel if you are calling in response to a transaction closing, and if that transaction is marked as being cancelled. CheckPopUnit will pop the unit off of the stack. If the unit is not empty Undo will be called on the unit to roll back the transaction work. The unit will never be added to the undo engine. /// private void CheckPopUnit(PopUnitReason reason) { @@ -184,8 +184,8 @@ private void CheckPopUnit(PopUnitReason reason) } /// - /// This virtual method creates a new instance of an UndoUnit class. The default implementation just returns a new instance of UndoUnit. Those providing their own UndoEngine can derive from UndoUnit to customize the actions it performs. This is also a handy way to connect UndoEngine into an existing undo stack. - /// If the primary parameter is set to true, the undo unit will eventually be passed to either the AddUndoUnit or DiscardUndoUnit methods. If the primary parameter is false, the undo unit is part of a nested transaction and will never be passed to AddUndoUnit or DiscardUndoUnit; only the encompasing unit will be passed, because the undo engine will either include or exclude the contents of the nested unit when it is closed. + /// This virtual method creates a new instance of an UndoUnit class. The default implementation just returns a new instance of UndoUnit. Those providing their own UndoEngine can derive from UndoUnit to customize the actions it performs. This is also a handy way to connect UndoEngine into an existing undo stack. + /// If the primary parameter is set to true, the undo unit will eventually be passed to either the AddUndoUnit or DiscardUndoUnit methods. If the primary parameter is false, the undo unit is part of a nested transaction and will never be passed to AddUndoUnit or DiscardUndoUnit; only the encompasing unit will be passed, because the undo engine will either include or exclude the contents of the nested unit when it is closed. /// protected virtual UndoUnit CreateUndoUnit(string name, bool primary) { @@ -198,14 +198,14 @@ internal IComponentChangeService ComponentChangeService } /// - /// This method is called instead of AddUndoUnit for undo units that have been canceled. For undo systems that just treat undo as a simple stack of undo units, typically you do not need to override this method. This method does give you a chance to perform any clean-up for a unit + /// This method is called instead of AddUndoUnit for undo units that have been canceled. For undo systems that just treat undo as a simple stack of undo units, typically you do not need to override this method. This method does give you a chance to perform any clean-up for a unit /// protected virtual void DiscardUndoUnit(UndoUnit unit) { } /// - /// Public dispose method. + /// Public dispose method. /// public void Dispose() { @@ -213,7 +213,7 @@ public void Dispose() } /// - /// Protected dispose implementation. + /// Protected dispose implementation. /// protected virtual void Dispose(bool disposing) { @@ -242,7 +242,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Helper function to retrieve the name of an object. + /// Helper function to retrieve the name of an object. /// internal string GetName(object obj, bool generateNew) { @@ -281,7 +281,7 @@ internal string GetName(object obj, bool generateNew) } /// - /// Similar to GetService, but this will throw a NotSupportedException if the service is not present. + /// Similar to GetService, but this will throw a NotSupportedException if the service is not present. /// protected object GetRequiredService(Type serviceType) { @@ -298,7 +298,7 @@ protected object GetRequiredService(Type serviceType) } /// - /// This just calls through to the service provider passed into the constructor. + /// This just calls through to the service provider passed into the constructor. /// protected object GetService(Type serviceType) { @@ -522,7 +522,7 @@ private void OnTransactionOpening(object sender, EventArgs e) } /// - /// This event is raised immediately before an undo action is performed. + /// This event is raised immediately before an undo action is performed. /// protected virtual void OnUndoing(EventArgs e) { @@ -530,7 +530,7 @@ protected virtual void OnUndoing(EventArgs e) } /// - /// This event is raised immediately after an undo action is performed. It will always be raised even if an exception is thrown. + /// This event is raised immediately after an undo action is performed. It will always be raised even if an exception is thrown. /// protected virtual void OnUndone(EventArgs e) { @@ -561,7 +561,7 @@ public ReferencingComponent(IComponent component, MemberDescriptor member) } /// - /// This class embodies a unit of undoable work. The undo engine creates an undo unit when a change to the designer is about to be made. The undo unit is responsible for tracking changes. The undo engine will call Close on the unit when it no longer needs to track changes. + /// This class embodies a unit of undoable work. The undo engine creates an undo unit when a change to the designer is about to be made. The undo unit is responsible for tracking changes. The undo engine will call Close on the unit when it no longer needs to track changes. /// protected class UndoUnit { @@ -603,14 +603,14 @@ public UndoUnit(UndoEngine engine, string name) public string Name { get; } /// - /// This returns true if the undo unit has nothing in it to undo. The unit will be discarded. + /// This returns true if the undo unit has nothing in it to undo. The unit will be discarded. /// public virtual bool IsEmpty => _events == null || _events.Count == 0; protected UndoEngine UndoEngine { get; } /// - /// Adds the given event to our event list. + /// Adds the given event to our event list. /// private void AddEvent(UndoEvent e) { @@ -623,7 +623,7 @@ private void AddEvent(UndoEvent e) } /// - /// Called by the undo engine when it wants to close this unit. The unit should do any final work it needs to do to close. + /// Called by the undo engine when it wants to close this unit. The unit should do any final work it needs to do to close. /// public virtual void Close() { @@ -651,7 +651,7 @@ public virtual void Close() } /// - /// The undo engine will call this on the active undo unit in response to a component added event. + /// The undo engine will call this on the active undo unit in response to a component added event. /// public virtual void ComponentAdded(ComponentEventArgs e) { @@ -678,7 +678,7 @@ public virtual void ComponentAdded(ComponentEventArgs e) } /// - /// The undo engine will call this on the active undo unit in response to a component adding event. + /// The undo engine will call this on the active undo unit in response to a component adding event. /// public virtual void ComponentAdding(ComponentEventArgs e) { @@ -722,7 +722,7 @@ private bool CanRepositionEvent(int startIndex, ComponentChangedEventArgs e) } /// - /// The undo engine will call this on the active undo unit in response to a component changed event. + /// The undo engine will call this on the active undo unit in response to a component changed event. /// public virtual void ComponentChanged(ComponentChangedEventArgs e) { @@ -749,7 +749,7 @@ public virtual void ComponentChanged(ComponentChangedEventArgs e) } /// - /// The undo engine will call this on the active undo unit in response to a component changing event. + /// The undo engine will call this on the active undo unit in response to a component changing event. /// public virtual void ComponentChanging(ComponentChangingEventArgs e) { @@ -834,7 +834,7 @@ public virtual void ComponentChanging(ComponentChangingEventArgs e) } /// - /// The undo engine will call this on the active undo unit in response to a component removed event. + /// The undo engine will call this on the active undo unit in response to a component removed event. /// public virtual void ComponentRemoved(ComponentEventArgs e) { @@ -884,7 +884,7 @@ public virtual void ComponentRemoved(ComponentEventArgs e) } /// - /// The undo engine will call this on the active undo unit in response to a component removing event. + /// The undo engine will call this on the active undo unit in response to a component removing event. /// public virtual void ComponentRemoving(ComponentEventArgs e) { @@ -908,7 +908,7 @@ public virtual void ComponentRemoving(ComponentEventArgs e) } /// - /// The undo engine will cal this on the active undo unit in response to a component rename event. + /// The undo engine will cal this on the active undo unit in response to a component rename event. /// public virtual void ComponentRename(ComponentRenameEventArgs e) { @@ -916,7 +916,7 @@ public virtual void ComponentRename(ComponentRenameEventArgs e) } /// - /// Returns an instance of the rquested service. + /// Returns an instance of the rquested service. /// protected object GetService(Type serviceType) { @@ -924,7 +924,7 @@ protected object GetService(Type serviceType) } /// - /// Override for object.ToString() + /// Override for object.ToString() /// public override string ToString() { @@ -932,7 +932,7 @@ public override string ToString() } /// - /// Either performs undo, or redo, depending on the state of the unit. UndoUnit initially assumes that the undoable work has already been "done", so the first call to undo will undo the work. The next call will undo the "undo", performing a redo. + /// Either performs undo, or redo, depending on the state of the unit. UndoUnit initially assumes that the undoable work has already been "done", so the first call to undo will undo the work. The next call will undo the "undo", performing a redo. /// public void Undo() { @@ -972,7 +972,7 @@ public void Undo() } /// - /// The undo method invokes this method to perform the actual undo / redo work. You should never call this method directly; override it if you wish, but always call the public Undo method to perform undo work. Undo notifies the undo engine to suspend undo data gathering until this undo is completed, which prevents new undo units from being created in response to this unit doing work. + /// The undo method invokes this method to perform the actual undo / redo work. You should never call this method directly; override it if you wish, but always call the public Undo method to perform undo work. Undo notifies the undo engine to suspend undo data gathering until this undo is completed, which prevents new undo units from being created in response to this unit doing work. /// protected virtual void UndoCore() { @@ -1074,7 +1074,7 @@ protected virtual void UndoCore() } /// - /// This undo event handles addition and removal of components. + /// This undo event handles addition and removal of components. /// private sealed class AddRemoveUndoEvent : UndoEvent { @@ -1085,7 +1085,7 @@ private sealed class AddRemoveUndoEvent : UndoEvent private readonly IComponent _openComponent; /// - /// Creates a new object that contains the state of the event. The last parameter, add, determines the initial mode of this event. If true, it means this event is being created in response to a component add. If false, it is being created in response to a component remove. + /// Creates a new object that contains the state of the event. The last parameter, add, determines the initial mode of this event. If true, it means this event is being created in response to a component add. If false, it is being created in response to a component remove. /// public AddRemoveUndoEvent(UndoEngine engine, IComponent component, bool add) { @@ -1103,7 +1103,7 @@ public AddRemoveUndoEvent(UndoEngine engine, IComponent component, bool add) } /// - /// Returns true if the add remove event has been comitted. + /// Returns true if the add remove event has been comitted. /// internal bool Committed { @@ -1111,7 +1111,7 @@ internal bool Committed } /// - /// If this add/remove event is still open, OpenCompnent will contain the component it is operating on. + /// If this add/remove event is still open, OpenCompnent will contain the component it is operating on. /// internal IComponent OpenComponent { @@ -1119,7 +1119,7 @@ internal IComponent OpenComponent } /// - /// Returns true if undoing this event will add a component. + /// Returns true if undoing this event will add a component. /// internal bool NextUndoAdds { @@ -1127,7 +1127,7 @@ internal bool NextUndoAdds } /// - /// Commits this event. + /// Commits this event. /// internal void Commit(UndoEngine engine) { @@ -1139,7 +1139,7 @@ internal void Commit(UndoEngine engine) } /// - /// Actually performs the undo action. + /// Actually performs the undo action. /// public override void Undo(UndoEngine engine) { @@ -1183,7 +1183,7 @@ private sealed class ChangeUndoEvent : UndoEvent private bool _savedAfterState; /// - /// Creates a new component change undo event. This event consists of a before and after snapshot of a single component. A snapshot will not be taken if a name for the component cannot be determined. + /// Creates a new component change undo event. This event consists of a before and after snapshot of a single component. A snapshot will not be taken if a name for the component cannot be determined. /// public ChangeUndoEvent(UndoEngine engine, ComponentChangingEventArgs e, bool serializeBeforeState) { @@ -1205,14 +1205,14 @@ public ComponentChangingEventArgs ComponentChangingEventArgs } /// - /// Indicates that undoing this event may cause side effects in other objects. - /// Chagne events fall into this category because, for example, a change involving adding an object to one collection may have a side effect of removing it from another collection. Events with side effects are grouped at undo time so all their BeforeUndo methods are called before their Undo methods. - /// Events without side effects have their BeforeUndo called and then their Undo called immediately after. + /// Indicates that undoing this event may cause side effects in other objects. + /// Chagne events fall into this category because, for example, a change involving adding an object to one collection may have a side effect of removing it from another collection. Events with side effects are grouped at undo time so all their BeforeUndo methods are called before their Undo methods. + /// Events without side effects have their BeforeUndo called and then their Undo called immediately after. /// public override bool CausesSideEffects { get { return true; } } /// - /// Returns true if the change event has been comitted. + /// Returns true if the change event has been comitted. /// public bool Committed { @@ -1223,7 +1223,7 @@ public bool Committed } /// - /// Returns the component this change event is currently tracking. This will return null once the change event is committed. + /// Returns the component this change event is currently tracking. This will return null once the change event is committed. /// public object OpenComponent { @@ -1234,7 +1234,7 @@ public object OpenComponent } /// - /// Called before Undo is called. All undo events get their BeforeUndo called, and then they all get their Undo called. This allows the undo event to examine the state of the world before other undo events mess with it. + /// Called before Undo is called. All undo events get their BeforeUndo called, and then they all get their Undo called. This allows the undo event to examine the state of the world before other undo events mess with it. /// public override void BeforeUndo(UndoEngine engine) { @@ -1246,7 +1246,7 @@ public override void BeforeUndo(UndoEngine engine) } /// - /// Determines if this + /// Determines if this /// public bool ContainsChange(MemberDescriptor desc) { @@ -1265,7 +1265,7 @@ public bool ContainsChange(MemberDescriptor desc) } /// - /// Commits the unit. Comitting the unit saves the "after" snapshot of the unit. If commit is called multiple times only the first commit is registered. + /// Commits the unit. Comitting the unit saves the "after" snapshot of the unit. If commit is called multiple times only the first commit is registered. /// public void Commit(UndoEngine engine) { @@ -1319,7 +1319,7 @@ private SerializationStore Serialize(UndoEngine engine, object component, Member } /// - /// Performs the actual undo. AFter it finishes it will reverse the role of _before and _after + /// Performs the actual undo. AFter it finishes it will reverse the role of _before and _after /// public override void Undo(UndoEngine engine) { @@ -1346,7 +1346,7 @@ private sealed class RenameUndoEvent : UndoEvent private string _after; /// - /// Creates a new rename undo event. + /// Creates a new rename undo event. /// public RenameUndoEvent(string before, string after) { @@ -1356,7 +1356,7 @@ public RenameUndoEvent(string before, string after) } /// - /// Simply undoes a rename by setting the name back to the saved value. + /// Simply undoes a rename by setting the name back to the saved value. /// public override void Undo(UndoEngine engine) { @@ -1376,22 +1376,22 @@ public override void Undo(UndoEngine engine) private abstract class UndoEvent { /// - /// Indicates that undoing this event may cause side effects in other objects. - /// Chagne events fall into this category because, for example, a change involving adding an object to one collection may have a side effect of removing it from another collection. - /// Events with side effects are grouped at undo time so all their BeforeUndo methods are called before their Undo methods. - /// Events without side effects have their BeforeUndo called and then their Undo called immediately after. + /// Indicates that undoing this event may cause side effects in other objects. + /// Chagne events fall into this category because, for example, a change involving adding an object to one collection may have a side effect of removing it from another collection. + /// Events with side effects are grouped at undo time so all their BeforeUndo methods are called before their Undo methods. + /// Events without side effects have their BeforeUndo called and then their Undo called immediately after. /// public virtual bool CausesSideEffects { get { return false; } } /// - /// Called before Undo is called. All undo events get their BeforeUndo called, and then they all get their Undo called. This allows the undo event to examine the state of the world before other undo events mess with it. BeforeUndo returns true if before undo was supported, and false if not. If before undo is not supported, the undo unit should be undone immediately. + /// Called before Undo is called. All undo events get their BeforeUndo called, and then they all get their Undo called. This allows the undo event to examine the state of the world before other undo events mess with it. BeforeUndo returns true if before undo was supported, and false if not. If before undo is not supported, the undo unit should be undone immediately. /// public virtual void BeforeUndo(UndoEngine engine) { } /// - /// Called by the undo unit when it wants to undo this bit of work. + /// Called by the undo unit when it wants to undo this bit of work. /// public abstract void Undo(UndoEngine engine); } diff --git a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/WindowsFormsDesignerOptionService.cs b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/WindowsFormsDesignerOptionService.cs index c44cada0915..971ddb70bb1 100644 --- a/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/WindowsFormsDesignerOptionService.cs +++ b/src/System.Windows.Forms.Design/src/System/Windows/Forms/Design/WindowsFormsDesignerOptionService.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Design { /// - /// Makes the DesignerOptions queryable through the IDesignerOption service. + /// Makes the DesignerOptions queryable through the IDesignerOption service. /// public class WindowsFormsDesignerOptionService : DesignerOptionService { @@ -16,8 +16,8 @@ public class WindowsFormsDesignerOptionService : DesignerOptionService public virtual DesignerOptions CompatibilityOptions => _options ?? (_options = new DesignerOptions()); /// - /// This method is called on demand the first time a user asks for child options or - /// properties of an options collection. + /// This method is called on demand the first time a user asks for child options or + /// properties of an options collection. /// protected override void PopulateOptionCollection(DesignerOptionCollection options) { diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/IPropertyValueUIService.cs b/src/System.Windows.Forms/src/System/Drawing/Design/IPropertyValueUIService.cs index b8af0c09544..8b249309321 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/IPropertyValueUIService.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/IPropertyValueUIService.cs @@ -7,7 +7,7 @@ namespace System.Drawing.Design { /// - /// Provides an interface to manage the images, ToolTips, and event handlers for the properties of a component displayed in a property browser. + /// Provides an interface to manage the images, ToolTips, and event handlers for the properties of a component displayed in a property browser. /// public interface IPropertyValueUIService { @@ -17,13 +17,13 @@ public interface IPropertyValueUIService event EventHandler PropertyUIValueItemsChanged; /// - /// Adds the specified to this service. + /// Adds the specified to this service. /// /// The UI handler to add. void AddPropertyValueUIHandler(PropertyValueUIHandler newHandler); /// - /// Gets the objects that match the specified context and property descriptor characteristics. + /// Gets the objects that match the specified context and property descriptor characteristics. /// /// An array of objects that match the specified parameters. /// An that can be used to gain additional context information. @@ -36,7 +36,7 @@ public interface IPropertyValueUIService void NotifyPropertyValueUIItemsChanged(); /// - /// Removes a from this service. + /// Removes a from this service. /// /// The handler to remove. void RemovePropertyValueUIHandler(PropertyValueUIHandler newHandler); diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/PaintValueEventArgs.cs b/src/System.Windows.Forms/src/System/Drawing/Design/PaintValueEventArgs.cs index de8ffbc430f..172ef106279 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/PaintValueEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/PaintValueEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Drawing.Design { /// - /// Object passed as an argument to containing information needed by the editor to paint the given value. + /// Object passed as an argument to containing information needed by the editor to paint the given value. /// public class PaintValueEventArgs : EventArgs { /// - /// Constructor that accepts the information needed by the editor to paint the given value. + /// Constructor that accepts the information needed by the editor to paint the given value. /// /// The in which this value appears in. /// The value to paint. @@ -42,7 +42,7 @@ public PaintValueEventArgs(ITypeDescriptorContext context, object value, Graphic public Graphics Graphics { get; } /// - /// Value to paint. + /// Value to paint. /// public object Value { get; } } diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItem.cs b/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItem.cs index 730bd363f1d..da409ae806b 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItem.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItem.cs @@ -5,7 +5,7 @@ namespace System.Drawing.Design { /// - /// Provides information about the property value UI including the invoke handler, tool tip and glyph icon. + /// Provides information about the property value UI including the invoke handler, tool tip and glyph icon. /// public class PropertyValueUIItem { diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItemInvokeHandler.cs b/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItemInvokeHandler.cs index efdb9f67690..8c77020ccc1 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItemInvokeHandler.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/PropertyValueUIItemInvokeHandler.cs @@ -7,7 +7,7 @@ namespace System.Drawing.Design { /// - /// Represents the method that will handle the event raised when an icon in the properties window associated with a is double-clicked. + /// Represents the method that will handle the event raised when an icon in the properties window associated with a is double-clicked. /// /// The for the property associated with the icon that was double-clicked. /// The property associated with the icon that was double-clicked. diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditor.cs b/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditor.cs index 280432afe32..5c1471b896a 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditor.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditor.cs @@ -10,7 +10,7 @@ namespace System.Drawing.Design { /// - /// Provides a base class for editors that may provide users with a user interface to visually edit the values of the supported type or types. + /// Provides a base class for editors that may provide users with a user interface to visually edit the values of the supported type or types. /// public class UITypeEditor { @@ -34,19 +34,19 @@ static UITypeEditor() } /// - /// Determines if drop-down editors should be resizable by the user. + /// Determines if drop-down editors should be resizable by the user. /// public virtual bool IsDropDownResizable => false; /// - /// Edits the specified value using the editor style provided by . + /// Edits the specified value using the editor style provided by . /// /// An that this editor can use to obtain services. /// The object to edit. public object EditValue(IServiceProvider provider, object value) => EditValue(null, provider, value); /// - /// Edits the specified value using the editor style provided by . + /// Edits the specified value using the editor style provided by . /// /// The that can be used to gain additional context information. /// The that this editor can use to obtain services. @@ -54,29 +54,29 @@ static UITypeEditor() public virtual object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) => value; /// - /// Gets the of the Edit method. + /// Gets the of the Edit method. /// public UITypeEditorEditStyle GetEditStyle() => GetEditStyle(null); /// - /// Gets a value indicating whether this editor supports painting a representation of an object's value. + /// Gets a value indicating whether this editor supports painting a representation of an object's value. /// public bool GetPaintValueSupported() => GetPaintValueSupported(null); /// - /// Gets a value indicating whether this editor supports painting a representation of an object's value. + /// Gets a value indicating whether this editor supports painting a representation of an object's value. /// /// The that can be used to gain additional context information. public virtual bool GetPaintValueSupported(ITypeDescriptorContext context) => false; /// - /// Gets the editing style of the Edit method. + /// Gets the editing style of the Edit method. /// /// The that can be used to gain additional context information. public virtual UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) => UITypeEditorEditStyle.None; /// - /// Paints a representative value of the specified object to the specified canvas. + /// Paints a representative value of the specified object to the specified canvas. /// /// The object whose value this type editor will display. /// A drawing canvas on which to paint the representation of the object's value. @@ -84,7 +84,7 @@ static UITypeEditor() public void PaintValue(object value, Graphics canvas, Rectangle rectangle) => PaintValue(new PaintValueEventArgs(null, value, canvas, rectangle)); /// - /// Paints a representative value of the specified object to the specified canvas. + /// Paints a representative value of the specified object to the specified canvas. /// /// A that indicates what to paint and where to paint it. public virtual void PaintValue(PaintValueEventArgs e) { } diff --git a/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditorEditStyle.cs b/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditorEditStyle.cs index e1bf903206c..c2346bbcf06 100644 --- a/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditorEditStyle.cs +++ b/src/System.Windows.Forms/src/System/Drawing/Design/UITypeEditorEditStyle.cs @@ -5,7 +5,7 @@ namespace System.Drawing.Design { /// - /// Specifies identifiers to indicate the style of a . + /// Specifies identifiers to indicate the style of a . /// public enum UITypeEditorEditStyle { diff --git a/src/System.Windows.Forms/src/System/Resources/IAliasResolver.cs b/src/System.Windows.Forms/src/System/Resources/IAliasResolver.cs index 12d07eaa4b0..ea4ee53b933 100644 --- a/src/System.Windows.Forms/src/System/Resources/IAliasResolver.cs +++ b/src/System.Windows.Forms/src/System/Resources/IAliasResolver.cs @@ -7,7 +7,7 @@ namespace System.Resources { /// - /// Summary of IAliasResolver. + /// Summary of IAliasResolver. /// internal interface IAliasResolver { diff --git a/src/System.Windows.Forms/src/System/Resources/ResXDataNode.cs b/src/System.Windows.Forms/src/System/Resources/ResXDataNode.cs index 87fecc30ba6..e6890f83bc4 100644 --- a/src/System.Windows.Forms/src/System/Resources/ResXDataNode.cs +++ b/src/System.Windows.Forms/src/System/Resources/ResXDataNode.cs @@ -1053,7 +1053,7 @@ public Type GetType(string name, bool throwOnError, bool ignoreCase) } /// - /// This is matching %windir%\Microsoft.NET\Framework*, so both 32bit and 64bit framework will be covered. + /// This is matching %windir%\Microsoft.NET\Framework*, so both 32bit and 64bit framework will be covered. /// private bool IsDotNetAssembly(string assemblyPath) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs index a68598dd5e1..a3d0e2c2174 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleEvents.cs @@ -279,27 +279,27 @@ public enum AccessibleEvents /// keystrokes are going at a given moment. Hence only send a notification /// about where the NEW focus is going. A NEW item getting the focus already /// implies that the OLD item is losing it. - /// + /// /// SELECTION however can be multiple. Hence the different SELECTION /// notifications. Here's when to use each: - /// + /// /// (1) Send a SELECTION notification in the simple single selection /// case (like the focus) when the item with the selection is /// merely moving to a different item within a container. hwnd + ID /// is the container control, idChildItem is the new child with the /// selection. - /// + /// /// (2) Send a SELECTIONADD notification when a new item has simply been added /// to the selection within a container. This is appropriate when the /// number of newly selected items is very small. hwnd + ID is the /// container control, idChildItem is the new child added to the selection. - /// + /// /// (3) Send a SELECTIONREMOVE notification when a new item has simply been /// removed from the selection within a container. This is appropriate /// when the number of newly selected items is very small, just like /// SELECTIONADD. hwnd + ID is the container control, idChildItem is the /// new child removed from the selection. - /// + /// /// (4) Send a SELECTIONWITHIN notification when the selected items within a /// control have changed substantially. Rather than propagate a large /// number of changes to reflect removal for some items, addition of diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleNavigation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleNavigation.cs index 1d996b392ed..4ee369d198d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleNavigation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleNavigation.cs @@ -5,51 +5,51 @@ namespace System.Windows.Forms { /// - /// Specifies values for navigating between accessible objects. + /// Specifies values for navigating between accessible objects. /// public enum AccessibleNavigation { /// - /// Navigation to a sibling object located below the starting object. + /// Navigation to a sibling object located below the starting object. /// Down = 0x2, /// - /// Navigation to the first child of the object. + /// Navigation to the first child of the object. /// FirstChild = 0x7, /// - /// Navigation to the last child of the object + /// Navigation to the last child of the object /// LastChild = 0x8, /// - /// Navigation to the sibling object located to the left of the - /// starting object. + /// Navigation to the sibling object located to the left of the + /// starting object. /// Left = 0x3, /// - /// Navigation to the next logical object, generally from the starting - /// object to a sibling object. + /// Navigation to the next logical object, generally from the starting + /// object to a sibling object. /// Next = 0x5, /// - /// Navigation to the previous logical object, generally from a sibling - /// object to the starting object. + /// Navigation to the previous logical object, generally from a sibling + /// object to the starting object. /// Previous = 0x6, /// - /// Navigation to the sibling object located to the right of the - /// starting object. + /// Navigation to the sibling object located to the right of the + /// starting object. /// Right = 0x4, /// - /// Navigation to a sibling object located above the starting object. + /// Navigation to a sibling object located above the starting object. /// Up = 0x1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleObject.cs index 44f970dfabb..bc1c938ab8a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleObject.cs @@ -14,8 +14,8 @@ namespace System.Windows.Forms { /// - /// Provides an implementation for an object that can be inspected by an - /// accessibility application. + /// Provides an implementation for an object that can be inspected by an + /// accessibility application. /// [ComVisible(true)] public class AccessibleObject : StandardOleMarshalObject, @@ -44,13 +44,13 @@ public class AccessibleObject : StandardOleMarshalObject, UnsafeNativeMethods.IScrollItemProvider { /// - /// Specifies the interface used by this + /// Specifies the interface used by this /// . /// private IAccessible systemIAccessible = null; /// - /// Specifies the used by this + /// Specifies the used by this /// . /// private UnsafeNativeMethods.IEnumVariant systemIEnumVariant = null; @@ -83,7 +83,7 @@ private AccessibleObject(IAccessible iAcc) } /// - /// Gets the bounds of the accessible object, in screen coordinates. + /// Gets the bounds of the accessible object, in screen coordinates. /// public virtual Rectangle Bounds { @@ -107,7 +107,7 @@ public virtual Rectangle Bounds } /// - /// Gets a description of the default action for an object. + /// Gets a description of the default action for an object. /// public virtual string DefaultAction { @@ -130,7 +130,7 @@ public virtual string DefaultAction } /// - /// Gets a description of the object's visual appearance to the user. + /// Gets a description of the object's visual appearance to the user. /// public virtual string Description { @@ -157,7 +157,7 @@ private UnsafeNativeMethods.IEnumVariant EnumVariant } /// - /// Gets a description of what the object does or how the object is used. + /// Gets a description of what the object does or how the object is used. /// public virtual string Help { @@ -179,7 +179,7 @@ public virtual string Help } /// - /// Gets the object shortcut key or access key for an accessible object. + /// Gets the object shortcut key or access key for an accessible object. /// public virtual string KeyboardShortcut { @@ -201,7 +201,7 @@ public virtual string KeyboardShortcut } /// - /// Gets or sets the object name. + /// Gets or sets the object name. /// public virtual string Name { @@ -239,8 +239,8 @@ public virtual string Name } /// - /// When overridden in a derived class, gets or sets the parent of an - /// accessible object. + /// When overridden in a derived class, gets or sets the parent of an + /// accessible object. /// public virtual AccessibleObject Parent { @@ -258,7 +258,7 @@ public virtual AccessibleObject Parent } /// - /// Gets the role of this accessible object. + /// Gets the role of this accessible object. /// public virtual AccessibleRole Role { @@ -276,7 +276,7 @@ public virtual AccessibleRole Role } /// - /// Gets the state of this accessible object. + /// Gets the state of this accessible object. /// public virtual AccessibleStates State { @@ -294,7 +294,7 @@ public virtual AccessibleStates State } /// - /// Gets or sets the value of an accessible object. + /// Gets or sets the value of an accessible object. /// public virtual string Value { @@ -332,43 +332,43 @@ public virtual string Value } /// - /// When overridden in a derived class, gets the accessible child - /// corresponding to the specified index. + /// When overridden in a derived class, gets the accessible child + /// corresponding to the specified index. /// public virtual AccessibleObject GetChild(int index) => null; /// - /// When overridden in a derived class, gets the number of children - /// belonging to an accessible object. + /// When overridden in a derived class, gets the number of children + /// belonging to an accessible object. /// public virtual int GetChildCount() => -1; /// - /// Mechanism for overriding default IEnumVariant behavior of the 'inner' - /// system accessible object (IEnumVariant is how a system accessible - /// object exposes its ordered list of child objects). + /// Mechanism for overriding default IEnumVariant behavior of the 'inner' + /// system accessible object (IEnumVariant is how a system accessible + /// object exposes its ordered list of child objects). /// - /// USAGE: Overridden method in derived class should return array of - /// integers representing new order to be imposed on the child accessible - /// object collection returned by the system (which we assume will be a - /// set of accessible objects that represent the child windows, in z-order). - /// Each array element contains the original z-order based rank of the - /// child window that is to appear at that position in the new ordering. - /// Note: This array could also be used to filter out unwanted child - /// windows too, if necessary (not recommended). + /// USAGE: Overridden method in derived class should return array of + /// integers representing new order to be imposed on the child accessible + /// object collection returned by the system (which we assume will be a + /// set of accessible objects that represent the child windows, in z-order). + /// Each array element contains the original z-order based rank of the + /// child window that is to appear at that position in the new ordering. + /// Note: This array could also be used to filter out unwanted child + /// windows too, if necessary (not recommended). /// internal virtual int[] GetSysChildOrder() => null; /// - /// Mechanism for overriding default IAccessible.accNavigate behavior of - /// the 'inner' system accessible object (accNavigate is how you move - /// between parent, child and sibling accessible objects). + /// Mechanism for overriding default IAccessible.accNavigate behavior of + /// the 'inner' system accessible object (accNavigate is how you move + /// between parent, child and sibling accessible objects). /// - /// USAGE: 'navdir' indicates navigation operation to perform, relative to - /// this accessible object. - /// If operation is unsupported, return false to allow fall-back to default - /// system behavior. Otherwise return destination object in the out - /// parameter, or null to indicate 'off end of list'. + /// USAGE: 'navdir' indicates navigation operation to perform, relative to + /// this accessible object. + /// If operation is unsupported, return false to allow fall-back to default + /// system behavior. Otherwise return destination object in the out + /// parameter, or null to indicate 'off end of list'. /// internal virtual bool GetSysChild(AccessibleNavigation navdir, out AccessibleObject accessibleObject) { @@ -377,8 +377,8 @@ internal virtual bool GetSysChild(AccessibleNavigation navdir, out AccessibleObj } /// - /// When overridden in a derived class, gets the object that has the - /// keyboard focus. + /// When overridden in a derived class, gets the object that has the + /// keyboard focus. /// public virtual AccessibleObject GetFocused() { @@ -418,8 +418,8 @@ public virtual AccessibleObject GetFocused() } /// - /// Gets an identifier for a Help topic and the path to the Help file - /// associated with this accessible object. + /// Gets an identifier for a Help topic and the path to the Help file + /// associated with this accessible object. /// public virtual int GetHelpTopic(out string fileName) { @@ -439,7 +439,7 @@ public virtual int GetHelpTopic(out string fileName) } /// - /// When overridden in a derived class, gets the currently selected child. + /// When overridden in a derived class, gets the currently selected child. /// public virtual AccessibleObject GetSelected() { @@ -480,7 +480,7 @@ public virtual AccessibleObject GetSelected() } /// - /// Return the child object at the given screen coordinates. + /// Return the child object at the given screen coordinates. /// public virtual AccessibleObject HitTest(int x, int y) { @@ -774,7 +774,7 @@ internal virtual UnsafeNativeMethods.IRawElementProviderSimple ItemSelectionCont } /// - /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. + /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. /// /// The parent accessible object. internal virtual void SetParent(AccessibleObject parent) @@ -782,7 +782,7 @@ internal virtual void SetParent(AccessibleObject parent) } /// - /// Sets the detachable child accessible object which may be added or removed to/from hierachy nodes. + /// Sets the detachable child accessible object which may be added or removed to/from hierachy nodes. /// /// The child accessible object. internal virtual void SetDetachableChild(AccessibleObject child) @@ -1027,7 +1027,7 @@ UnsafeNativeMethods.IRawElementProviderSimple UnsafeNativeMethods.IGridItemProvi } /// - /// Perform the default action + /// Perform the default action /// void IAccessible.accDoDefaultAction(object childID) { @@ -1068,7 +1068,7 @@ void IAccessible.accDoDefaultAction(object childID) } /// - /// Perform a hit test + /// Perform a hit test /// object IAccessible.accHitTest(int xLeft, int yTop) { @@ -1099,7 +1099,7 @@ object IAccessible.accHitTest(int xLeft, int yTop) } /// - /// The location of the Accessible object + /// The location of the Accessible object /// void IAccessible.accLocation( out int pxLeft, @@ -1173,7 +1173,7 @@ void IAccessible.accLocation( } /// - /// Navigate to another accessible object. + /// Navigate to another accessible object. /// object IAccessible.accNavigate(int navDir, object childID) { @@ -1222,7 +1222,7 @@ object IAccessible.accNavigate(int navDir, object childID) } /// - /// Select an accessible object. + /// Select an accessible object. /// void IAccessible.accSelect(int flagsSelect, object childID) { @@ -1264,7 +1264,7 @@ void IAccessible.accSelect(int flagsSelect, object childID) } /// - /// Performs the default action associated with this accessible object. + /// Performs the default action associated with this accessible object. /// public virtual void DoDefaultAction() { @@ -1284,7 +1284,7 @@ public virtual void DoDefaultAction() } /// - /// Returns a child Accessible object + /// Returns a child Accessible object /// object IAccessible.get_accChild(object childID) { @@ -1326,7 +1326,7 @@ object IAccessible.get_accChild(object childID) } /// - /// Return the number of children + /// Return the number of children /// int IAccessible.accChildCount { @@ -1358,7 +1358,7 @@ int IAccessible.accChildCount } /// - /// Return the default action + /// Return the default action /// string IAccessible.get_accDefaultAction(object childID) { @@ -1396,7 +1396,7 @@ string IAccessible.get_accDefaultAction(object childID) } /// - /// Return the object or child description + /// Return the object or child description /// string IAccessible.get_accDescription(object childID) { @@ -1433,7 +1433,7 @@ string IAccessible.get_accDescription(object childID) } /// - /// Returns the appropriate child from the Accessible Child Collection, if available + /// Returns the appropriate child from the Accessible Child Collection, if available /// private AccessibleObject GetAccessibleChild(object childID) { @@ -1450,7 +1450,7 @@ private AccessibleObject GetAccessibleChild(object childID) } /// - /// Return the object or child focus + /// Return the object or child focus /// object IAccessible.accFocus { @@ -1484,7 +1484,7 @@ object IAccessible.accFocus } /// - /// Return help for this accessible object. + /// Return help for this accessible object. /// string IAccessible.get_accHelp(object childID) { @@ -1520,7 +1520,7 @@ string IAccessible.get_accHelp(object childID) } /// - /// Return the object or child help topic + /// Return the object or child help topic /// int IAccessible.get_accHelpTopic(out string pszHelpFile, object childID) { @@ -1557,7 +1557,7 @@ int IAccessible.get_accHelpTopic(out string pszHelpFile, object childID) } /// - /// Return the object or child keyboard shortcut + /// Return the object or child keyboard shortcut /// string IAccessible.get_accKeyboardShortcut(object childID) { @@ -1598,7 +1598,7 @@ internal virtual string get_accKeyboardShortcutInternal(object childID) } /// - /// Return the object or child name + /// Return the object or child name /// string IAccessible.get_accName(object childID) { @@ -1649,7 +1649,7 @@ internal virtual string get_accNameInternal(object childID) } /// - /// Return the parent object + /// Return the parent object /// object IAccessible.accParent { @@ -1673,8 +1673,8 @@ object IAccessible.accParent } /// - /// The role property describes an object's purpose in terms of its - /// relationship with sibling or child objects. + /// The role property describes an object's purpose in terms of its + /// relationship with sibling or child objects. /// object IAccessible.get_accRole(object childID) { @@ -1705,7 +1705,7 @@ object IAccessible.get_accRole(object childID) } /// - /// Return the object or child selection + /// Return the object or child selection /// object IAccessible.accSelection { @@ -1739,7 +1739,7 @@ object IAccessible.accSelection } /// - /// Return the object or child state + /// Return the object or child state /// object IAccessible.get_accState(object childID) { @@ -1768,7 +1768,7 @@ object IAccessible.get_accState(object childID) } /// - /// Return the object or child value + /// Return the object or child value /// string IAccessible.get_accValue(object childID) { @@ -1805,7 +1805,7 @@ string IAccessible.get_accValue(object childID) } /// - /// Set the object or child name + /// Set the object or child name /// void IAccessible.set_accName(object childID, string newName) { @@ -1834,7 +1834,7 @@ void IAccessible.set_accName(object childID, string newName) } /// - /// Set the object or child value + /// Set the object or child value /// void IAccessible.set_accValue(object childID, string newValue) { @@ -1872,19 +1872,19 @@ void IAccessible.set_accValue(object childID, string newValue) } /// - /// Now that AccessibleObject is used to wrap all system-provided (OLEACC.DLL) accessible - /// objects, it needs to implement IOleWindow and pass this down to the inner object. This is - /// necessary because the OS function WindowFromAccessibleObject() walks up the parent chain - /// looking for the first object that implements IOleWindow, and uses that to get the hwnd. + /// Now that AccessibleObject is used to wrap all system-provided (OLEACC.DLL) accessible + /// objects, it needs to implement IOleWindow and pass this down to the inner object. This is + /// necessary because the OS function WindowFromAccessibleObject() walks up the parent chain + /// looking for the first object that implements IOleWindow, and uses that to get the hwnd. /// - /// But this creates a new problem for AccessibleObjects that do NOT have windows, ie. which - /// represent simple elements. To the OS, these simple elements will now appear to implement - /// IOleWindow, so it will try to get hwnds from them - which they simply cannot provide. + /// But this creates a new problem for AccessibleObjects that do NOT have windows, ie. which + /// represent simple elements. To the OS, these simple elements will now appear to implement + /// IOleWindow, so it will try to get hwnds from them - which they simply cannot provide. /// - /// To work around this problem, the AccessibleObject for a simple element will delegate all - /// IOleWindow calls up the parent chain itself. This will stop at the first window-based - /// accessible object, which will be able to return an hwnd back to the OS. So we are - /// effectively 'preempting' what WindowFromAccessibleObject() would do. + /// To work around this problem, the AccessibleObject for a simple element will delegate all + /// IOleWindow calls up the parent chain itself. This will stop at the first window-based + /// accessible object, which will be able to return an hwnd back to the OS. So we are + /// effectively 'preempting' what WindowFromAccessibleObject() would do. /// int UnsafeNativeMethods.IOleWindow.GetWindow(out IntPtr hwnd) { @@ -1907,7 +1907,7 @@ int UnsafeNativeMethods.IOleWindow.GetWindow(out IntPtr hwnd) } /// - /// See GetWindow() above for details. + /// See GetWindow() above for details. /// void UnsafeNativeMethods.IOleWindow.ContextSensitiveHelp(int fEnterMode) { @@ -1930,7 +1930,7 @@ void UnsafeNativeMethods.IOleWindow.ContextSensitiveHelp(int fEnterMode) } /// - /// Clone this accessible object. + /// Clone this accessible object. /// void UnsafeNativeMethods.IEnumVariant.Clone(UnsafeNativeMethods.IEnumVariant[] v) { @@ -1938,7 +1938,7 @@ void UnsafeNativeMethods.IEnumVariant.Clone(UnsafeNativeMethods.IEnumVariant[] v } /// - /// Obtain the next n children of this accessible object. + /// Obtain the next n children of this accessible object. /// int UnsafeNativeMethods.IEnumVariant.Next(int n, IntPtr rgvar, int[] ns) { @@ -1946,17 +1946,17 @@ int UnsafeNativeMethods.IEnumVariant.Next(int n, IntPtr rgvar, int[] ns) } /// - /// Resets the child accessible object enumerator. + /// Resets the child accessible object enumerator. /// void UnsafeNativeMethods.IEnumVariant.Reset() => EnumVariant.Reset(); /// - /// Skip the next n child accessible objects + /// Skip the next n child accessible objects /// void UnsafeNativeMethods.IEnumVariant.Skip(int n) => EnumVariant.Skip(n); /// - /// When overridden in a derived class, navigates to another object. + /// When overridden in a derived class, navigates to another object. /// public virtual AccessibleObject Navigate(AccessibleNavigation navdir) { @@ -2008,7 +2008,7 @@ public virtual AccessibleObject Navigate(AccessibleNavigation navdir) } /// - /// Selects this accessible object. + /// Selects this accessible object. /// public virtual void Select(AccessibleSelection flags) { @@ -2047,19 +2047,19 @@ private IAccessible AsIAccessible(AccessibleObject obj) } /// - /// Indicates what kind of 'inner' system accessible object we are using as our fall-back - /// implementation of IAccessible (when the systemIAccessible member is not null). The inner - /// object is provided by OLEACC.DLL. Note that although the term 'id' is used, this value - /// really represents a category or type of accessible object. Ids are only unique among - /// accessible objects associated with the same window handle. Currently supported ids are... + /// Indicates what kind of 'inner' system accessible object we are using as our fall-back + /// implementation of IAccessible (when the systemIAccessible member is not null). The inner + /// object is provided by OLEACC.DLL. Note that although the term 'id' is used, this value + /// really represents a category or type of accessible object. Ids are only unique among + /// accessible objects associated with the same window handle. Currently supported ids are... /// - /// OBJID_CLIENT - represents the window's client area (including any child windows) - /// OBJID_WINDOW - represents the window's non-client area (including caption, frame controls and scrollbars) + /// OBJID_CLIENT - represents the window's client area (including any child windows) + /// OBJID_WINDOW - represents the window's non-client area (including caption, frame controls and scrollbars) /// - /// NOTE: When the id is OBJID_WINDOW, we short-circuit most of the virtual override behavior of - /// AccessibleObject, and turn the object into a simple wrapper around the inner system object. So - /// for a *user-defined* accessible object, that has NO inner object, its important that the id is - /// left as OBJID_CLIENT, otherwise the object will be short-circuited into a total NOP! + /// NOTE: When the id is OBJID_WINDOW, we short-circuit most of the virtual override behavior of + /// AccessibleObject, and turn the object into a simple wrapper around the inner system object. So + /// for a *user-defined* accessible object, that has NO inner object, its important that the id is + /// left as OBJID_CLIENT, otherwise the object will be short-circuited into a total NOP! /// internal int AccessibleObjectId { @@ -2068,14 +2068,14 @@ internal int AccessibleObjectId } /// - /// Indicates whether this accessible object represents the client area of - /// the window. + /// Indicates whether this accessible object represents the client area of + /// the window. /// internal bool IsClientObject => AccessibleObjectId == NativeMethods.OBJID_CLIENT; /// - /// Indicates whether this accessible object represents the non-client - /// area of the window. + /// Indicates whether this accessible object represents the non-client + /// area of the window. /// internal bool IsNonClientObject => AccessibleObjectId == NativeMethods.OBJID_WINDOW; @@ -2115,12 +2115,12 @@ protected void UseStdAccessibleObjects(IntPtr handle, int objid) } /// - /// Performs custom navigation between parent/child/sibling accessible - /// objects. This is basically just a wrapper for GetSysChild(), that - /// does some of the dirty work, such as wrapping the returned object - /// in a VARIANT. Usage is similar to GetSysChild(). Called prior to - /// calling IAccessible.accNavigate on the 'inner' system accessible - /// object. + /// Performs custom navigation between parent/child/sibling accessible + /// objects. This is basically just a wrapper for GetSysChild(), that + /// does some of the dirty work, such as wrapping the returned object + /// in a VARIANT. Usage is similar to GetSysChild(). Called prior to + /// calling IAccessible.accNavigate on the 'inner' system accessible + /// object. /// private bool SysNavigate(int navDir, object childID, out object retObject) { @@ -2146,7 +2146,7 @@ private bool SysNavigate(int navDir, object childID, out object retObject) } /// - /// Make sure that the childID is valid. + /// Make sure that the childID is valid. /// internal void ValidateChildID(ref object childID) { @@ -2185,9 +2185,9 @@ private AccessibleObject WrapIAccessible(object iacc) } /// - /// Return the requested method if it is implemented by the Reflection object. The - /// match is based upon the name and DescriptorInfo which describes the signature - /// of the method. + /// Return the requested method if it is implemented by the Reflection object. The + /// match is based upon the name and DescriptorInfo which describes the signature + /// of the method. /// MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr, Binder binder, Type[] types, ParameterModifier[] modifiers) { @@ -2195,9 +2195,9 @@ MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr, Binder bind } /// - /// Return the requested method if it is implemented by the Reflection object. The - /// match is based upon the name of the method. If the object implementes multiple methods - /// with the same name an AmbiguousMatchException is thrown. + /// Return the requested method if it is implemented by the Reflection object. The + /// match is based upon the name of the method. If the object implementes multiple methods + /// with the same name an AmbiguousMatchException is thrown. /// MethodInfo IReflect.GetMethod(string name, BindingFlags bindingAttr) { @@ -2210,9 +2210,9 @@ MethodInfo[] IReflect.GetMethods(BindingFlags bindingAttr) } /// - /// Return the requestion field if it is implemented by the Reflection - /// object. The match is based upon a name. There cannot be more than - /// a single field with a name. + /// Return the requestion field if it is implemented by the Reflection + /// object. The match is based upon a name. There cannot be more than + /// a single field with a name. /// FieldInfo IReflect.GetField(string name, BindingFlags bindingAttr) { @@ -2225,9 +2225,9 @@ FieldInfo[] IReflect.GetFields(BindingFlags bindingAttr) } /// - /// Return the property based upon name. If more than one property has - /// the given name an AmbiguousMatchException will be thrown. Returns - /// null if no property is found. + /// Return the property based upon name. If more than one property has + /// the given name an AmbiguousMatchException will be thrown. Returns + /// null if no property is found. /// PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr) { @@ -2235,8 +2235,8 @@ PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr) } /// - /// Return the property based upon the name and Descriptor info describing - /// the property indexing. Return null if no property is found. + /// Return the property based upon the name and Descriptor info describing + /// the property indexing. Return null if no property is found. /// PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr, Binder binder, Type returnType, Type[] types, ParameterModifier[] modifiers) { @@ -2244,8 +2244,8 @@ PropertyInfo IReflect.GetProperty(string name, BindingFlags bindingAttr, Binder } /// - /// Returns an array of PropertyInfos for all the properties defined on - /// the Reflection object. + /// Returns an array of PropertyInfos for all the properties defined on + /// the Reflection object. /// PropertyInfo[] IReflect.GetProperties(BindingFlags bindingAttr) { @@ -2253,7 +2253,7 @@ PropertyInfo[] IReflect.GetProperties(BindingFlags bindingAttr) } /// - /// Return an array of members which match the passed in name. + /// Return an array of members which match the passed in name. /// MemberInfo[] IReflect.GetMember(string name, BindingFlags bindingAttr) { @@ -2261,7 +2261,7 @@ MemberInfo[] IReflect.GetMember(string name, BindingFlags bindingAttr) } /// - /// Return an array of all of the members defined for this object. + /// Return an array of all of the members defined for this object. /// MemberInfo[] IReflect.GetMembers(BindingFlags bindingAttr) { @@ -2269,36 +2269,36 @@ MemberInfo[] IReflect.GetMembers(BindingFlags bindingAttr) } /// - /// Description of the Binding Process. - /// We must invoke a method that is accessable and for which the provided - /// parameters have the most specific match. A method may be called if - /// 1. The number of parameters in the method declaration equals the number of - /// arguments provided to the invocation - /// 2. The type of each argument can be converted by the binder to the - /// type of the type of the parameter. + /// Description of the Binding Process. + /// We must invoke a method that is accessable and for which the provided + /// parameters have the most specific match. A method may be called if + /// 1. The number of parameters in the method declaration equals the number of + /// arguments provided to the invocation + /// 2. The type of each argument can be converted by the binder to the + /// type of the type of the parameter. /// - /// The binder will find all of the matching methods. These method are found based - /// upon the type of binding requested (MethodInvoke, Get/Set Properties). The set - /// of methods is filtered by the name, number of arguments and a set of search modifiers - /// defined in the Binder. + /// The binder will find all of the matching methods. These method are found based + /// upon the type of binding requested (MethodInvoke, Get/Set Properties). The set + /// of methods is filtered by the name, number of arguments and a set of search modifiers + /// defined in the Binder. /// - /// After the method is selected, it will be invoked. Accessability is checked - /// at that point. The search may be control which set of methods are searched based - /// upon the accessibility attribute associated with the method. + /// After the method is selected, it will be invoked. Accessability is checked + /// at that point. The search may be control which set of methods are searched based + /// upon the accessibility attribute associated with the method. /// - /// The BindToMethod method is responsible for selecting the method to be invoked. - /// For the default binder, the most specific method will be selected. + /// The BindToMethod method is responsible for selecting the method to be invoked. + /// For the default binder, the most specific method will be selected. /// - /// This will invoke a specific member... - /// @exception If invokeAttr is CreateInstance then all other - /// Access types must be undefined. If not we throw an ArgumentException. - /// @exception If the invokeAttr is not CreateInstance then an - /// ArgumentException when name is null. - /// @exception ArgumentException when invokeAttr does not specify the type - /// @exception ArgumentException when invokeAttr specifies both get and set of - /// a property or field. - /// @exception ArgumentException when invokeAttr specifies property set and - /// invoke method. + /// This will invoke a specific member... + /// @exception If invokeAttr is CreateInstance then all other + /// Access types must be undefined. If not we throw an ArgumentException. + /// @exception If the invokeAttr is not CreateInstance then an + /// ArgumentException when name is null. + /// @exception ArgumentException when invokeAttr does not specify the type + /// @exception ArgumentException when invokeAttr specifies both get and set of + /// a property or field. + /// @exception ArgumentException when invokeAttr specifies property set and + /// invoke method. /// object IReflect.InvokeMember(string name, BindingFlags invokeAttr, Binder binder, object target, object[] args, ParameterModifier[] modifiers, CultureInfo culture, string[] namedParameters) { @@ -2322,9 +2322,9 @@ object IReflect.InvokeMember(string name, BindingFlags invokeAttr, Binder binder } /// - /// Return the underlying Type that represents the IReflect Object. For - /// expando object, this is the (Object) IReflectInstance.GetType(). - /// For Type object it is this. + /// Return the underlying Type that represents the IReflect Object. For + /// expando object, this is the (Object) IReflectInstance.GetType(). + /// For Type object it is this. /// Type IReflect.UnderlyingSystemType => typeof(IAccessible); @@ -2379,16 +2379,16 @@ UnsafeNativeMethods.IRawElementProviderSimple UnsafeNativeMethods.ISelectionItem } /// - /// Raises the UIA Notification event. - /// The event is available starting with Windows 10, version 1709. + /// Raises the UIA Notification event. + /// The event is available starting with Windows 10, version 1709. /// /// The type of notification /// Indicates how to process notifications /// Notification text /// - /// True if operation succeeds. - /// False if the underlying windows infrastructure is not available or the operation had failed. - /// Use Marshal.GetLastWin32Error for details. + /// True if operation succeeds. + /// False if the underlying windows infrastructure is not available or the operation had failed. + /// Use Marshal.GetLastWin32Error for details. /// public bool RaiseAutomationNotification(AutomationNotificationKind notificationKind, AutomationNotificationProcessing notificationProcessing, string notificationText) { @@ -2418,8 +2418,8 @@ public bool RaiseAutomationNotification(AutomationNotificationKind notificationK } /// - /// Raises the LiveRegionChanged UIA event. - /// This method must be overridden in derived classes that support the UIA live region feature. + /// Raises the LiveRegionChanged UIA event. + /// This method must be overridden in derived classes that support the UIA live region feature. /// /// True if operation succeeds, False otherwise. public virtual bool RaiseLiveRegionChanged() @@ -2494,7 +2494,7 @@ void UnsafeNativeMethods.IEnumVariant.Clone(UnsafeNativeMethods.IEnumVariant[] v } /// - /// Resets the child accessible object enumerator. + /// Resets the child accessible object enumerator. /// void UnsafeNativeMethods.IEnumVariant.Reset() { @@ -2503,7 +2503,7 @@ void UnsafeNativeMethods.IEnumVariant.Reset() } /// - /// Skips the next n child accessible objects. + /// Skips the next n child accessible objects. /// void UnsafeNativeMethods.IEnumVariant.Skip(int n) { @@ -2512,7 +2512,7 @@ void UnsafeNativeMethods.IEnumVariant.Skip(int n) } /// - /// Gets the next n child accessible objects. + /// Gets the next n child accessible objects. /// int UnsafeNativeMethods.IEnumVariant.Next(int n, IntPtr rgvar, int[] ns) { @@ -2556,10 +2556,10 @@ int UnsafeNativeMethods.IEnumVariant.Next(int n, IntPtr rgvar, int[] ns) } /// - /// When we have the IEnumVariant of an accessible proxy provided by the system (ie. - /// OLEACC.DLL), we can fall back on that to return the children. Generally, the system - /// proxy will enumerate the child windows, create a suitable kind of child accessible - /// proxy for each one, and return a set of IDispatch interfaces to these proxy objects. + /// When we have the IEnumVariant of an accessible proxy provided by the system (ie. + /// OLEACC.DLL), we can fall back on that to return the children. Generally, the system + /// proxy will enumerate the child windows, create a suitable kind of child accessible + /// proxy for each one, and return a set of IDispatch interfaces to these proxy objects. /// private void NextFromSystem(int n, IntPtr rgvar, int[] ns) { @@ -2570,21 +2570,21 @@ private void NextFromSystem(int n, IntPtr rgvar, int[] ns) } /// - /// Sometimes we want to rely on the system-provided behavior to create - /// and return child accessible objects, but we want to impose a new - /// order on those objects (or even filter some objects out). + /// Sometimes we want to rely on the system-provided behavior to create + /// and return child accessible objects, but we want to impose a new + /// order on those objects (or even filter some objects out). /// - /// This method takes an array of ints that dictates the new order. - /// It queries the system for each child individually, and inserts the - /// result into the correct *new* position. + /// This method takes an array of ints that dictates the new order. + /// It queries the system for each child individually, and inserts the + /// result into the correct *new* position. /// - /// Note: This code has to make certain *assumptions* about OLEACC.DLL - /// proxy object behavior. However, this behavior is well documented. - /// We *assume* the proxy will return a set of child accessible objects - /// that correspond 1:1 with the owning control's child windows, and - /// that the default order it returns these objects in is z-order - /// (which also happens to be the order that children appear in the - /// Control.Controls[] collection). + /// Note: This code has to make certain *assumptions* about OLEACC.DLL + /// proxy object behavior. However, this behavior is well documented. + /// We *assume* the proxy will return a set of child accessible objects + /// that correspond 1:1 with the owning control's child windows, and + /// that the default order it returns these objects in is z-order + /// (which also happens to be the order that children appear in the + /// Control.Controls[] collection). /// private void NextFromSystemReordered(int n, IntPtr rgvar, int[] ns, int[] newOrder) { @@ -2605,9 +2605,9 @@ private void NextFromSystemReordered(int n, IntPtr rgvar, int[] ns, int[] newOrd } /// - /// If we have our own custom accessible child collection, return a set - /// of 1-based integer child ids, that the caller will eventually pass - /// back to us via IAccessible.get_accChild(). + /// If we have our own custom accessible child collection, return a set + /// of 1-based integer child ids, that the caller will eventually pass + /// back to us via IAccessible.get_accChild(). /// private void NextFromChildCollection(int n, IntPtr rgvar, int[] ns, int childCount) { @@ -2624,9 +2624,9 @@ private void NextFromChildCollection(int n, IntPtr rgvar, int[] ns, int childCou } /// - /// Default behavior if there is no custom child collection or - /// system-provided proxy to fall back on. In this case, we return - /// an empty child collection. + /// Default behavior if there is no custom child collection or + /// system-provided proxy to fall back on. In this case, we return + /// an empty child collection. /// private void NextEmpty(int n, IntPtr rgvar, int[] ns) { @@ -2635,8 +2635,8 @@ private void NextEmpty(int n, IntPtr rgvar, int[] ns) } /// - /// Given an IEnumVariant interface, this method jumps to a specific - /// item in the collection and extracts the result for that one item. + /// Given an IEnumVariant interface, this method jumps to a specific + /// item in the collection and extracts the result for that one item. /// private static bool GotoItem(UnsafeNativeMethods.IEnumVariant iev, int index, IntPtr variantPtr) { @@ -2650,7 +2650,7 @@ private static bool GotoItem(UnsafeNativeMethods.IEnumVariant iev, int index, In } /// - /// Given an array of pointers to variants, calculate address of a given array element. + /// Given an array of pointers to variants, calculate address of a given array element. /// private static IntPtr GetAddressOfVariantAtIndex(IntPtr variantArrayPtr, int index) { @@ -2663,7 +2663,7 @@ private static IntPtr GetAddressOfVariantAtIndex(IntPtr variantArrayPtr, int ind } /// - /// Internal object passed out to OLEACC clients via WM_GETOBJECT. + /// Internal object passed out to OLEACC clients via WM_GETOBJECT. /// internal sealed class InternalAccessibleObject : StandardOleMarshalObject, UnsafeNativeMethods.IAccessibleInternal, @@ -2718,7 +2718,7 @@ internal sealed class InternalAccessibleObject : StandardOleMarshalObject, private readonly UnsafeNativeMethods.IRawElementProviderHwndOverride publicIRawElementProviderHwndOverride; // AccessibleObject as IRawElementProviderHwndOverride /// - /// Create a new wrapper. + /// Create a new wrapper. /// internal InternalAccessibleObject(AccessibleObject accessibleImplemention) { @@ -2750,8 +2750,8 @@ internal InternalAccessibleObject(AccessibleObject accessibleImplemention) } /// - /// If the given object is an AccessibleObject return it as a InternalAccessibleObject - /// This ensures we wrap all AccessibleObjects before handing them out to OLEACC + /// If the given object is an AccessibleObject return it as a InternalAccessibleObject + /// This ensures we wrap all AccessibleObjects before handing them out to OLEACC /// private object AsNativeAccessible(object accObject) { @@ -2766,7 +2766,7 @@ private object AsNativeAccessible(object accObject) } /// - /// Wraps AccessibleObject elements of a given array into InternalAccessibleObjects + /// Wraps AccessibleObject elements of a given array into InternalAccessibleObjects /// private object[] AsArrayOfNativeAccessibles(object[] accObjectArray) { @@ -3306,7 +3306,7 @@ UnsafeNativeMethods.IRawElementProviderSimple UnsafeNativeMethods.IGridItemProvi } /// - /// Get the currently selected elements + /// Get the currently selected elements /// /// An AutomationElement array containing the currently selected elements object[] UnsafeNativeMethods.ISelectionProvider.GetSelection() @@ -3315,7 +3315,7 @@ object[] UnsafeNativeMethods.ISelectionProvider.GetSelection() } /// - /// Indicates whether the control allows more than one element to be selected + /// Indicates whether the control allows more than one element to be selected /// /// Boolean indicating whether the control allows more than one element to be selected /// If this is false, then the control is a single-select ccntrol @@ -3325,7 +3325,7 @@ bool UnsafeNativeMethods.ISelectionProvider.CanSelectMultiple } /// - /// Indicates whether the control requires at least one element to be selected + /// Indicates whether the control requires at least one element to be selected /// /// Boolean indicating whether the control requires at least one element to be selected /// If this is false, then the control allows all elements to be unselected @@ -3335,8 +3335,8 @@ bool UnsafeNativeMethods.ISelectionProvider.IsSelectionRequired } /// - /// Sets the current element as the selection - /// This clears the selection from other elements in the container. + /// Sets the current element as the selection + /// This clears the selection from other elements in the container. /// void UnsafeNativeMethods.ISelectionItemProvider.Select() { @@ -3344,7 +3344,7 @@ void UnsafeNativeMethods.ISelectionItemProvider.Select() } /// - /// Adds current element to selection. + /// Adds current element to selection. /// void UnsafeNativeMethods.ISelectionItemProvider.AddToSelection() { @@ -3352,7 +3352,7 @@ void UnsafeNativeMethods.ISelectionItemProvider.AddToSelection() } /// - /// Removes current element from selection. + /// Removes current element from selection. /// void UnsafeNativeMethods.ISelectionItemProvider.RemoveFromSelection() { @@ -3360,7 +3360,7 @@ void UnsafeNativeMethods.ISelectionItemProvider.RemoveFromSelection() } /// - /// Check whether an element is selected. + /// Check whether an element is selected. /// /// Returns true if the element is selected. bool UnsafeNativeMethods.ISelectionItemProvider.IsSelected @@ -3374,7 +3374,7 @@ void UnsafeNativeMethods.IScrollItemProvider.ScrollIntoView() } /// - /// The logical element that supports the SelectionPattern for this Item. + /// The logical element that supports the SelectionPattern for this Item. /// /// Returns a IRawElementProviderSimple. UnsafeNativeMethods.IRawElementProviderSimple UnsafeNativeMethods.ISelectionItemProvider.SelectionContainer @@ -3383,8 +3383,8 @@ UnsafeNativeMethods.IRawElementProviderSimple UnsafeNativeMethods.ISelectionItem } /// - /// Request a provider for the specified component. The returned provider can supply additional - /// properties or override properties of the specified component. + /// Request a provider for the specified component. The returned provider can supply additional + /// properties or override properties of the specified component. /// /// The window handle of the component. /// Return the provider for the specified component, or null if the component is not being overridden. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleRoles.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleRoles.cs index c71638b3740..5e2c7467091 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleRoles.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleRoles.cs @@ -5,418 +5,418 @@ namespace System.Windows.Forms { /// - /// Specifies values representing possible roles for an accessible object. + /// Specifies values representing possible roles for an accessible object. /// /// - /// if adding to this enumeration please update Control and ToolStripItem - /// AccessibleRole to ensure the new member is valid. + /// if adding to this enumeration please update Control and ToolStripItem + /// AccessibleRole to ensure the new member is valid. /// public enum AccessibleRole { /// - /// A system provided role. + /// A system provided role. /// Default = -1, /// - /// No role. + /// No role. /// None = 0, /// - /// A title or caption bar for a window. + /// A title or caption bar for a window. /// TitleBar = 0x1, /// - /// A menu bar, usually beneath the title bar of a window, from which menus - /// can be selected by the user. + /// A menu bar, usually beneath the title bar of a window, from which menus + /// can be selected by the user. /// MenuBar = 0x2, /// - /// A vertical or horizontal scroll bar, which can be either part of the - /// client area or used in a control. + /// A vertical or horizontal scroll bar, which can be either part of the + /// client area or used in a control. /// ScrollBar = 0x3, /// - /// A special mouse pointer, which allows a user to manipulate user interface - /// elements such as a window. For example, a user can click and drag a - /// sizing grip in the lower-right corner of a window to resize it. + /// A special mouse pointer, which allows a user to manipulate user interface + /// elements such as a window. For example, a user can click and drag a + /// sizing grip in the lower-right corner of a window to resize it. /// Grip = 0x4, /// - /// A system sound, which is associated with various system events. + /// A system sound, which is associated with various system events. /// Sound = 0x5, /// - /// A mouse pointer. + /// A mouse pointer. /// Cursor = 0x6, /// - /// A caret, which is a flashing line, block, or bitmap that marks the - /// location of the insertion point in a window's client area. + /// A caret, which is a flashing line, block, or bitmap that marks the + /// location of the insertion point in a window's client area. /// Caret = 0x7, /// - /// An alert or condition that a user should be notified about. This role - /// should be used only for objects that embody an alert but are not - /// associated with another user interface element, such as a message box, - /// graphic, text, or sound. + /// An alert or condition that a user should be notified about. This role + /// should be used only for objects that embody an alert but are not + /// associated with another user interface element, such as a message box, + /// graphic, text, or sound. /// Alert = 0x8, /// - /// A window frame, which usually contains child objects such as a title - /// bar, client, and other objects typically contained in a window. + /// A window frame, which usually contains child objects such as a title + /// bar, client, and other objects typically contained in a window. /// Window = 0x9, /// - /// A window's user area. + /// A window's user area. /// Client = 0xa, /// - /// A menu, which presents a list of options from which the user can make - /// a selection to perform an action. All menu types must have this role, - /// including drop-down menus that are displayed by selection from a menu - /// bar, and shortcut menus that are displayed when the right mouse - /// button is clicked. + /// A menu, which presents a list of options from which the user can make + /// a selection to perform an action. All menu types must have this role, + /// including drop-down menus that are displayed by selection from a menu + /// bar, and shortcut menus that are displayed when the right mouse + /// button is clicked. /// MenuPopup = 0xb, /// - /// A menu item, which is an entry in a menu that a user can choose to - /// carry out a command, select an option, or display another menu. - /// Functionally, a menu item can be equivalent to a push button, radio - /// button, check box, or menu. + /// A menu item, which is an entry in a menu that a user can choose to + /// carry out a command, select an option, or display another menu. + /// Functionally, a menu item can be equivalent to a push button, radio + /// button, check box, or menu. /// MenuItem = 0xc, /// - /// A tool tip, which is a small rectangular pop-up window that displays - /// a brief description of a command bar button's purpose. + /// A tool tip, which is a small rectangular pop-up window that displays + /// a brief description of a command bar button's purpose. /// ToolTip = 0xd, /// - /// The main window for an application. + /// The main window for an application. /// Application = 0xe, /// - /// A document window, which is always contained within an application - /// window. This role applies only to multiple document interface (MDI) - /// windows and refers to an object that contains the MDI title bar. + /// A document window, which is always contained within an application + /// window. This role applies only to multiple document interface (MDI) + /// windows and refers to an object that contains the MDI title bar. /// Document = 0xf, /// - /// One of the separate areas in a frame, a split document window, or a - /// rectangular area of the status bar that can be used to display - /// information. Users can navigate between panes and within the contents - /// of the current pane, but cannot navigate between items in different - /// panes. Thus, panes represent a level of grouping lower than frame - /// windows or documents, but above individual controls. Typically the - /// user navigates between panes by pressing TAB, F6, or CTRL+TAB, depending - /// on the context. + /// One of the separate areas in a frame, a split document window, or a + /// rectangular area of the status bar that can be used to display + /// information. Users can navigate between panes and within the contents + /// of the current pane, but cannot navigate between items in different + /// panes. Thus, panes represent a level of grouping lower than frame + /// windows or documents, but above individual controls. Typically the + /// user navigates between panes by pressing TAB, F6, or CTRL+TAB, depending + /// on the context. /// Pane = 0x10, /// - /// A graphical image used to represent data. + /// A graphical image used to represent data. /// Chart = 0x11, /// - /// A dialog box or message box. + /// A dialog box or message box. /// Dialog = 0x12, /// - /// A window border. The entire border is represented by a single object, - /// rather than by separate objects for each side. + /// A window border. The entire border is represented by a single object, + /// rather than by separate objects for each side. /// Border = 0x13, /// - /// Objects grouped in a logical manner. There can be a parent-child - /// relationship between the grouping object and the objects it contains. + /// Objects grouped in a logical manner. There can be a parent-child + /// relationship between the grouping object and the objects it contains. /// Grouping = 0x14, /// - /// Visually divides a space into two regions, such as a separator menu - /// item or a bar dividing split panes within a window. + /// Visually divides a space into two regions, such as a separator menu + /// item or a bar dividing split panes within a window. /// Separator = 0x15, /// - /// A toolbar, which is a grouping of controls that provide easy access - /// to frequently used features. + /// A toolbar, which is a grouping of controls that provide easy access + /// to frequently used features. /// ToolBar = 0x16, /// - /// A status bar, which is an area typically at the bottom of an application - /// window that displays information about the current operation, state of - /// the application, or selected object. The status bar can have multiple - /// fields that display different kinds of information, such as an - /// explanation of the currently selected menu command in the status bar. + /// A status bar, which is an area typically at the bottom of an application + /// window that displays information about the current operation, state of + /// the application, or selected object. The status bar can have multiple + /// fields that display different kinds of information, such as an + /// explanation of the currently selected menu command in the status bar. /// StatusBar = 0x17, /// - /// A table containing rows and columns of cells, and optionally, row - /// headers and column headers. + /// A table containing rows and columns of cells, and optionally, row + /// headers and column headers. /// Table = 0x18, /// - /// A column header, which provides a visual label for a column in a table. + /// A column header, which provides a visual label for a column in a table. /// ColumnHeader = 0x19, /// - /// A row header, which provides a visual label for a table row. + /// A row header, which provides a visual label for a table row. /// RowHeader = 0x1a, /// - /// A column of cells within a table. + /// A column of cells within a table. /// Column = 0x1b, /// - /// A row of cells within a table. + /// A row of cells within a table. /// Row = 0x1c, /// - /// A cell within a table. + /// A cell within a table. /// Cell = 0x1d, /// - /// A link, which is a connection between a source document and a destination - /// document. This object might look like text or a graphic, but it acts like - /// a button. + /// A link, which is a connection between a source document and a destination + /// document. This object might look like text or a graphic, but it acts like + /// a button. /// Link = 0x1e, /// - /// A Help display in the form of a ToolTip or Help balloon, which contains - /// buttons and labels that users can click to open custom Help topics. + /// A Help display in the form of a ToolTip or Help balloon, which contains + /// buttons and labels that users can click to open custom Help topics. /// HelpBalloon = 0x1f, /// - /// A cartoon-like graphic object, such as Microsoft Office Assistant, which - /// is typically displayed to provide help to users of an application. + /// A cartoon-like graphic object, such as Microsoft Office Assistant, which + /// is typically displayed to provide help to users of an application. /// Character = 0x20, /// - /// A list box, which allows the user to select one or more items. + /// A list box, which allows the user to select one or more items. /// List = 0x21, /// - /// An item in a list box or the list portion of a combo box, drop-down - /// list box, or drop-down combo box. + /// An item in a list box or the list portion of a combo box, drop-down + /// list box, or drop-down combo box. /// ListItem = 0x22, /// - /// An outline or tree structure, such as a tree view control, which - /// displays a hierarchical list and usually allows the user to expand - /// and collapse branches. + /// An outline or tree structure, such as a tree view control, which + /// displays a hierarchical list and usually allows the user to expand + /// and collapse branches. /// Outline = 0x23, /// - /// An item in an outline or tree structure. + /// An item in an outline or tree structure. /// OutlineItem = 0x24, /// - /// A property page that allows a user to view the attributes for a page, - /// such as the page's title, whether it is a home page, or whether the - /// page has been modified. - /// Normally the only child of this control is a grouped object that contains - /// the contents of the associated page. + /// A property page that allows a user to view the attributes for a page, + /// such as the page's title, whether it is a home page, or whether the + /// page has been modified. + /// Normally the only child of this control is a grouped object that contains + /// the contents of the associated page. /// PageTab = 0x25, /// - /// A property page, which is a dialog box that controls the appearance - /// and the behavior of an object, such as a file or resource. A property - /// page's appearance differs according to its purpose. + /// A property page, which is a dialog box that controls the appearance + /// and the behavior of an object, such as a file or resource. A property + /// page's appearance differs according to its purpose. /// PropertyPage = 0x26, /// - /// An indicator, such as a pointer graphic, that points to the current item. + /// An indicator, such as a pointer graphic, that points to the current item. /// Indicator = 0x27, /// - /// A picture. + /// A picture. /// Graphic = 0x28, /// - /// Read-only text, such as in a label, for other controls or instructions - /// in a dialog box. Static text cannot be modified or selected. + /// Read-only text, such as in a label, for other controls or instructions + /// in a dialog box. Static text cannot be modified or selected. /// StaticText = 0x29, /// - /// Selectable text that can be editable or read-only. + /// Selectable text that can be editable or read-only. /// Text = 0x2a, /// - /// A push button control, which is a small rectangular control that a user - /// can turn on or off. A push button, also known as a command button, has - /// a raised appearance in its default off state and a sunken appearance - /// when it is turned on. + /// A push button control, which is a small rectangular control that a user + /// can turn on or off. A push button, also known as a command button, has + /// a raised appearance in its default off state and a sunken appearance + /// when it is turned on. /// PushButton = 0x2b, /// - /// A check box control, which is an option that can be turned on or off - /// independently of other options. + /// A check box control, which is an option that can be turned on or off + /// independently of other options. /// CheckButton = 0x2c, /// - /// An option button, also known as a radio button. All objects sharing the - /// same parent that have this attribute are assumed to be part of a single - /// mutually exclusive group. You can use grouped objects to divide option - /// buttons into separate groups when necessary. + /// An option button, also known as a radio button. All objects sharing the + /// same parent that have this attribute are assumed to be part of a single + /// mutually exclusive group. You can use grouped objects to divide option + /// buttons into separate groups when necessary. /// RadioButton = 0x2d, /// - /// A combo box, which is an edit control with an associated list box that - /// provides a set of predefined choices. + /// A combo box, which is an edit control with an associated list box that + /// provides a set of predefined choices. /// ComboBox = 0x2e, /// - /// A drop-down list box. This control shows one item and allows the user - /// to display and select another from a list of alternative choices. + /// A drop-down list box. This control shows one item and allows the user + /// to display and select another from a list of alternative choices. /// DropList = 0x2f, /// - /// A progress bar, which indicates the progress of a lengthy operation by - /// displaying a colored bar inside a horizontal rectangle. The length of - /// the bar in relation to the length of the rectangle corresponds to - /// the percentage of the operation that is complete. This control does - /// not take user input. + /// A progress bar, which indicates the progress of a lengthy operation by + /// displaying a colored bar inside a horizontal rectangle. The length of + /// the bar in relation to the length of the rectangle corresponds to + /// the percentage of the operation that is complete. This control does + /// not take user input. /// ProgressBar = 0x30, /// - /// A dial or knob. This can also be a read-only object, like a speedometer. + /// A dial or knob. This can also be a read-only object, like a speedometer. /// Dial = 0x31, /// - /// A hot-key field that allows the user to enter a combination or sequence - /// of keystrokes to be used as a hot key, which enables users to perform - /// an action quickly. A hot-key control displays the keystrokes entered - /// by the user and ensures that the user selects a valid key combination. + /// A hot-key field that allows the user to enter a combination or sequence + /// of keystrokes to be used as a hot key, which enables users to perform + /// an action quickly. A hot-key control displays the keystrokes entered + /// by the user and ensures that the user selects a valid key combination. /// HotkeyField = 0x32, /// - /// A control, sometimes called a trackbar, that allows a user to adjust - /// a setting in given increments between minimum and maximum values by - /// moving a slider. The volume controls in the Windows operating system - /// are slider controls. + /// A control, sometimes called a trackbar, that allows a user to adjust + /// a setting in given increments between minimum and maximum values by + /// moving a slider. The volume controls in the Windows operating system + /// are slider controls. /// Slider = 0x33, /// - /// A spin box, also known as an up-down control, which contains a pair - /// of arrow buttons that a user click with a mouse to increment or - /// decrement a value. A spin button control is most often used with a - /// companion control, called a buddy window, where the current value is - /// displayed. + /// A spin box, also known as an up-down control, which contains a pair + /// of arrow buttons that a user click with a mouse to increment or + /// decrement a value. A spin button control is most often used with a + /// companion control, called a buddy window, where the current value is + /// displayed. /// SpinButton = 0x34, /// - /// A graphical image used to diagram data. + /// A graphical image used to diagram data. /// Diagram = 0x35, /// - /// An animation control, which contains content that is changing over - /// time, such as a control that displays a series of bitmap frames, like - /// a film strip. Animation controls are usually displayed when files - /// are being copied, or when some other time-consuming task is being - /// performed. + /// An animation control, which contains content that is changing over + /// time, such as a control that displays a series of bitmap frames, like + /// a film strip. Animation controls are usually displayed when files + /// are being copied, or when some other time-consuming task is being + /// performed. /// Animation = 0x36, /// - /// A mathematical equation. + /// A mathematical equation. /// Equation = 0x37, /// - /// A button that drops down a list of items. + /// A button that drops down a list of items. /// ButtonDropDown = 0x38, /// - /// A button that drops down a menu. + /// A button that drops down a menu. /// ButtonMenu = 0x39, /// - /// A button that drops down a grid. + /// A button that drops down a grid. /// ButtonDropDownGrid = 0x3a, /// - /// A blank space between other objects. + /// A blank space between other objects. /// WhiteSpace = 0x3b, /// - /// A container of page tab controls. + /// A container of page tab controls. /// PageTabList = 0x3c, /// - /// A control that displays the time. + /// A control that displays the time. /// Clock = 0x3d, /// - /// A toolbar button that jas a drop-down list icon directly adjacent to - /// the button. + /// A toolbar button that jas a drop-down list icon directly adjacent to + /// the button. /// SplitButton = 0x3e, /// - /// A control designed for entering Internet Protocol (IP) addresses. + /// A control designed for entering Internet Protocol (IP) addresses. /// IpAddress = 0x3f, /// - /// A control that navigates like an outline item. + /// A control that navigates like an outline item. /// OutlineButton = 0x40, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleSelection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleSelection.cs index 534d23bfce3..6ae8d050b6e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleSelection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleSelection.cs @@ -5,41 +5,41 @@ namespace System.Windows.Forms { /// - /// Specifies how an accessible object will be selected or receive focus. + /// Specifies how an accessible object will be selected or receive focus. /// [Flags] public enum AccessibleSelection { /// - /// The selection or focus of an object is unchanged. + /// The selection or focus of an object is unchanged. /// None = 0, /// - /// Assigns focus to an object and makes it the anchor, which is the - /// starting point for the selection. Can be combined with + /// Assigns focus to an object and makes it the anchor, which is the + /// starting point for the selection. Can be combined with /// , , /// , or . /// TakeFocus = 1, /// - /// Selects the object and deselects all other objects in the container. + /// Selects the object and deselects all other objects in the container. /// TakeSelection = 2, /// - /// Selects all objects between the anchor and the selected object. + /// Selects all objects between the anchor and the selected object. /// ExtendSelection = 4, /// - /// Adds the object to the selection. + /// Adds the object to the selection. /// AddSelection = 8, /// - /// Removes the object from the selection. + /// Removes the object from the selection. /// RemoveSelection = 16, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleStates.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleStates.cs index 8bf42bf73e3..bd5609bdbc9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleStates.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AccessibleStates.cs @@ -5,214 +5,214 @@ namespace System.Windows.Forms { /// - /// Specifies values representing possible states for an accessible object + /// Specifies values representing possible states for an accessible object /// [Flags] public enum AccessibleStates { /// - /// No state. + /// No state. /// None = 0, /// - /// An unavailable object. + /// An unavailable object. /// Unavailable = 0x1, /// - /// A selected object. + /// A selected object. /// Selected = 0x2, /// - /// An object with the keyboard focus. + /// An object with the keyboard focus. /// Focused = 0x4, /// - /// A pressed object. + /// A pressed object. /// Pressed = 0x8, /// - /// An object with a selected check box. + /// An object with a selected check box. /// Checked = 0x10, /// - /// A three-state check box or toolbar button whose state is indeterminate. - /// The check box is neither checked nor unchecked and it is in the third - /// or mixed state. + /// A three-state check box or toolbar button whose state is indeterminate. + /// The check box is neither checked nor unchecked and it is in the third + /// or mixed state. /// Mixed = 0x20, /// - /// A three-state check box or toolbar button whose state is indeterminate. - /// The check box is neither checked nor unchecked and it is in the third - /// or mixed state. + /// A three-state check box or toolbar button whose state is indeterminate. + /// The check box is neither checked nor unchecked and it is in the third + /// or mixed state. /// Indeterminate = Mixed, /// - /// A read-only object. + /// A read-only object. /// ReadOnly = 0x40, /// - /// The object is hot-tracked by the mouse, meaning its appearance is - /// highlighted to indicate the mouse pointer is located over it. + /// The object is hot-tracked by the mouse, meaning its appearance is + /// highlighted to indicate the mouse pointer is located over it. /// HotTracked = 0x80, /// - /// The default button or menu item. + /// The default button or menu item. /// Default = 0x100, /// - /// Children of the object that are items in an outline or tree structure - /// are displayed. + /// Children of the object that are items in an outline or tree structure + /// are displayed. /// Expanded = 0x200, /// - /// Children of the object that are items in an outline or tree structure - /// are hidden. + /// Children of the object that are items in an outline or tree structure + /// are hidden. /// Collapsed = 0x400, /// - /// A control that cannot accept input in its current condition. + /// A control that cannot accept input in its current condition. /// Busy = 0x800, /// - /// The object is not fixed to the boundary of its parent object, and - /// does not move automatically along with the parent. + /// The object is not fixed to the boundary of its parent object, and + /// does not move automatically along with the parent. /// Floating = 0x1000, /// - /// An object with scrolling or moving text or graphics. + /// An object with scrolling or moving text or graphics. /// Marqueed = 0x2000, /// - /// The object has a rapidly or constantly changing appearance. Graphics - /// that are occasionally animated, but not always, should be defined as + /// The object has a rapidly or constantly changing appearance. Graphics + /// that are occasionally animated, but not always, should be defined as /// |. - /// This state should not be used to indicate that the object's location - /// is changing. + /// This state should not be used to indicate that the object's location + /// is changing. /// Animated = 0x4000, /// - /// An object that is currently invisible. + /// An object that is currently invisible. /// Invisible = 0x8000, /// - /// No on-screen representation. A sound or alert object would have this - /// state, or a hidden window that is never made visible. + /// No on-screen representation. A sound or alert object would have this + /// state, or a hidden window that is never made visible. /// Offscreen = 0x10000, /// - /// A sizable object. + /// A sizable object. /// Sizeable = 0x20000, /// - /// A movable object. + /// A movable object. /// Moveable = 0x40000, /// - /// The object or child can use text-to-speech (TTS) to describe itself. A - /// speech-based accessibility aid should not announce information when an - /// object with this state has the focus because the object will - /// automatically announce information about itself. + /// The object or child can use text-to-speech (TTS) to describe itself. A + /// speech-based accessibility aid should not announce information when an + /// object with this state has the focus because the object will + /// automatically announce information about itself. /// SelfVoicing = 0x80000, /// - /// The object is on the active window and can receive keyboard focus. + /// The object is on the active window and can receive keyboard focus. /// Focusable = 0x100000, /// - /// An object that can accept selection. + /// An object that can accept selection. /// Selectable = 0x200000, /// - /// A linked object that has not been previously selected. + /// A linked object that has not been previously selected. /// Linked = 0x400000, /// - /// A linked object that has previously been selected. + /// A linked object that has previously been selected. /// Traversed = 0x800000, /// - /// An object that accepts multiple selected items. + /// An object that accepts multiple selected items. /// MultiSelectable = 0x1000000, /// - /// Alters the selection so that all objects between the selection anchor, - /// which is the object with the keyboard focus, and this object take on - /// the anchor object's selection state. If the anchor object is not - /// selected, the objects are removed from the selection. If the anchor - /// object is selected, the selection is extended to include this object - /// and all the objects in between. You can set the selection state by - /// combining this flag with - /// or . This flag does - /// not change the focus or the selection anchor unless it is combined with + /// Alters the selection so that all objects between the selection anchor, + /// which is the object with the keyboard focus, and this object take on + /// the anchor object's selection state. If the anchor object is not + /// selected, the objects are removed from the selection. If the anchor + /// object is selected, the selection is extended to include this object + /// and all the objects in between. You can set the selection state by + /// combining this flag with + /// or . This flag does + /// not change the focus or the selection anchor unless it is combined with /// . The behavior of /// | - /// is equivalent to adding an item to a selection manually by holding down - /// the SHIFT key and clicking an unselected object. - /// This flag may not be combined with . + /// is equivalent to adding an item to a selection manually by holding down + /// the SHIFT key and clicking an unselected object. + /// This flag may not be combined with . /// ExtSelectable = 0x2000000, /// - /// Low-priority information that may not be important to the user. + /// Low-priority information that may not be important to the user. /// AlertLow = 0x4000000, /// - /// Important information that does not need to be conveyed to the user - /// immediately. For example, when a battery level indicator is starting - /// to reach a low level, it could generate a medium-level alert. Blind - /// access utilities could then generate a sound to let the user know that - /// important information is available, without actually interrupting the - /// user's work. The user could then query the alert information at their - /// leisure. + /// Important information that does not need to be conveyed to the user + /// immediately. For example, when a battery level indicator is starting + /// to reach a low level, it could generate a medium-level alert. Blind + /// access utilities could then generate a sound to let the user know that + /// important information is available, without actually interrupting the + /// user's work. The user could then query the alert information at their + /// leisure. /// AlertMedium = 0x8000000, /// - /// Important information that should be conveyed to the user immediately. - /// For example, a battery level indicator reaching a critical low level - /// would transition to this state, in which case a blind access utility - /// would announce this information immediately to the user, and a screen - /// magnification program would scroll the screen so that the battery - /// indicator is in view. This state is also appropriate for any prompt - /// or operation that must be completed before the user can continue. + /// Important information that should be conveyed to the user immediately. + /// For example, a battery level indicator reaching a critical low level + /// would transition to this state, in which case a blind access utility + /// would announce this information immediately to the user, and a screen + /// magnification program would scroll the screen so that the battery + /// indicator is in view. This state is also appropriate for any prompt + /// or operation that must be completed before the user can continue. /// AlertHigh = 0x10000000, /// - /// A password-protected edit control. + /// A password-protected edit control. /// Protected = 0x20000000, /// - /// Object displays a pop-up menu or window when invoked. + /// Object displays a pop-up menu or window when invoked. /// HasPopup = 0x40000000, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AmbientProperties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AmbientProperties.cs index 5a8b2062bcc..15f01f64ff9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AmbientProperties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AmbientProperties.cs @@ -7,29 +7,29 @@ namespace System.Windows.Forms { /// - /// Provides ambient property values to top-level controls. - /// NOTE: internally, this class does double duty as storage for - /// Control's inherited properties. + /// Provides ambient property values to top-level controls. + /// NOTE: internally, this class does double duty as storage for + /// Control's inherited properties. /// public sealed class AmbientProperties { /// - /// Gets the ambient BackColor, or Color.Empty if there is none. + /// Gets the ambient BackColor, or Color.Empty if there is none. /// public Color BackColor { get; set; } /// - /// Gets the ambient BackColor, or null if there is none. + /// Gets the ambient BackColor, or null if there is none. /// public Cursor Cursor { get; set; } /// - /// Gets the ambient Font, or null if there is none. + /// Gets the ambient Font, or null if there is none. /// public Font Font { get; set; } /// - /// Gets the ambient ForeColor, or Color.Empty if there is none. + /// Gets the ambient ForeColor, or Color.Empty if there is none. /// public Color ForeColor { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AnchorStyles.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AnchorStyles.cs index 4d24eb14f1a..5d69afbd58b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AnchorStyles.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AnchorStyles.cs @@ -8,34 +8,34 @@ namespace System.Windows.Forms { /// - /// Specifies how a control anchors to the edges of its container. + /// Specifies how a control anchors to the edges of its container. /// [Editor("System.Windows.Forms.Design.AnchorEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor))] [Flags] public enum AnchorStyles { /// - /// The control is anchored to the top edge of its container. + /// The control is anchored to the top edge of its container. /// Top = 0x01, /// - /// The control is anchored to the bottom edge of its container. + /// The control is anchored to the bottom edge of its container. /// Bottom = 0x02, /// - /// The control is anchored to the left edge of its container. + /// The control is anchored to the left edge of its container. /// Left = 0x04, /// - /// The control is anchored to the right edge of its container. + /// The control is anchored to the right edge of its container. /// Right = 0x08, /// - /// The control is not anchored to any edges of its container. + /// The control is not anchored to any edges of its container. /// None = 0, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Appearance.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Appearance.cs index 5253435848e..ac66fd7776c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Appearance.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Appearance.cs @@ -7,18 +7,18 @@ namespace System.Windows.Forms { /// - /// Specifies the appearance of a control. + /// Specifies the appearance of a control. /// [ComVisible(true)] public enum Appearance { /// - /// The default appearance defined by the control class. + /// The default appearance defined by the control class. /// Normal = 0, /// - /// The appearance of a Windows button. + /// The appearance of a Windows button. /// Button = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Application.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Application.cs index 82cdf5ff651..16b6408e4ae 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Application.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Application.cs @@ -21,11 +21,11 @@ namespace System.Windows.Forms { /// - /// Provides - /// methods and properties - /// to manage an application, such as methods to run and quit an application, - /// to process Windows messages, and properties to get information about an application. This - /// class cannot be inherited. + /// Provides + /// methods and properties + /// to manage an application, such as methods to run and quit an application, + /// to process Windows messages, and properties to get information about an application. This + /// class cannot be inherited. /// public sealed class Application { @@ -101,7 +101,7 @@ internal static bool CanContinueIdle } } - /// Typically, you shouldn't need to use this directly - use RenderWithVisualStyles instead. + /// Typically, you shouldn't need to use this directly - use RenderWithVisualStyles instead. internal static bool ComCtlSupportsVisualStyles { get @@ -210,7 +210,7 @@ internal static bool UseEverettThreadAffinity /// Gets the path for the application data that is shared among all users. /// /// - /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides + /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides // the Windows logo required adornments to the directory (Company\Product\Version) /// public static string CommonAppDataPath @@ -369,7 +369,7 @@ public static string ExecutablePath } /// - /// Gets the current HighDpi mode for the process. + /// Gets the current HighDpi mode for the process. /// public static HighDpiMode HighDpiMode { @@ -380,7 +380,7 @@ public static HighDpiMode HighDpiMode } /// - /// Sets the HighDpi mode for process. + /// Sets the HighDpi mode for process. /// /// The HighDpi mode to set. /// @@ -398,8 +398,8 @@ public static bool SetHighDpiMode(HighDpiMode highDpiMode) /// Gets the path for the application data specific to a local, non-roaming user. /// /// - /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides - /// the Windows logo required adornments to the directory (Company\Product\Version) + /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides + /// the Windows logo required adornments to the directory (Company\Product\Version) /// public static string LocalUserAppDataPath { @@ -421,7 +421,7 @@ public static bool MessageLoop } /// - /// Gets the forms collection associated with this application. + /// Gets the forms collection associated with this application. /// public static FormCollection OpenForms => s_forms ?? (s_forms = new FormCollection()); @@ -647,8 +647,8 @@ public static bool UseWaitCursor /// Gets the path for the application data specific to the roaming user. /// /// - /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides - /// the Windows logo required adornments to the directory (Company\Product\Version) + /// Don't obsolete these. GetDataPath isn't on SystemInformation, and it provides + /// the Windows logo required adornments to the directory (Company\Product\Version) /// public static string UserAppDataPath { @@ -674,9 +674,9 @@ public static RegistryKey UserAppDataRegistry public static bool UseVisualStyles => s_useVisualStyles; /// - /// Don't never ever change this name, since the window class and partner teams - /// dependent on this. Changing this will introduce breaking changes. - /// If there is some reason need to change this, notify any partner teams affected. + /// Don't never ever change this name, since the window class and partner teams + /// dependent on this. Changing this will introduce breaking changes. + /// If there is some reason need to change this, notify any partner teams affected. /// internal static string WindowsFormsVersion => "WindowsForms10"; @@ -725,7 +725,7 @@ public static VisualStyleState VisualStyleState } /// - /// This helper broadcasts out a WM_THEMECHANGED to appropriate top level windows of this app. + /// This helper broadcasts out a WM_THEMECHANGED to appropriate top level windows of this app. /// private static bool SendThemeChanged(IntPtr handle, IntPtr extraParameter) { @@ -746,8 +746,8 @@ private static bool SendThemeChanged(IntPtr handle, IntPtr extraParameter) } /// - /// This helper broadcasts out a WM_THEMECHANGED this window and all children. - /// it is assumed at this point that the handle belongs to the current process and has a visible top level window. + /// This helper broadcasts out a WM_THEMECHANGED this window and all children. + /// it is assumed at this point that the handle belongs to the current process and has a visible top level window. /// private static bool SendThemeChangedRecursive(IntPtr handle, IntPtr lparam) { @@ -965,8 +965,8 @@ internal static void DoEventsModal() } /// - /// Enables visual styles for all subsequent Application.Run() and CreateHandle() calls. - /// Uses the default theming manifest file shipped with the redist. + /// Enables visual styles for all subsequent Application.Run() and CreateHandle() calls. + /// Uses the default theming manifest file shipped with the redist. /// public static void EnableVisualStyles() { @@ -1219,7 +1219,7 @@ internal static void ParkHandle(HandleRef handle, DpiAwarenessContext dpiAwarene } /// - /// Park control handle on a parkingwindow that has matching DpiAwareness. + /// Park control handle on a parkingwindow that has matching DpiAwareness. /// /// create params for control handle /// dpi awareness @@ -1241,7 +1241,7 @@ public static ApartmentState OleRequired() } /// - /// Raises the event. + /// Raises the event. /// public static void OnThreadException(Exception t) { @@ -2455,7 +2455,7 @@ internal ParkingWindow GetParkingWindow(DpiAwarenessContext context) } /// - /// Returns parking window that matches dpi awareness context. return null if not found. + /// Returns parking window that matches dpi awareness context. return null if not found. /// /// return matching parking window from list. returns null if not found internal ParkingWindow GetParkingWindowForContext(DpiAwarenessContext context) @@ -3052,8 +3052,8 @@ private bool GetState(int bit) } /// - /// A method of determining whether we are handling messages that does not demand register - /// the componentmanager + /// A method of determining whether we are handling messages that does not demand register + /// the componentmanager /// /// internal bool IsValidComponentId() @@ -3706,7 +3706,6 @@ private void SetState(int bit, bool value) } /////////////////////////////////////////////////////////////////////////////////////////////////////// - /**************************************************************************************** * * IMsoComponent diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ApplicationContext.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ApplicationContext.cs index 34a3c27b19e..2991c7e11c0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ApplicationContext.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ApplicationContext.cs @@ -7,27 +7,27 @@ namespace System.Windows.Forms { /// - /// ApplicationContext provides contextual information about an application - /// thread. Specifically this allows an application author to redifine what - /// circurmstances cause a message loop to exit. By default the application - /// context listens to the close event on the mainForm, then exits the - /// thread's message loop. + /// ApplicationContext provides contextual information about an application + /// thread. Specifically this allows an application author to redifine what + /// circurmstances cause a message loop to exit. By default the application + /// context listens to the close event on the mainForm, then exits the + /// thread's message loop. /// public class ApplicationContext : IDisposable { private Form _mainForm; /// - /// Creates a new ApplicationContext with no mainForm. + /// Creates a new ApplicationContext with no mainForm. /// public ApplicationContext() : this(null) { } /// - /// Creates a new ApplicationContext with the specified mainForm. - /// If OnMainFormClosed is not overriden, the thread's message - /// loop will be terminated when mainForm is closed. + /// Creates a new ApplicationContext with the specified mainForm. + /// If OnMainFormClosed is not overriden, the thread's message + /// loop will be terminated when mainForm is closed. /// public ApplicationContext(Form mainForm) { @@ -37,10 +37,10 @@ public ApplicationContext(Form mainForm) ~ApplicationContext() => Dispose(false); /// - /// Determines the mainForm for this context. This may be changed - /// at anytime. - /// If OnMainFormClosed is not overriden, the thread's message - /// loop will be terminated when mainForm is closed. + /// Determines the mainForm for this context. This may be changed + /// at anytime. + /// If OnMainFormClosed is not overriden, the thread's message + /// loop will be terminated when mainForm is closed. /// public Form MainForm { @@ -71,15 +71,15 @@ public Form MainForm public object Tag { get; set; } /// - /// Is raised when the thread's message loop should be terminated. - /// This is raised by calling ExitThread. + /// Is raised when the thread's message loop should be terminated. + /// This is raised by calling ExitThread. /// public event EventHandler ThreadExit; /// - /// Disposes the context. This should dispose the mainForm. This is - /// called immediately after the thread's message loop is terminated. - /// Application will dispose all forms on this thread by default. + /// Disposes the context. This should dispose the mainForm. This is + /// called immediately after the thread's message loop is terminated. + /// Application will dispose all forms on this thread by default. /// public void Dispose() { @@ -104,24 +104,24 @@ protected virtual void Dispose(bool disposing) } /// - /// Causes the thread's message loop to be terminated. This will call ExitThreadCore. + /// Causes the thread's message loop to be terminated. This will call ExitThreadCore. /// public void ExitThread() => ExitThreadCore(); /// - /// Causes the thread's message loop to be terminated. + /// Causes the thread's message loop to be terminated. /// protected virtual void ExitThreadCore() => ThreadExit?.Invoke(this, EventArgs.Empty); /// - /// Called when the mainForm is closed. The default implementation - /// of this will call ExitThreadCore. + /// Called when the mainForm is closed. The default implementation + /// of this will call ExitThreadCore. /// protected virtual void OnMainFormClosed(object sender, EventArgs e) => ExitThreadCore(); /// - /// Called when the mainForm is closed. The default implementation - /// of this will call ExitThreadCore. + /// Called when the mainForm is closed. The default implementation + /// of this will call ExitThreadCore. /// private void OnMainFormDestroy(object sender, EventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeDirection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeDirection.cs index c3060237753..0a01d681568 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeDirection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeDirection.cs @@ -7,29 +7,29 @@ namespace System.Windows.Forms { /// - /// Specifies the direction the system uses to arrange minimized windows. + /// Specifies the direction the system uses to arrange minimized windows. /// [ComVisible(true)] [Flags] public enum ArrangeDirection { /// - /// Arranges vertically, from top to bottom. + /// Arranges vertically, from top to bottom. /// Down = NativeMethods.ARW_DOWN, /// - /// Arranges horizontally, from left to right. + /// Arranges horizontally, from left to right. /// Left = NativeMethods.ARW_LEFT, /// - /// Arranges horizontally, from right to left. + /// Arranges horizontally, from right to left. /// Right = NativeMethods.ARW_RIGHT, /// - /// Arranges vertically, from bottom to top. + /// Arranges vertically, from bottom to top. /// Up = NativeMethods.ARW_UP, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeStartingPosition.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeStartingPosition.cs index 6d2bb392a3d..b4ce57fd80a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeStartingPosition.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ArrangeStartingPosition.cs @@ -5,35 +5,35 @@ namespace System.Windows.Forms { /// - /// Specifies the starting position that the system uses to arrange minimized - /// windows. + /// Specifies the starting position that the system uses to arrange minimized + /// windows. /// [Flags] public enum ArrangeStartingPosition { /// - /// Starts at the lower-left corner of the screen, which is the default position. + /// Starts at the lower-left corner of the screen, which is the default position. /// BottomLeft = NativeMethods.ARW_BOTTOMLEFT, /// - /// Starts at the lower-right corner of the screen. + /// Starts at the lower-right corner of the screen. /// BottomRight = NativeMethods.ARW_BOTTOMRIGHT, /// - /// Hides minimized windows by moving them off the visible area of the - /// screen. + /// Hides minimized windows by moving them off the visible area of the + /// screen. /// Hide = NativeMethods.ARW_HIDE, /// - /// Starts at the upper-left corner of the screen. + /// Starts at the upper-left corner of the screen. /// TopLeft = NativeMethods.ARW_TOPLEFT, /// - /// Starts at the upper-right corner of the screen. + /// Starts at the upper-right corner of the screen. /// TopRight = NativeMethods.ARW_TOPRIGHT, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteMode.cs index f21e691430c..d619e08fc0c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteMode.cs @@ -5,29 +5,29 @@ namespace System.Windows.Forms { /// - /// Specifies the autocomplete mode for ComboBox and TextBox AutoComplete Feature. + /// Specifies the autocomplete mode for ComboBox and TextBox AutoComplete Feature. /// public enum AutoCompleteMode { /// - /// Disables the AutoComplete Feature for ComboBox and TextBox. + /// Disables the AutoComplete Feature for ComboBox and TextBox. /// None = 0, /// - /// Displays the auxiliary drop-down list associated with the edit control, - /// this drop-down is populated with one or more suggested completed strings. + /// Displays the auxiliary drop-down list associated with the edit control, + /// this drop-down is populated with one or more suggested completed strings. /// Suggest = 0x1, /// - /// Appends the remainder of the most likely candidate string to the existing - /// characters, hightlighting the appended characters. + /// Appends the remainder of the most likely candidate string to the existing + /// characters, hightlighting the appended characters. /// Append = 0x2, /// - /// The AutoSuggest and AutoAppend are applied in conjuction. + /// The AutoSuggest and AutoAppend are applied in conjuction. /// SuggestAppend = Suggest | Append } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteSource.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteSource.cs index f1aa51c5234..ba8a3f5171e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteSource.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteSource.cs @@ -5,55 +5,55 @@ namespace System.Windows.Forms { /// - /// Specifies the AutoCompleteSource for ComboBox and TextBox AutoComplete Feature. + /// Specifies the AutoCompleteSource for ComboBox and TextBox AutoComplete Feature. /// public enum AutoCompleteSource { /// - /// This option includes the file system as the source. + /// This option includes the file system as the source. /// FileSystem = 0x00000001, /// - /// This option includes the URL's in the users history list. + /// This option includes the URL's in the users history list. /// HistoryList = 0x00000002, /// - /// This option includes the URL's in the users recently used list. + /// This option includes the URL's in the users recently used list. /// RecentlyUsedList = 0x00000004, /// - /// This option is equivalent to HistoryList | RecentlyUsedList. + /// This option is equivalent to HistoryList | RecentlyUsedList. /// AllUrl = HistoryList | RecentlyUsedList, /// - /// This option is equivalent to FILESYSTEM | AllUrl. This is the default - /// value when the AutoCompleteMode has been set to a non default value. + /// This option is equivalent to FILESYSTEM | AllUrl. This is the default + /// value when the AutoCompleteMode has been set to a non default value. /// AllSystemSources = FileSystem | AllUrl, /// - /// This option is allows to autoComplete just directory names and not - /// the files inside. + /// This option is allows to autoComplete just directory names and not + /// the files inside. /// FileSystemDirectories = 0x00000020, /// - /// This option includes stirngs from a built in String Collection object. + /// This option includes stirngs from a built in String Collection object. /// CustomSource = 0x00000040, /// - /// The default value specifying the no AutoCompleteSource is currently - /// in use. + /// The default value specifying the no AutoCompleteSource is currently + /// in use. /// None = 0x00000080, /// - /// The items of the combobox represent the source. + /// The items of the combobox represent the source. /// ListItems = 0x00000100 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteStringCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteStringCollection.cs index 9980d108f70..b78434c48f2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteStringCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoCompleteStringCollection.cs @@ -20,7 +20,7 @@ public AutoCompleteStringCollection() } /// - /// Represents the entry at the specified index of the . + /// Represents the entry at the specified index of the . /// public string this[int index] { @@ -87,7 +87,7 @@ public int Add(string value) } /// - /// Copies the elements of a string array to the end of the . + /// Copies the elements of a string array to the end of the . /// public void AddRange(string[] value) { @@ -120,7 +120,7 @@ public bool Contains(string value) } /// - /// Copies the values to a one-dimensional instance at the + /// Copies the values to a one-dimensional instance at the /// specified index. /// public void CopyTo(string[] array, int index) @@ -138,7 +138,7 @@ public int IndexOf(string value) } /// - /// Inserts a string into the at the specified + /// Inserts a string into the at the specified /// index. /// public void Insert(int index, string value) @@ -148,7 +148,7 @@ public void Insert(int index, string value) } /// - /// Gets a value indicating whether the is read-only. + /// Gets a value indicating whether the is read-only. /// public bool IsReadOnly { @@ -181,7 +181,7 @@ public void Remove(string value) } /// - /// Removes the string at the specified index of the . + /// Removes the string at the specified index of the . /// public void RemoveAt(int index) { @@ -191,7 +191,7 @@ public void RemoveAt(int index) } /// - /// Gets an object that can be used to synchronize access to the . + /// Gets an object that can be used to synchronize access to the . /// public object SyncRoot => this; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoScaleMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoScaleMode.cs index f4b9b483d01..8fccc12a6bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoScaleMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoScaleMode.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - /// Specifies the auto scaling mode used by a container control. + /// Specifies the auto scaling mode used by a container control. /// public enum AutoScaleMode { /// - /// AutoScale is turned off. + /// AutoScale is turned off. /// None, /// - /// Controls scale according to the dimensions of the font they are using. + /// Controls scale according to the dimensions of the font they are using. /// Font, /// - /// Controls scale according to the display Dpi. + /// Controls scale according to the display Dpi. /// Dpi, /// - /// Controls scale according to their parent's scaling mode. - /// If there is no parent, this behaves as if AutoScaleMode.None were set. + /// Controls scale according to their parent's scaling mode. + /// If there is no parent, this behaves as if AutoScaleMode.None were set. /// Inherit } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoSizeMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoSizeMode.cs index bf6d53c5b20..10dd2e90218 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoSizeMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoSizeMode.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies how the control will behave when its AutoSize property is enabled + /// Specifies how the control will behave when its AutoSize property is enabled /// public enum AutoSizeMode { /// - /// The same behavior as you get for controls with AutoSize and no AutoSizeMode - /// property. The control will grow or shrink to encompass the contents (e.g. - /// text for a Button, child controls for a container). The MinimumSize and - /// MaximumSize are followed, but the current value of the Size property is - /// ignored. + /// The same behavior as you get for controls with AutoSize and no AutoSizeMode + /// property. The control will grow or shrink to encompass the contents (e.g. + /// text for a Button, child controls for a container). The MinimumSize and + /// MaximumSize are followed, but the current value of the Size property is + /// ignored. /// GrowAndShrink, /// - /// The control will grow as much as it needs to encompass its contents (e.g. - /// text for a button, child controls for a container), but will not shrink - /// smaller than its Size, whichever is larger. + /// The control will grow as much as it needs to encompass its contents (e.g. + /// text for a button, child controls for a container), but will not shrink + /// smaller than its Size, whichever is larger. /// GrowOnly } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AutoValidate.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AutoValidate.cs index d18369c1988..0ab84a68673 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AutoValidate.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AutoValidate.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms { /// - /// For a given container control, determines whether the data in child controls - /// will automatically be validated when the user attempts to change the focus. + /// For a given container control, determines whether the data in child controls + /// will automatically be validated when the user attempts to change the focus. /// public enum AutoValidate { /// - /// Controls in this container will not be validated when the focus changes. + /// Controls in this container will not be validated when the focus changes. /// Disable = 0, /// - /// Controls in this container will be validated when the focus changes. - /// If a validation error occurs, the focus is forced to stay in the - /// current control. + /// Controls in this container will be validated when the focus changes. + /// If a validation error occurs, the focus is forced to stay in the + /// current control. /// EnablePreventFocusChange = 1, /// - /// Controls in this container will be validated when the focus changes. - /// If a validation error occurs, the focus is allowed to move to the other - /// control. + /// Controls in this container will be validated when the focus changes. + /// If a validation error occurs, the focus is allowed to move to the other + /// control. /// EnableAllowFocusChange = 2, /// - /// AutoValidate setting for this container is determined by its parent container. + /// AutoValidate setting for this container is determined by its parent container. /// Inherit = -1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationLiveSetting.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationLiveSetting.cs index e2a5901f179..058f3d75da6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationLiveSetting.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationLiveSetting.cs @@ -5,26 +5,26 @@ namespace System.Windows.Forms.Automation { /// - /// Describes the notification characteristics of a particular live region + /// Describes the notification characteristics of a particular live region /// public enum AutomationLiveSetting { /// - /// The element does not send notifications if the content of the live region has changed. + /// The element does not send notifications if the content of the live region has changed. /// Off = 0, /// - /// The element sends non-interruptive notifications if the content of the live region has - /// changed. With this setting, UI Automation clients and assistive technologies are expected - /// to not interrupt the user to inform of changes to the live region. + /// The element sends non-interruptive notifications if the content of the live region has + /// changed. With this setting, UI Automation clients and assistive technologies are expected + /// to not interrupt the user to inform of changes to the live region. /// Polite = 1, /// - /// The element sends interruptive notifications if the content of the live region has changed. - /// With this setting, UI Automation clients and assistive technologies are expected to interrupt - /// the user to inform of changes to the live region. + /// The element sends interruptive notifications if the content of the live region has changed. + /// With this setting, UI Automation clients and assistive technologies are expected to interrupt + /// the user to inform of changes to the live region. /// Assertive = 2 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationKind.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationKind.cs index 0eb8fa8687e..73131684a68 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationKind.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationKind.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms.Automation { /// - /// Indicates the type of notification when raising the UIA Notification event. + /// Indicates the type of notification when raising the UIA Notification event. /// public enum AutomationNotificationKind { /// - /// The current element container has had something added to it that should be presented to the user. + /// The current element container has had something added to it that should be presented to the user. /// ItemAdded = 0, /// - /// The current element has had something removed from inside it that should be presented to the user. + /// The current element has had something removed from inside it that should be presented to the user. /// ItemRemoved = 1, /// - /// The current element has a notification that an action was completed. + /// The current element has a notification that an action was completed. /// ActionCompleted = 2, /// - /// The current element has a notification that an action was abandoned. + /// The current element has a notification that an action was abandoned. /// ActionAborted = 3, /// - /// The current element has a notification not an add, remove, completed, or aborted action. + /// The current element has a notification not an add, remove, completed, or aborted action. /// Other = 4 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationProcessing.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationProcessing.cs index 4421d1c7dba..2e8048a6cf2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationProcessing.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/AutomationNotificationProcessing.cs @@ -5,44 +5,44 @@ namespace System.Windows.Forms.Automation { /// - /// Specifies the order in which to process a notification. + /// Specifies the order in which to process a notification. /// public enum AutomationNotificationProcessing { /// - /// These notifications should be presented to the user as soon as possible. - /// All of the notifications from this source should be delivered to the user. - /// Warning: - /// Use this in a limited capacity as this style of message could cause a flooding - /// for information to the end user due to the nature of the request to deliver all of the notifications. + /// These notifications should be presented to the user as soon as possible. + /// All of the notifications from this source should be delivered to the user. + /// Warning: + /// Use this in a limited capacity as this style of message could cause a flooding + /// for information to the end user due to the nature of the request to deliver all of the notifications. /// ImportantAll = 0, /// - /// These notifications should be presented to the user as soon as possible. - /// The most recent notifications from this source should be delivered to the user - /// because the most recent notification supersedes all of the other notifications. + /// These notifications should be presented to the user as soon as possible. + /// The most recent notifications from this source should be delivered to the user + /// because the most recent notification supersedes all of the other notifications. /// ImportantMostRecent = 1, /// - /// These notifications should be presented to the user when possible. - /// All of the notifications from this source should be delivered to the user. + /// These notifications should be presented to the user when possible. + /// All of the notifications from this source should be delivered to the user. /// All = 2, /// - /// These notifications should be presented to the user when possible. - /// Interrupt the current notification for this one. + /// These notifications should be presented to the user when possible. + /// Interrupt the current notification for this one. /// MostRecent = 3, /// - /// These notifications should be presented to the user when possible. - /// Don’t interrupt the current notification for this one. - /// If new notifications come in from the same source while the current notification is being presented, - /// then keep the most recent and ignore the rest until the current processing is completed. - /// Then use the most recent message as the current message. + /// These notifications should be presented to the user when possible. + /// Don’t interrupt the current notification for this one. + /// If new notifications come in from the same source while the current notification is being presented, + /// then keep the most recent and ignore the rest until the current processing is completed. + /// Then use the most recent message as the current message. /// CurrentThenMostRecent = 4 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/IAutomationLiveRegion.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/IAutomationLiveRegion.cs index 893053802c5..917e30eafbc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Automation/IAutomationLiveRegion.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Automation/IAutomationLiveRegion.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.Automation public interface IAutomationLiveRegion { /// - /// Gets or sets notification characteristics of the live region. + /// Gets or sets notification characteristics of the live region. /// AutomationLiveSetting LiveSetting { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/AxHost.cs b/src/System.Windows.Forms/src/System/Windows/Forms/AxHost.cs index f978cf8d6ab..f994119d515 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/AxHost.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/AxHost.cs @@ -1136,7 +1136,7 @@ public override ISite Site } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnLostFocus(EventArgs e) @@ -1504,8 +1504,8 @@ private bool CheckSubclassing() } /// - /// Destroys the handle associated with this control. - /// User code should in general not call this function. + /// Destroys the handle associated with this control. + /// User code should in general not call this function. /// protected override void DestroyHandle() { @@ -2015,9 +2015,9 @@ public override bool PreProcessMessage(ref Message msg) } /// - /// Process a mnemonic character. - /// This is done by manufacturing a WM_SYSKEYDOWN message and passing it to the - /// ActiveX control. + /// Process a mnemonic character. + /// This is done by manufacturing a WM_SYSKEYDOWN message and passing it to the + /// ActiveX control. /// protected internal override bool ProcessMnemonic(char charCode) { @@ -2250,7 +2250,7 @@ public ContainerControl ContainingControl } /// - /// Determines if the Text property needs to be persisted. + /// Determines if the Text property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal override bool ShouldSerializeText() @@ -2754,8 +2754,8 @@ AttributeCollection ICustomTypeDescriptor.GetAttributes() } /// - /// Retrieves the class name for this object. If null is returned, - /// the type name is used. + /// Retrieves the class name for this object. If null is returned, + /// the type name is used. /// [EditorBrowsable(EditorBrowsableState.Advanced)] string ICustomTypeDescriptor.GetClassName() @@ -2764,8 +2764,8 @@ string ICustomTypeDescriptor.GetClassName() } /// - /// Retrieves the name for this object. If null is returned, - /// the default is used. + /// Retrieves the name for this object. If null is returned, + /// the default is used. /// [EditorBrowsable(EditorBrowsableState.Advanced)] string ICustomTypeDescriptor.GetComponentName() @@ -2774,7 +2774,7 @@ string ICustomTypeDescriptor.GetComponentName() } /// - /// Retrieves the type converter for this object. + /// Retrieves the type converter for this object. /// [EditorBrowsable(EditorBrowsableState.Advanced)] TypeConverter ICustomTypeDescriptor.GetConverter() @@ -2795,7 +2795,7 @@ PropertyDescriptor ICustomTypeDescriptor.GetDefaultProperty() } /// - /// Retrieves the an editor for this object. + /// Retrieves the an editor for this object. /// [EditorBrowsable(EditorBrowsableState.Advanced)] object ICustomTypeDescriptor.GetEditor(Type editorBaseType) @@ -3806,8 +3806,8 @@ public class ConnectionPointCookie private readonly string callStack; #endif /// - /// Creates a connection point to of the given interface type. - /// which will call on a managed code sink that implements that interface. + /// Creates a connection point to of the given interface type. + /// which will call on a managed code sink that implements that interface. /// public ConnectionPointCookie(object source, object sink, Type eventInterface) : this(source, sink, eventInterface, true) @@ -3890,8 +3890,8 @@ internal ConnectionPointCookie(object source, object sink, Type eventInterface, } /// - /// Disconnect the current connection point. If the object is not connected, - /// this method will do nothing. + /// Disconnect the current connection point. If the object is not connected, + /// this method will do nothing. /// public void Disconnect() { @@ -7291,7 +7291,7 @@ internal void Save(MemoryStream stream) } /// - /// ISerializable private implementation + /// ISerializable private implementation /// void ISerializable.GetObjectData(SerializationInfo si, StreamingContext context) { @@ -7684,9 +7684,9 @@ internal void UpdateAttributes() } /// - /// Called externally to update the editor or type converter. - /// This simply sets flags so this will happen, it doesn't actually to the update... - /// we wait and do that on-demand for perf. + /// Called externally to update the editor or type converter. + /// This simply sets flags so this will happen, it doesn't actually to the update... + /// we wait and do that on-demand for perf. /// internal void UpdateTypeConverterAndTypeEditor(bool force) { @@ -7699,9 +7699,9 @@ internal void UpdateTypeConverterAndTypeEditor(bool force) } /// - /// Called externally to update the editor or type converter. - /// This simply sets flags so this will happen, it doesn't actually to the update... - /// we wait and do that on-demand for perf. + /// Called externally to update the editor or type converter. + /// This simply sets flags so this will happen, it doesn't actually to the update... + /// we wait and do that on-demand for perf. /// internal void UpdateTypeConverterAndTypeEditorInternal(bool force, int dispid) { @@ -7876,8 +7876,8 @@ public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext contex } /// - /// simple derivation of the com2enumconverter that allows us to intercept - /// the call to GetStandardValues so we can on-demand update the enum values. + /// simple derivation of the com2enumconverter that allows us to intercept + /// the call to GetStandardValues so we can on-demand update the enum values. /// private class AxEnumConverter : Com2EnumConverter { @@ -7923,7 +7923,7 @@ public AxPerPropertyBrowsingEnum(AxPropertyDescriptor targetObject, AxHost owner } /// - /// Retrieve a copy of the value array + /// Retrieve a copy of the value array /// public override object[] Values { @@ -7935,7 +7935,7 @@ public override object[] Values } /// - /// Retrieve a copy of the nme array. + /// Retrieve a copy of the nme array. /// public override string[] Names { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BaseCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BaseCollection.cs index 53c1b5bd80d..aaf1ba97632 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BaseCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BaseCollection.cs @@ -8,12 +8,12 @@ namespace System.Windows.Forms { /// - /// Provides the base functionality for creating collections. + /// Provides the base functionality for creating collections. /// public class BaseCollection : MarshalByRefObject, ICollection { /// - /// Gets the total number of elements in a collection. + /// Gets the total number of elements in a collection. /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Advanced)] @@ -22,7 +22,7 @@ public class BaseCollection : MarshalByRefObject, ICollection public void CopyTo(Array ar, int index) => List.CopyTo(ar, index); /// - /// Gets an IEnumerator for the collection. + /// Gets an IEnumerator for the collection. /// public IEnumerator GetEnumerator() => List.GetEnumerator(); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Binding.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Binding.cs index b8c8febc27a..0ddb07d5c38 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Binding.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Binding.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Represents a simple binding of a value in a list and the property of a control. + /// Represents a simple binding of a value in a list and the property of a control. /// [TypeConverter(typeof(ListBindingConverter))] public class Binding @@ -49,8 +49,8 @@ public class Binding private BindingCompleteEventHandler _onComplete = null; /// - /// Initializes a new instance of the class - /// that binds a property on the owning control to a property on a data source. + /// Initializes a new instance of the class + /// that binds a property on the owning control to a property on a data source. /// public Binding(string propertyName, object dataSource, string dataMember) : this(propertyName, dataSource, dataMember, false, 0, null, string.Empty, null) { @@ -90,7 +90,7 @@ public Binding(string propertyName, object dataSource, string dataMember, bool f } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// private Binding() { @@ -101,21 +101,21 @@ private Binding() public BindingMemberInfo BindingMemberInfo { get; } /// - /// Gets the control to which the binding belongs. + /// Gets the control to which the binding belongs. /// [DefaultValue(null)] public IBindableComponent BindableComponent => _control; /// - /// Gets the control to which the binding belongs. + /// Gets the control to which the binding belongs. /// [DefaultValue(null)] public Control Control => _control as Control; /// - /// Is the binadable component in a 'created' (ready-to-use) state? For controls, - /// this depends on whether the window handle has been created yet. For everything - /// else, we'll assume they are always in a created state. + /// Is the binadable component in a 'created' (ready-to-use) state? For controls, + /// this depends on whether the window handle has been created yet. For everything + /// else, we'll assume they are always in a created state. /// internal static bool IsComponentCreated(IBindableComponent component) { @@ -123,7 +123,7 @@ internal static bool IsComponentCreated(IBindableComponent component) } // - /// Instance-specific property equivalent to the static method above + /// Instance-specific property equivalent to the static method above // internal bool ComponentCreated => IsComponentCreated(_control); @@ -165,13 +165,13 @@ internal void SetBindableComponent(IBindableComponent value) } /// - /// Gets a value indicating whether the binding is active. + /// Gets a value indicating whether the binding is active. /// public bool IsBinding => _bound; /// - /// Gets the of this binding that - /// allows enumeration of a set of bindings. + /// Gets the of this binding that + /// allows enumeration of a set of bindings. /// public BindingManagerBase BindingManagerBase { @@ -199,7 +199,7 @@ internal set } /// - /// Gets or sets the property on the control to bind to. + /// Gets or sets the property on the control to bind to. /// [DefaultValue("")] public string PropertyName { get; } = string.Empty; @@ -736,13 +736,13 @@ private object FormatObject(object value) } /// - /// Pulls data from control property into data source. Returns bool indicating whether caller - /// should cancel the higher level operation. Raises a BindingComplete event regardless of - /// success or failure. + /// Pulls data from control property into data source. Returns bool indicating whether caller + /// should cancel the higher level operation. Raises a BindingComplete event regardless of + /// success or failure. /// - /// When the user leaves the control, it will raise a Validating event, calling the Binding.Target_Validate - /// method, which in turn calls PullData. PullData is also called by the binding manager when pulling data - /// from all bounds properties in one go. + /// When the user leaves the control, it will raise a Validating event, calling the Binding.Target_Validate + /// method, which in turn calls PullData. PullData is also called by the binding manager when pulling data + /// from all bounds properties in one go. /// internal bool PullData() => PullData(reformat: true, force: false); @@ -878,9 +878,9 @@ internal bool PullData(bool reformat, bool force) } /// - /// Pushes data from data source into control property. Returns bool indicating whether caller - /// should cancel the higher level operation. Raises a BindingComplete event regardless of - /// success or failure. + /// Pushes data from data source into control property. Returns bool indicating whether caller + /// should cancel the higher level operation. Raises a BindingComplete event regardless of + /// success or failure. /// internal bool PushData() => PushData(force: false); @@ -944,12 +944,12 @@ internal bool PushData(bool force) } /// - /// Reads current value from data source, and sends this to the control. + /// Reads current value from data source, and sends this to the control. /// public void ReadValue() => PushData(force: true); /// - /// Takes current value from control, and writes this out to the data source. + /// Takes current value from control, and writes this out to the data source. /// public void WriteValue() => PullData(reformat: true, force: true); @@ -1030,14 +1030,14 @@ private void Target_PropertyChanged(object sender, EventArgs e) } /// - /// Event handler for the Control.Validating event on the control that we are bound to. + /// Event handler for the Control.Validating event on the control that we are bound to. /// - /// If value in control has changed, we want to send that value back up to the data source - /// when the control undergoes validation (eg. on loss of focus). If an error occurs, we - /// will set e.Cancel=true to make validation fail and force focus to remain on the control. + /// If value in control has changed, we want to send that value back up to the data source + /// when the control undergoes validation (eg. on loss of focus). If an error occurs, we + /// will set e.Cancel=true to make validation fail and force focus to remain on the control. /// - /// NOTE: If no error occurs, we MUST leave e.Cancel alone, to respect any value put in there - /// by event handlers high up the event chain. + /// NOTE: If no error occurs, we MUST leave e.Cancel alone, to respect any value put in there + /// by event handlers high up the event chain. /// private void Target_Validate(object sender, CancelEventArgs e) { @@ -1170,8 +1170,8 @@ internal void SetBindingManagerBase(BindingManagerBase lManager) internal string DataErrorText => _errorText; /// - /// Returns any data error info on the data source for the bound data field - /// in the current row + /// Returns any data error info on the data source for the bound data field + /// in the current row /// private string GetErrorText(object value) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteContext.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteContext.cs index f0d686a15cd..4dade449373 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteContext.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteContext.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Indicates the direction of a binding operation. + /// Indicates the direction of a binding operation. /// public enum BindingCompleteContext { /// - /// Control value is being updated from data source value. + /// Control value is being updated from data source value. /// ControlUpdate = 0, /// - /// Data source value is being updated from control value. + /// Data source value is being updated from control value. /// DataSourceUpdate = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventArgs.cs index a8f8ff45396..788a547db3c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// Provides information about a Binding Completed event. + /// Provides information about a Binding Completed event. /// public class BindingCompleteEventArgs : CancelEventArgs { /// - /// Constructor for BindingCompleteEventArgs. + /// Constructor for BindingCompleteEventArgs. /// public BindingCompleteEventArgs(Binding binding, BindingCompleteState state, @@ -29,7 +29,7 @@ public BindingCompleteEventArgs(Binding binding, } /// - /// Constructor for BindingCompleteEventArgs. + /// Constructor for BindingCompleteEventArgs. /// public BindingCompleteEventArgs(Binding binding, BindingCompleteState state, @@ -40,7 +40,7 @@ public BindingCompleteEventArgs(Binding binding, } /// - /// Constructor for BindingCompleteEventArgs. + /// Constructor for BindingCompleteEventArgs. /// public BindingCompleteEventArgs(Binding binding, BindingCompleteState state, @@ -50,7 +50,7 @@ public BindingCompleteEventArgs(Binding binding, } /// - /// Constructor for BindingCompleteEventArgs. + /// Constructor for BindingCompleteEventArgs. /// public BindingCompleteEventArgs(Binding binding, BindingCompleteState state, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventHandler.cs index 8c439cf0977..bd29b64c014 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle the Binding Complete event. + /// Represents a method that will handle the Binding Complete event. /// public delegate void BindingCompleteEventHandler(object sender, BindingCompleteEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteState.cs index aaf051176f7..e0585edf52b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingCompleteState.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Indicates the result of a completed binding operation. + /// Indicates the result of a completed binding operation. /// public enum BindingCompleteState { /// - /// Binding operation completed successfully. + /// Binding operation completed successfully. /// Success = 0, /// - /// Binding operation failed with a data error. + /// Binding operation failed with a data error. /// DataError = 1, /// - /// Binding operation failed with an exception. + /// Binding operation failed with an exception. /// Exception = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingContext.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingContext.cs index eda669c2a96..cad0a5ae941 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingContext.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingContext.cs @@ -10,8 +10,8 @@ namespace System.Windows.Forms { /// - /// Manages the collection of System.Windows.Forms.BindingManagerBase - /// objects for a Win Form. + /// Manages the collection of System.Windows.Forms.BindingManagerBase + /// objects for a Win Form. /// [DefaultEvent(nameof(CollectionChanged))] public class BindingContext : ICollection @@ -19,7 +19,7 @@ public class BindingContext : ICollection private readonly Hashtable _listManagers; /// - /// Initializes a new instance of the System.Windows.Forms.BindingContext class. + /// Initializes a new instance of the System.Windows.Forms.BindingContext class. /// public BindingContext() { @@ -27,7 +27,7 @@ public BindingContext() } /// - /// Gets the total number of System.Windows.Forms.BindingManagerBases objects. + /// Gets the total number of System.Windows.Forms.BindingManagerBases objects. /// int ICollection.Count { @@ -39,8 +39,8 @@ int ICollection.Count } /// - /// Copies the elements of the collection into a specified array, starting - /// at the collection index. + /// Copies the elements of the collection into a specified array, starting + /// at the collection index. /// void ICollection.CopyTo(Array ar, int index) { @@ -49,7 +49,7 @@ void ICollection.CopyTo(Array ar, int index) } /// - /// Gets an enumerator for the collection. + /// Gets an enumerator for the collection. /// IEnumerator IEnumerable.GetEnumerator() { @@ -58,29 +58,29 @@ IEnumerator IEnumerable.GetEnumerator() } /// - /// Gets a value indicating whether the collection is read-only. + /// Gets a value indicating whether the collection is read-only. /// public bool IsReadOnly => false; /// - /// Gets a value indicating whether the collection is synchronized. + /// Gets a value indicating whether the collection is synchronized. /// bool ICollection.IsSynchronized => false; /// - /// Gets an object to use for synchronization (thread safety). + /// Gets an object to use for synchronization (thread safety). /// object ICollection.SyncRoot => null; /// - /// Gets the System.Windows.Forms.BindingManagerBase associated with the specified - /// data source. + /// Gets the System.Windows.Forms.BindingManagerBase associated with the specified + /// data source. /// public BindingManagerBase this[object dataSource] => this[dataSource, string.Empty]; /// - /// Gets the System.Windows.Forms.BindingManagerBase associated with the specified - /// data source and data member. + /// Gets the System.Windows.Forms.BindingManagerBase associated with the specified + /// data source and data member. /// public BindingManagerBase this[object dataSource, string dataMember] { @@ -88,14 +88,14 @@ IEnumerator IEnumerable.GetEnumerator() } /// - /// Adds the listManager to the collection. An ArgumentNullException is thrown if this - /// listManager is null. An exception is thrown if a listManager to the same target - /// and Property as an existing listManager or if the listManager's column isn't a - /// valid column given this DataSource.Table's schema. - /// Fires the CollectionChangedEvent. + /// Adds the listManager to the collection. An ArgumentNullException is thrown if this + /// listManager is null. An exception is thrown if a listManager to the same target + /// and Property as an existing listManager or if the listManager's column isn't a + /// valid column given this DataSource.Table's schema. + /// Fires the CollectionChangedEvent. /// /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected internal void Add(object dataSource, BindingManagerBase listManager) { @@ -104,7 +104,7 @@ protected internal void Add(object dataSource, BindingManagerBase listManager) } /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected virtual void AddCore(object dataSource, BindingManagerBase listManager) { @@ -121,10 +121,10 @@ protected virtual void AddCore(object dataSource, BindingManagerBase listManager } /// - /// Occurs when the collection has changed. + /// Occurs when the collection has changed. /// /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// [SRDescription(nameof(SR.collectionChangedEventDescr)), EditorBrowsable(EditorBrowsableState.Never), Browsable(false)] public event CollectionChangeEventHandler CollectionChanged @@ -139,11 +139,11 @@ public event CollectionChangeEventHandler CollectionChanged } /// - /// Clears the collection of any bindings. - /// Fires the CollectionChangedEvent. + /// Clears the collection of any bindings. + /// Fires the CollectionChangedEvent. /// /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected internal void Clear() { @@ -152,22 +152,22 @@ protected internal void Clear() } /// - /// Clears the collection. + /// Clears the collection. /// /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected virtual void ClearCore() => _listManagers.Clear(); /// - /// Gets a value indicating whether the System.Windows.Forms.BindingContext contains - /// the specified data source. + /// Gets a value indicating whether the System.Windows.Forms.BindingContext contains + /// the specified data source. /// public bool Contains(object dataSource) => Contains(dataSource, string.Empty); /// - /// Gets a value indicating whether the System.Windows.Forms.BindingContext - /// contains the specified data source and data member. + /// Gets a value indicating whether the System.Windows.Forms.BindingContext + /// contains the specified data source and data member. /// public bool Contains(object dataSource, string dataMember) { @@ -217,21 +217,21 @@ public override bool Equals(object target) } /// - /// This method is called whenever the collection changes. Overriders of this method - /// should call the base implementation of this method. + /// This method is called whenever the collection changes. Overriders of this method + /// should call the base implementation of this method. /// protected virtual void OnCollectionChanged(CollectionChangeEventArgs ccevent) { } /// - /// Removes the given listManager from the collection. - /// An ArgumentNullException is thrown if this listManager is null. An ArgumentException - /// is thrown if this listManager doesn't belong to this collection. - /// The CollectionChanged event is fired if it succeeds. + /// Removes the given listManager from the collection. + /// An ArgumentNullException is thrown if this listManager is null. An ArgumentException + /// is thrown if this listManager doesn't belong to this collection. + /// The CollectionChanged event is fired if it succeeds. /// /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected internal void Remove(object dataSource) { @@ -240,7 +240,7 @@ protected internal void Remove(object dataSource) } /// - /// This method is obsolete and unused. + /// This method is obsolete and unused. /// protected virtual void RemoveCore(object dataSource) { @@ -248,10 +248,10 @@ protected virtual void RemoveCore(object dataSource) } /// - /// Create a suitable binding manager for the specified dataSource/dataMember combination. - /// - If one has already been created and cached by this BindingContext, return that + /// Create a suitable binding manager for the specified dataSource/dataMember combination. + /// - If one has already been created and cached by this BindingContext, return that /// instead. - /// - If the data source is an ICurrencyManagerProvider, just delegate to the data + /// - If the data source is an ICurrencyManagerProvider, just delegate to the data /// source. /// private BindingManagerBase EnsureListManager(object dataSource, string dataMember) @@ -395,9 +395,9 @@ private void ScrubWeakRefs() } /// - /// Associates a Binding with a different BindingContext. Intended for use by components - /// that support IBindableComponent, to update their Bindings when the value of - /// IBindableComponent.BindingContext is changed. + /// Associates a Binding with a different BindingContext. Intended for use by components + /// that support IBindableComponent, to update their Bindings when the value of + /// IBindableComponent.BindingContext is changed. /// public static void UpdateBinding(BindingContext newBindingContext, Binding binding) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingManagerBase.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingManagerBase.cs index ad38fba9a02..0c7e6de8144 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingManagerBase.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingManagerBase.cs @@ -279,16 +279,16 @@ protected void PushData() public abstract int Count { get; } /// - /// BindingComplete events on individual Bindings are propagated up through the BindingComplete event on - /// the owning BindingManagerBase. To do this, we have to track changes to the bindings collection, adding - /// or removing handlers on items in the collection as appropriate. + /// BindingComplete events on individual Bindings are propagated up through the BindingComplete event on + /// the owning BindingManagerBase. To do this, we have to track changes to the bindings collection, adding + /// or removing handlers on items in the collection as appropriate. /// - /// For the Add and Remove cases, we hook the collection 'changed' event, and add or remove handler for - /// specific binding. + /// For the Add and Remove cases, we hook the collection 'changed' event, and add or remove handler for + /// specific binding. /// - /// For the Refresh case, we hook both the 'changing' and 'changed' events, removing handlers for all - /// items that were in the collection before the change, then adding handlers for whatever items are - /// in the collection after the change. + /// For the Refresh case, we hook both the 'changing' and 'changed' events, removing handlers for all + /// items that were in the collection before the change, then adding handlers for whatever items are + /// in the collection after the change. /// private void OnBindingsCollectionChanged(object sender, CollectionChangeEventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingSource.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingSource.cs index 6fbddaffb3a..b03f30f840b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingSource.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingSource.cs @@ -526,8 +526,8 @@ private void ClearInvalidDataMember() } /// - /// Creates an instance of BindingList where T is only known at run time, - /// not compile time + /// Creates an instance of BindingList where T is only known at run time, + /// not compile time /// private static IList CreateBindingList(Type type) { @@ -538,7 +538,7 @@ private static IList CreateBindingList(Type type) } /// - /// Create an object of the given type. Throw an exception if this fails. + /// Create an object of the given type. Throw an exception if this fails. /// private static object CreateInstanceOfType(Type type) { @@ -597,11 +597,11 @@ private void CurrencyManager_DataError(object sender, BindingManagerDataErrorEve } /// - /// Unhook BindingSource from its data source, since the data source could be some - /// global object who's lifetime exceeds the lifetime of the parent form. Otherwise - /// the BindingSource (and any components bound through it) will end up in limbo, - /// still processing list change events, etc. And when unhooking from the data source, - /// take care not to trigger any events that could confuse compoents bound to us. + /// Unhook BindingSource from its data source, since the data source could be some + /// global object who's lifetime exceeds the lifetime of the parent form. Otherwise + /// the BindingSource (and any components bound through it) will end up in limbo, + /// still processing list change events, etc. And when unhooking from the data source, + /// take care not to trigger any events that could confuse compoents bound to us. /// protected override void Dispose(bool disposing) { @@ -642,9 +642,9 @@ public void EndEdit() } /// - /// Ensures that the inner list has been set up. Handles the case of ResetList() being - /// called during initialization, which sets a flag to defer ResetList() work until - /// after initialization is complete. + /// Ensures that the inner list has been set up. Handles the case of ResetList() being + /// called during initialization, which sets a flag to defer ResetList() work until + /// after initialization is complete. /// private void EnsureInnerList() { @@ -656,8 +656,8 @@ private void EnsureInnerList() } /// - /// Overload of IBindingList.Find that takes a string instead of a property - /// descriptor (for convenience). + /// Overload of IBindingList.Find that takes a string instead of a property + /// descriptor (for convenience). /// public int Find(string propertyName, object key) { @@ -671,10 +671,10 @@ public int Find(string propertyName, object key) } /// - /// Given a type, create a list based on that type. If the type represents a list type, - /// we create an instance of that type (or throw if we cannot instance that type). - /// Otherwise we assume the type represents the item type, in which case we create - /// a typed BindingList of that item type. + /// Given a type, create a list based on that type. If the type represents a list type, + /// we create an instance of that type (or throw if we cannot instance that type). + /// Otherwise we assume the type represents the item type, in which case we create + /// a typed BindingList of that item type. /// private static IList GetListFromType(Type type) { @@ -693,9 +693,9 @@ private static IList GetListFromType(Type type) } /// - /// Creates a list based on an enumerable object. We rip through the enumerable, - /// extract all its items, and stuff these items into a typed BindingList, using - /// the type of the first item to determine the type of the list. + /// Creates a list based on an enumerable object. We rip through the enumerable, + /// extract all its items, and stuff these items into a typed BindingList, using + /// the type of the first item to determine the type of the list. /// private static IList GetListFromEnumerable(IEnumerable enumerable) { @@ -715,9 +715,9 @@ private static IList GetListFromEnumerable(IEnumerable enumerable) } /// - /// Used when we change data sources or when the properties of the current data source change. - /// Decides whether this would be a good time to blow away the data member field, since it - /// might not refer to a valid data source property any more. + /// Used when we change data sources or when the properties of the current data source change. + /// Decides whether this would be a good time to blow away the data member field, since it + /// might not refer to a valid data source property any more. /// private bool IsDataMemberValid() { @@ -794,8 +794,8 @@ private void ListItem_PropertyChanged(object sender, EventArgs e) public void MovePrevious() => Position--; /// - /// This method is used to fire ListChanged events when the inner list - /// is not an IBindingList (and therefore cannot fire them itself). + /// This method is used to fire ListChanged events when the inner list + /// is not an IBindingList (and therefore cannot fire them itself). /// private void OnSimpleListChanged(ListChangedType listChangedType, int newIndex) { @@ -873,11 +873,11 @@ protected virtual void OnPositionChanged(EventArgs e) } /// - /// When the data member is set, and the data source signals a change of current item, - /// we need to query its new current item for the list specified by the data member. - /// Or if there is no longer a current item on the data source, we use an empty list. - /// In either case, we only have to change lists, not metadata, since we can assume - /// that the new list has the same item properties as the old list. + /// When the data member is set, and the data source signals a change of current item, + /// we need to query its new current item for the list specified by the data member. + /// Or if there is no longer a current item on the data source, we use an empty list. + /// In either case, we only have to change lists, not metadata, since we can assume + /// that the new list has the same item properties as the old list. /// private void ParentCurrencyManager_CurrentItemChanged(object sender, EventArgs e) { @@ -968,10 +968,10 @@ private void ParentCurrencyManager_CurrentItemChanged(object sender, EventArgs e } /// - /// When the data source signals a change of metadata, we need to re-query for the - /// list specified by the data member field. If the data member is no longer valid - /// under the data source's new metadata, we have no choice but to clear the data - /// member field and just bind directly to the data source itself. + /// When the data source signals a change of metadata, we need to re-query for the + /// list specified by the data member field. If the data member is no longer valid + /// under the data source's new metadata, we have no choice but to clear the data + /// member field and just bind directly to the data source itself. /// private void ParentCurrencyManager_MetaDataChanged(object sender, EventArgs e) { @@ -1081,8 +1081,8 @@ public void ResetItem(int itemIndex) public void SuspendBinding() => _currencyManager.SuspendBinding(); /// - /// Binds the BindingSource to the list specified by its DataSource and DataMember - /// properties. + /// Binds the BindingSource to the list specified by its DataSource and DataMember + /// properties. /// private void ResetList() { @@ -1163,8 +1163,8 @@ private void ResetList() } /// - /// Binds the BindingSource to the specified list, rewiring internal event handlers, - /// firing any appropriate external events, and updating all relevant field members. + /// Binds the BindingSource to the specified list, rewiring internal event handlers, + /// firing any appropriate external events, and updating all relevant field members. /// private void SetList(IList list, bool metaDataChanged, bool applySortAndFilter) { @@ -1251,7 +1251,7 @@ private static IList WrapObjectInBindingList(object obj) internal virtual bool ShouldSerializeAllowNew() => _allowNewIsSet; /// - /// Hooks property changed events for the NEW current item, if nececssary + /// Hooks property changed events for the NEW current item, if nececssary private void HookItemChangedEventsForNewCurrent() { Debug.Assert(_currentItemHookedForItemChange == null, "BindingSource trying to hook new current item before unhooking old current item!"); @@ -1271,7 +1271,7 @@ private void HookItemChangedEventsForNewCurrent() } /// - /// Unhooks property changed events for the OLD current item, if necessary + /// Unhooks property changed events for the OLD current item, if necessary /// private void UnhookItemChangedEventsForOldCurrent() { @@ -1369,14 +1369,14 @@ private void UnwirePropertyChangedEvents(object item) } /// - /// Begin bulk member initialization - deferring calculation of inner list until - /// EndInit is reached + /// Begin bulk member initialization - deferring calculation of inner list until + /// EndInit is reached /// void ISupportInitialize.BeginInit() => _initializing = true; /// - /// End bulk member initialization - updating the inner list and notifying any - /// dependents of our completion + /// End bulk member initialization - updating the inner list and notifying any + /// dependents of our completion /// private void EndInitCore() { @@ -1386,12 +1386,12 @@ private void EndInitCore() } /// - /// Check to see if DataSource has completed its initialization, before ending our - /// initialization. - /// If DataSource is still initializing, hook its Initialized event and wait for it - /// to signal completion. - /// If DataSource is already initialized, just go ahead and complete our - /// initialization now. + /// Check to see if DataSource has completed its initialization, before ending our + /// initialization. + /// If DataSource is still initializing, hook its Initialized event and wait for it + /// to signal completion. + /// If DataSource is already initialized, just go ahead and complete our + /// initialization now. /// void ISupportInitialize.EndInit() { @@ -1406,10 +1406,10 @@ void ISupportInitialize.EndInit() } /// - /// Respond to late completion of the DataSource's initialization, by completing our - /// own initialization. This situation can arise if the call to the DataSource's - /// EndInit() method comes after the call to the BindingSource's EndInit() method - /// (since code-generated ordering of these calls is non-deterministic). + /// Respond to late completion of the DataSource's initialization, by completing our + /// own initialization. This situation can arise if the call to the DataSource's + /// EndInit() method comes after the call to the BindingSource's EndInit() method + /// (since code-generated ordering of these calls is non-deterministic). /// private void DataSource_Initialized(object sender, EventArgs e) { @@ -1422,13 +1422,13 @@ private void DataSource_Initialized(object sender, EventArgs e) } /// - /// Report to any dependents whether we are still in bulk member initialization + /// Report to any dependents whether we are still in bulk member initialization /// bool ISupportInitializeNotification.IsInitialized => !_initializing; /// - /// Event used to signal to our dependents that we have completed bulk member - /// initialization and updated our inner list + /// Event used to signal to our dependents that we have completed bulk member + /// initialization and updated our inner list /// event EventHandler ISupportInitializeNotification.Initialized { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BindingsCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BindingsCollection.cs index 72c9ef699e7..5fcd7bead30 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BindingsCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BindingsCollection.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Represents a collection of data bindings on a control. + /// Represents a collection of data bindings on a control. /// [DefaultEvent(nameof(CollectionChanged))] public class BindingsCollection : BaseCollection @@ -24,12 +24,12 @@ internal BindingsCollection() public override int Count => _list == null ? 0 : base.Count; /// - /// Gets the bindings in the collection as an object. + /// Gets the bindings in the collection as an object. /// protected override ArrayList List => _list ?? (_list = new ArrayList()); /// - /// Gets the at the specified index. + /// Gets the at the specified index. /// public Binding this[int index] => (Binding)List[index]; @@ -42,7 +42,7 @@ internal protected void Add(Binding binding) } /// - /// Adds a to the collection. + /// Adds a to the collection. /// protected virtual void AddCore(Binding dataBinding) { @@ -55,7 +55,7 @@ protected virtual void AddCore(Binding dataBinding) } /// - /// Occurs when the collection is about to change. + /// Occurs when the collection is about to change. /// [SRDescription(nameof(SR.collectionChangingEventDescr))] public event CollectionChangeEventHandler CollectionChanging @@ -65,7 +65,7 @@ public event CollectionChangeEventHandler CollectionChanging } /// - /// Occurs when the collection is changed. + /// Occurs when the collection is changed. /// [SRDescription(nameof(SR.collectionChangedEventDescr))] public event CollectionChangeEventHandler CollectionChanged @@ -83,12 +83,12 @@ internal protected void Clear() } /// - /// Clears the collection of any members. + /// Clears the collection of any members. /// protected virtual void ClearCore() => List.Clear(); /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnCollectionChanging(CollectionChangeEventArgs e) { @@ -96,7 +96,7 @@ protected virtual void OnCollectionChanging(CollectionChangeEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnCollectionChanged(CollectionChangeEventArgs ccevent) { @@ -114,7 +114,7 @@ internal protected void Remove(Binding binding) internal protected void RemoveAt(int index) => Remove(this[index]); /// - /// Removes the specified from the collection. + /// Removes the specified from the collection. /// protected virtual void RemoveCore(Binding dataBinding) => List.Remove(dataBinding); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BootMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BootMode.cs index f9ad50c4026..0137220889b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BootMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BootMode.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies the mode to start the computer in. + /// Specifies the mode to start the computer in. /// public enum BootMode { /// - /// Starts the computer in standard mode. + /// Starts the computer in standard mode. /// Normal = 0, /// - /// Starts the computer by using only the basic files and drivers. + /// Starts the computer by using only the basic files and drivers. /// FailSafe = 1, /// - /// Starts the computer by using the basic files, drivers and the services - /// and drivers necessary to start networking. + /// Starts the computer by using the basic files, drivers and the services + /// and drivers necessary to start networking. /// FailSafeWithNetwork = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Border3DSide.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Border3DSide.cs index f815afb12ff..de572d2cb13 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Border3DSide.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Border3DSide.cs @@ -7,41 +7,41 @@ namespace System.Windows.Forms { /// - /// Specifies the sides of a rectangle to apply a three-dimensional border to. + /// Specifies the sides of a rectangle to apply a three-dimensional border to. /// [ComVisible(true)] [Flags] public enum Border3DSide { /// - /// A three-dimensional border on the left edge of the control. + /// A three-dimensional border on the left edge of the control. /// Left = NativeMethods.BF_LEFT, /// - /// A three-dimensional border on the top edge of the rectangle. + /// A three-dimensional border on the top edge of the rectangle. /// Top = NativeMethods.BF_TOP, /// - /// A three-dimensional border on the right side of the rectangle. + /// A three-dimensional border on the right side of the rectangle. /// Right = NativeMethods.BF_RIGHT, /// - /// A three-dimensional border on the bottom side of the rectangle. + /// A three-dimensional border on the bottom side of the rectangle. /// Bottom = NativeMethods.BF_BOTTOM, /// - /// The interior of the rectangle is filled with the color defined for - /// three-dimensional controls instead of the background color for the form. + /// The interior of the rectangle is filled with the color defined for + /// three-dimensional controls instead of the background color for the form. /// Middle = NativeMethods.BF_MIDDLE, /// - /// A three-dimensional border on all four edges and fill the middle of - /// the rectangle with the color defeined for three-dimensional controls. + /// A three-dimensional border on all four edges and fill the middle of + /// the rectangle with the color defeined for three-dimensional controls. /// All = Left | Top | Right | Bottom | Middle, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Border3DStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Border3DStyle.cs index cad37b64dc7..7f2137cc330 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Border3DStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Border3DStyle.cs @@ -7,59 +7,59 @@ namespace System.Windows.Forms { /// - /// Specifies the style of a three-dimensional border. + /// Specifies the style of a three-dimensional border. /// [ComVisible(true)] public enum Border3DStyle { /// - /// The border is drawn outside the specified rectangle, preserving the - /// dimensions of the rectangle for drawing. + /// The border is drawn outside the specified rectangle, preserving the + /// dimensions of the rectangle for drawing. /// Adjust = NativeMethods.BF_ADJUST, /// - /// The border has a raised outer edge and a sunken inner edge. + /// The border has a raised outer edge and a sunken inner edge. /// Bump = NativeMethods.EDGE_BUMP, /// - /// The border has a with a sunken inner edge and a raised outer edge. + /// The border has a with a sunken inner edge and a raised outer edge. /// Etched = NativeMethods.EDGE_ETCHED, /// - /// The border has a with no three-dimensional effects. + /// The border has a with no three-dimensional effects. /// Flat = NativeMethods.BF_FLAT | NativeMethods.EDGE_SUNKEN, /// - /// The border has a with raised inner and outer edges. + /// The border has a with raised inner and outer edges. /// Raised = NativeMethods.EDGE_RAISED, /// - /// The border has a with a raised inner edge and no outer edge. + /// The border has a with a raised inner edge and no outer edge. /// RaisedInner = NativeMethods.BDR_RAISEDINNER, /// - /// The border has a with a raised outer edge and no inner edge. + /// The border has a with a raised outer edge and no inner edge. /// RaisedOuter = NativeMethods.BDR_RAISEDOUTER, /// - /// The border has a with sunken inner and outer edges. + /// The border has a with sunken inner and outer edges. /// Sunken = NativeMethods.EDGE_SUNKEN, /// - /// The border has a with a sunken inner edge and no outer edge. + /// The border has a with a sunken inner edge and no outer edge. /// SunkenInner = NativeMethods.BDR_SUNKENINNER, /// - /// The border has a with a sunken outer edge and no inner edge. + /// The border has a with a sunken outer edge and no inner edge. /// SunkenOuter = NativeMethods.BDR_SUNKENOUTER, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BorderStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BorderStyle.cs index fe997d58345..a327bbde54b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BorderStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BorderStyle.cs @@ -7,23 +7,23 @@ namespace System.Windows.Forms { /// - /// Specifies the border style for a control or form. + /// Specifies the border style for a control or form. /// [ComVisible(true)] public enum BorderStyle { /// - /// No border. + /// No border. /// None = 0, /// - /// A single-line border. + /// A single-line border. /// FixedSingle = 1, /// - /// A three-dimensional border. + /// A three-dimensional border. /// Fixed3D = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/BoundsSpecified.cs b/src/System.Windows.Forms/src/System/Windows/Forms/BoundsSpecified.cs index 265c7293aeb..c2d343fd3a8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/BoundsSpecified.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/BoundsSpecified.cs @@ -5,52 +5,52 @@ namespace System.Windows.Forms { /// - /// Specifies the bounds of the control to use when defining a control's size - /// and position. + /// Specifies the bounds of the control to use when defining a control's size + /// and position. /// [Flags] public enum BoundsSpecified { /// - /// Specifies the left edge of the control is defined. + /// Specifies the left edge of the control is defined. /// X = 0x1, /// - /// Specifies the top edge of the control of the control is defined. + /// Specifies the top edge of the control of the control is defined. /// Y = 0x2, /// - /// Specifies the width of the control is defined. + /// Specifies the width of the control is defined. /// Width = 0x4, /// - /// Specifies the height of the control is defined. + /// Specifies the height of the control is defined. /// Height = 0x8, /// - /// Both and coordinates of the - /// control are defined. + /// Both and coordinates of the + /// control are defined. /// Location = X | Y, /// - /// Both and - /// property values of the control are defined. + /// Both and + /// property values of the control are defined. /// Size = Width | Height, /// - /// Both and - /// property values are defined. + /// Both and + /// property values are defined. /// All = Location | Size, /// - /// No bounds are specified. + /// No bounds are specified. /// None = 0, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Button.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Button.cs index b50b7e6ca4c..1fc2c9605bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Button.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Button.cs @@ -298,10 +298,10 @@ protected override void OnTextChanged(EventArgs e) } /// - /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. - /// Must call the base class method to get the current DPI values. This method is invoked only when - /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has - /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. + /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. + /// Must call the base class method to get the current DPI values. This method is invoked only when + /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has + /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. /// /// Old DPI value /// New DPI value diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonBorderStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonBorderStyle.cs index 55d5a96d602..3e4b8b8a69c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonBorderStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonBorderStyle.cs @@ -5,37 +5,37 @@ namespace System.Windows.Forms { /// - /// Specifies the border style for a button control. + /// Specifies the border style for a button control. /// public enum ButtonBorderStyle { /// - /// No border. + /// No border. /// None, /// - /// A dotted-line border. + /// A dotted-line border. /// Dotted, /// - /// A dashed border. + /// A dashed border. /// Dashed, /// - /// A solid border. + /// A solid border. /// Solid, /// - /// A sunken border. + /// A sunken border. /// Inset, /// - /// A raised border. + /// A raised border. /// Outset, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonInternal/ButtonBaseAdapter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonInternal/ButtonBaseAdapter.cs index d8c95543458..c4a596bee5f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonInternal/ButtonBaseAdapter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonInternal/ButtonBaseAdapter.cs @@ -15,9 +15,9 @@ namespace System.Windows.Forms.ButtonInternal /// /// PLEASE READ /// ----------- - /// This class is used for more than just Button: - /// it's used for things that derive from ButtonBase, - /// parts of ToolStripItem, and parts of the DataGridView. + /// This class is used for more than just Button: + /// it's used for things that derive from ButtonBase, + /// parts of ToolStripItem, and parts of the DataGridView. /// internal abstract class ButtonBaseAdapter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonRenderer.cs index b004ecba1ae..43493e04c70 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonRenderer.cs @@ -26,7 +26,7 @@ private ButtonRenderer() /// /// If this property is true, then the renderer will use the setting from Application.RenderWithVisualStyles to - /// determine how to render. + /// determine how to render. /// If this property is false, the renderer will always render with visualstyles. /// public static bool RenderMatchingApplicationState @@ -97,7 +97,7 @@ public static void DrawButton(Graphics g, Rectangle bounds, PushButtonState stat } /// - /// Method to draw visualstyle themes in case of per-monitor scenarios where Hwnd is necessary + /// Method to draw visualstyle themes in case of per-monitor scenarios where Hwnd is necessary /// /// graphics object /// button bounds diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonState.cs index 868d3f1af21..f20ca845ba4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ButtonState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ButtonState.cs @@ -5,39 +5,39 @@ namespace System.Windows.Forms { /// - /// Specifies the appearance of a button. + /// Specifies the appearance of a button. /// [Flags] public enum ButtonState { /// - /// The button has a checked or latched appearance. Use this appearance to - /// show that a toggle button has been pressed. + /// The button has a checked or latched appearance. Use this appearance to + /// show that a toggle button has been pressed. /// Checked = NativeMethods.DFCS_CHECKED, /// - /// The button has a flat, two-dimensional appearance. + /// The button has a flat, two-dimensional appearance. /// Flat = NativeMethods.DFCS_FLAT, /// - /// The button is inactive (grayed). + /// The button is inactive (grayed). /// Inactive = NativeMethods.DFCS_INACTIVE, /// - /// The button has its normal appearance (three-dimensional and not pressed). + /// The button has its normal appearance (three-dimensional and not pressed). /// Normal = 0, /// - /// The button is currently pressed. + /// The button is currently pressed. /// Pushed = NativeMethods.DFCS_PUSHED, /// - /// All viable flags in the bit mask are used. + /// All viable flags in the bit mask are used. /// All = Flat | Checked | Pushed | Inactive, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CacheVirtualItemsEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CacheVirtualItemsEventHandler.cs index a4f35752cdd..0b0804124dd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CacheVirtualItemsEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CacheVirtualItemsEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the CacheVirtualItems event of a ListView. + /// Represents the method that will handle the CacheVirtualItems event of a ListView. /// public delegate void CacheVirtualItemsEventHandler(object sender, CacheVirtualItemsEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CaptionButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CaptionButton.cs index 38dcc18ebf3..375b14a27a1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CaptionButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CaptionButton.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms { /// - /// Specifies the type of caption button to display. + /// Specifies the type of caption button to display. /// public enum CaptionButton { /// - /// A Close button. + /// A Close button. /// Close = NativeMethods.DFCS_CAPTIONCLOSE, /// - /// A Help button. + /// A Help button. /// Help = NativeMethods.DFCS_CAPTIONHELP, /// - /// A Maximize button. + /// A Maximize button. /// Maximize = NativeMethods.DFCS_CAPTIONMAX, /// - /// A Minimize button. + /// A Minimize button. /// Minimize = NativeMethods.DFCS_CAPTIONMIN, /// - /// A Restore button. + /// A Restore button. /// Restore = NativeMethods.DFCS_CAPTIONRESTORE, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CharacterCasing.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CharacterCasing.cs index c1c453bca0c..6de66e084a8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CharacterCasing.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CharacterCasing.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Specifies the case of characters in a Textbox control. + /// Specifies the case of characters in a Textbox control. /// public enum CharacterCasing { /// - /// The case of characters is left unchanged. + /// The case of characters is left unchanged. /// Normal = 0, /// - /// Converts all characters to uppercase. + /// Converts all characters to uppercase. /// Upper = 1, /// - /// Converts all characters to lowercase. + /// Converts all characters to lowercase. /// Lower = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CheckBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CheckBox.cs index 294e7269955..6c188fde1bd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CheckBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CheckBox.cs @@ -133,9 +133,9 @@ public event EventHandler AppearanceChanged } /// - /// Gets or sets a value indicating whether the or - /// value and the check box's appearance are automatically - /// changed when it is clicked. + /// Gets or sets a value indicating whether the or + /// value and the check box's appearance are automatically + /// changed when it is clicked. /// [ DefaultValue(true), @@ -339,11 +339,11 @@ protected override Size DefaultSize } /// - /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. - /// For CheckBox controls, scale the width of the system-style padding, and height of the box. - /// Must call the base class method to get the current DPI values. This method is invoked only when - /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has - /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. + /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. + /// For CheckBox controls, scale the width of the system-style padding, and height of the box. + /// Must call the base class method to get the current DPI values. This method is invoked only when + /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has + /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. /// /// Old DPI value /// New DPI value @@ -499,8 +499,8 @@ protected virtual void OnAppearanceChanged(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnCheckedChanged(EventArgs e) { @@ -520,7 +520,7 @@ protected virtual void OnCheckedChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnCheckStateChanged(EventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CheckBoxRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CheckBoxRenderer.cs index bbc3bd1586a..75975a393a8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CheckBoxRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CheckBoxRenderer.cs @@ -26,7 +26,7 @@ private CheckBoxRenderer() /// /// If this property is true, then the renderer will use the setting from Application.RenderWithVisualStyles to - /// determine how to render. + /// determine how to render. /// If this property is false, the renderer will always render with visualstyles. /// public static bool RenderMatchingApplicationState diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CheckState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CheckState.cs index d61a4ce9897..27e7f00468e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CheckState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CheckState.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms { /// - /// Specifies the state of a control, such as a check box, that can be - /// checked, unchecked, or set to an indeterminate state. + /// Specifies the state of a control, such as a check box, that can be + /// checked, unchecked, or set to an indeterminate state. /// public enum CheckState { /// - /// The control is unchecked. + /// The control is unchecked. /// Unchecked = 0, /// - /// The control is checked. + /// The control is checked. /// Checked = 1, /// - /// The control is indeterminate. An indeterminate control generally has - /// a shaded appearance. + /// The control is indeterminate. An indeterminate control generally has + /// a shaded appearance. /// Indeterminate = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CheckedListBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CheckedListBox.cs index 23e06e34b5d..1ae1eba8643 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CheckedListBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CheckedListBox.cs @@ -926,7 +926,7 @@ protected override void OnSelectedIndexChanged(EventArgs e) } /// - /// Reparses the objects, getting new text strings for them. + /// Reparses the objects, getting new text strings for them. /// protected override void RefreshItems() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Clipboard.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Clipboard.cs index 9945e2d1fcd..301f9ff44c3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Clipboard.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Clipboard.cs @@ -87,7 +87,7 @@ internal static bool IsFormatValid(FORMATETC[] formats) } /// - /// Places nonpersistent data on the system . + /// Places nonpersistent data on the system . /// public static void SetDataObject(object data) { @@ -95,7 +95,7 @@ public static void SetDataObject(object data) } /// - /// Overload that uses default values for retryTimes and retryDelay. + /// Overload that uses default values for retryTimes and retryDelay. /// public static void SetDataObject(object data, bool copy) { @@ -103,7 +103,7 @@ public static void SetDataObject(object data, bool copy) } /// - /// Places data on the system and uses copy to specify whether the data + /// Places data on the system and uses copy to specify whether the data /// should remain on the /// after the application exits. /// diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CloseReason.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CloseReason.cs index 5999eaa1b00..2d265125533 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CloseReason.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CloseReason.cs @@ -5,43 +5,43 @@ namespace System.Windows.Forms { /// - /// Specifies the reason for the Form Closing. + /// Specifies the reason for the Form Closing. /// public enum CloseReason { /// - /// No reason for closure of the Form. + /// No reason for closure of the Form. /// None = 0, /// - /// In the process of shutting down, Windows has closed the application. + /// In the process of shutting down, Windows has closed the application. /// WindowsShutDown = 1, /// - /// The parent form of this MDI form is closing. + /// The parent form of this MDI form is closing. /// MdiFormClosing = 2, /// - /// The user has clicked the close button on the form window, selected - /// Close from the window's control menu or hit Alt + F4. + /// The user has clicked the close button on the form window, selected + /// Close from the window's control menu or hit Alt + F4. /// UserClosing = 3, /// - /// The Microsoft Windows Task Manager is closing the application. + /// The Microsoft Windows Task Manager is closing the application. /// TaskManagerClosing = 4, /// - /// A form is closing because its owner is closing. + /// A form is closing because its owner is closing. /// FormOwnerClosing = 5, /// - /// A form is closing because Application.Exit() was called. + /// A form is closing because Application.Exit() was called. /// ApplicationExitCall = 6 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventArgs.cs index 19d5220e8a1..af76f1c2d6a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class ColumnClickEventArgs : EventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventHandler.cs index d12d90270c2..31cc29aca4d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnClickEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the the - /// event of a + /// Represents the method that will handle the the + /// event of a /// public delegate void ColumnClickEventHandler(object sender, ColumnClickEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderAutoResizeStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderAutoResizeStyle.cs index 485cad9af22..8a585658976 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderAutoResizeStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderAutoResizeStyle.cs @@ -5,25 +5,25 @@ namespace System.Windows.Forms { /// - /// Specifies how the column headers are autoresized in a - /// control. + /// Specifies how the column headers are autoresized in a + /// control. /// public enum ColumnHeaderAutoResizeStyle { /// - /// Do not auto resize the column headers. + /// Do not auto resize the column headers. /// None, /// - /// Autoresize the column headers based on the width of just the column - /// header. + /// Autoresize the column headers based on the width of just the column + /// header. /// HeaderSize, /// - /// Autoresize the column headers based on the width of the largest - /// subitem in the column. + /// Autoresize the column headers based on the width of the largest + /// subitem in the column. /// ColumnContent, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderStyle.cs index 43596d43879..23a265ac399 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnHeaderStyle.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies how column headers - /// behave. + /// Specifies how column headers + /// behave. /// public enum ColumnHeaderStyle { /// - /// No visible column header. + /// No visible column header. /// None = 0, /// - /// Visible column header that does not respond to clicking. + /// Visible column header that does not respond to clicking. /// Nonclickable = 1, /// - /// Visible column header that responds to clicking. + /// Visible column header that responds to clicking. /// Clickable = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnWidthChangingEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnWidthChangingEventArgs.cs index faec2af6c22..c376433c7d1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ColumnWidthChangingEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ColumnWidthChangingEventArgs.cs @@ -19,12 +19,12 @@ public ColumnWidthChangingEventArgs(int columnIndex, int newWidth, bool cancel) } /// - /// Returns the index of the column header whose width is changing + /// Returns the index of the column header whose width is changing /// public int ColumnIndex { get; } /// - /// Returns the new width for the column header who is changing + /// Returns the new width for the column header who is changing /// public int NewWidth { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBox.cs index 89e3e5ca9df..dc0407651b3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBox.cs @@ -2050,7 +2050,7 @@ private void ChildWndProc(ref Message m) } /// - /// Helper to handle MouseEnter. + /// Helper to handle MouseEnter. /// /// private void OnMouseEnterInternal(EventArgs args) @@ -2063,7 +2063,7 @@ private void OnMouseEnterInternal(EventArgs args) } /// - /// Helper to handle mouseleave + /// Helper to handle mouseleave /// /// private void OnMouseLeaveInternal(EventArgs args) @@ -2151,14 +2151,14 @@ public void EndUpdate() } /// - /// Finds the first item in the combo box that starts with the given string. - /// The search is not case sensitive. + /// Finds the first item in the combo box that starts with the given string. + /// The search is not case sensitive. /// public int FindString(string s) => FindString(s, startIndex: -1); /// - /// Finds the first item after the given index which starts with the given string. - /// The search is not case sensitive. + /// Finds the first item after the given index which starts with the given string. + /// The search is not case sensitive. /// public int FindString(string s, int startIndex) { @@ -2166,8 +2166,8 @@ public int FindString(string s, int startIndex) } /// - /// Finds the first item in the combo box that matches the given string. - /// The strings must match exactly, except for differences in casing. + /// Finds the first item in the combo box that matches the given string. + /// The strings must match exactly, except for differences in casing. /// public int FindStringExact(string s) { @@ -2175,8 +2175,8 @@ public int FindStringExact(string s) } /// - /// Finds the first item after the given index that matches the given string. - /// The strings must match exactly, except for differences in casing. + /// Finds the first item after the given index that matches the given string. + /// The strings must match exactly, except for differences in casing. /// public int FindStringExact(string s, int startIndex) { @@ -2184,8 +2184,8 @@ public int FindStringExact(string s, int startIndex) } /// - /// Finds the first item after the given index that matches the given string. - /// The strings must match exactly, except for differences in casing. + /// Finds the first item after the given index that matches the given string. + /// The strings must match exactly, except for differences in casing. /// internal int FindStringExact(string s, int startIndex, bool ignoreCase) { @@ -2670,7 +2670,7 @@ protected virtual void OnDropDown(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnKeyDown(KeyEventArgs e) @@ -2751,7 +2751,7 @@ protected override void OnMouseLeave(EventArgs e) } /// - /// This internal helper allows us to call the committed function multiple times without worrying about double firing. + /// This internal helper allows us to call the committed function multiple times without worrying about double firing. /// private void OnSelectionChangeCommittedInternal(EventArgs e) { @@ -2988,8 +2988,8 @@ protected override void OnTextChanged(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnValidating(CancelEventArgs e) @@ -3026,7 +3026,7 @@ private void UpdateControl(bool recreate) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnResize(EventArgs e) { @@ -3155,7 +3155,7 @@ private void ResetHeightCache() prefHeightCache = -1; } /// - /// Reparses the objects, getting new text strings for them. + /// Reparses the objects, getting new text strings for them. /// protected override void RefreshItems() { @@ -3216,7 +3216,7 @@ protected override void RefreshItems() } /// - /// Reparses the object at the given index, getting new text string for it. + /// Reparses the object at the given index, getting new text string for it. /// protected override void RefreshItem(int index) { @@ -3671,10 +3671,10 @@ private void WmParentNotify(ref Message m) } /// - /// Text change behavior. - /// Here are the window messages corresponding to each user event. + /// Text change behavior. + /// Here are the window messages corresponding to each user event. /// - /// DropDown (free text window): + /// DropDown (free text window): /// Type in Text Window: /// CBN_EDITUPDATE /// CBN_EDITCHANGE @@ -3694,7 +3694,7 @@ private void WmParentNotify(ref Message m) /// CBN_CLOSEUP /// CBN_SELCHANGE (text changes here via selected item) /// - /// DropDownList (limited text window): + /// DropDownList (limited text window): /// /// Type text and arrow up/down: /// CBN_SELENDOK (text already changed) @@ -3709,7 +3709,7 @@ private void WmParentNotify(ref Message m) /// CBN_CLOSEUP /// CBN_SELCHANGE /// - /// Simple (listbox visible): + /// Simple (listbox visible): /// Type in Text Window: /// CBN_EDITUPDATE /// CBN_EDITCHANGE @@ -3721,15 +3721,15 @@ private void WmParentNotify(ref Message m) /// CBN_SELCHANGE /// /// - /// What we do is fire textchange events in these messages: + /// What we do is fire textchange events in these messages: /// CBN_SELCHANGE /// CBN_EDITCHANGE /// CBN_CLOSEUP /// - /// and we only actually call the real event if the Text is different than currentText. - /// currentText is never changed outside this method. - /// This internal version can be called from anywhere we might suspect text has changed - /// it's fairly safe to call anywhere. + /// and we only actually call the real event if the Text is different than currentText. + /// currentText is never changed outside this method. + /// This internal version can be called from anywhere we might suspect text has changed + /// it's fairly safe to call anywhere. private void WmReflectCommand(ref Message m) { @@ -4675,7 +4675,7 @@ public override string Name } /// - /// Represents the ComboBox item accessible object. + /// Represents the ComboBox item accessible object. /// [ComVisible(true)] internal class ComboBoxItemAccessibleObject : AccessibleObject @@ -4685,7 +4685,7 @@ internal class ComboBoxItemAccessibleObject : AccessibleObject private IAccessible _systemIAccessible; /// - /// Initializes new instance of ComboBox item accessible object. + /// Initializes new instance of ComboBox item accessible object. /// /// The owning ComboBox. /// The owning ComboBox item. @@ -4698,7 +4698,7 @@ public ComboBoxItemAccessibleObject(ComboBox owningComboBox, object owningItem) } /// - /// Gets the ComboBox Item bounds. + /// Gets the ComboBox Item bounds. /// public override Rectangle Bounds { @@ -4718,7 +4718,7 @@ public override Rectangle Bounds } /// - /// Gets the ComboBox item default action. + /// Gets the ComboBox item default action. /// public override string DefaultAction { @@ -4826,7 +4826,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Gets the help text. + /// Gets the help text. /// public override string Help { @@ -4837,7 +4837,7 @@ public override string Help } /// - /// Indicates whether specified pattern is supported. + /// Indicates whether specified pattern is supported. /// /// The pattern ID. /// True if specified @@ -4854,7 +4854,7 @@ internal override bool IsPatternSupported(int patternId) } /// - /// Gets or sets the accessible name. + /// Gets or sets the accessible name. /// public override string Name { @@ -4875,7 +4875,7 @@ public override string Name } /// - /// Gets the accessible role. + /// Gets the accessible role. /// public override AccessibleRole Role { @@ -4886,7 +4886,7 @@ public override AccessibleRole Role } /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -4905,7 +4905,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -4994,9 +4994,9 @@ public int GetId(object item) } /// - /// ComboBox control accessible object with UI Automation provider functionality. - /// This inherits from the base ComboBoxExAccessibleObject and ComboBoxAccessibleObject - /// to have all base functionality. + /// ComboBox control accessible object with UI Automation provider functionality. + /// This inherits from the base ComboBoxExAccessibleObject and ComboBoxAccessibleObject + /// to have all base functionality. /// [ComVisible(true)] internal class ComboBoxAccessibleObject : ControlAccessibleObject @@ -5008,7 +5008,7 @@ internal class ComboBoxAccessibleObject : ControlAccessibleObject private readonly ComboBox _owningComboBox; /// - /// Initializes new instance of ComboBoxAccessibleObject. + /// Initializes new instance of ComboBoxAccessibleObject. /// /// The owning ComboBox control. public ComboBoxAccessibleObject(ComboBox owningComboBox) : base(owningComboBox) @@ -5123,7 +5123,7 @@ internal override string get_accKeyboardShortcutInternal(object childID) } /// - /// Gets the collection of item accessible objects. + /// Gets the collection of item accessible objects. /// public ComboBoxItemAccessibleObjectCollection ItemAccessibleObjects { @@ -5134,7 +5134,7 @@ public ComboBoxItemAccessibleObjectCollection ItemAccessibleObjects } /// - /// Gets the DropDown button accessible object. (UI Automation provider) + /// Gets the DropDown button accessible object. (UI Automation provider) /// public ComboBoxChildDropDownButtonUiaProvider DropDownButtonUiaProvider { @@ -5150,7 +5150,7 @@ public ComboBoxChildDropDownButtonUiaProvider DropDownButtonUiaProvider } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5197,12 +5197,12 @@ internal override UnsafeNativeMethods.IRawElementProviderSimple GetOverrideProvi } /// - /// Gets the accessible child corresponding to the specified index. + /// Gets the accessible child corresponding to the specified index. /// /// The child index. /// The accessible child. /// - /// GetChild method should be unchanged to not break the MSAA scenarios. + /// GetChild method should be unchanged to not break the MSAA scenarios. /// internal AccessibleObject GetChildFragment(int index) { @@ -5225,11 +5225,11 @@ internal AccessibleObject GetChildFragment(int index) } /// - /// Gets the number of children belonging to an accessible object. + /// Gets the number of children belonging to an accessible object. /// /// The number of children. /// - /// GetChildCount method should be unchanged to not break the MSAA scenarios. + /// GetChildCount method should be unchanged to not break the MSAA scenarios. /// internal int GetChildFragmentCount() { @@ -5249,7 +5249,7 @@ internal int GetChildFragmentCount() } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -5317,7 +5317,7 @@ internal override void SetFocus() } /// - /// Represents the ComboBox's child (inner) edit native window control accessible object with UI Automation provider functionality. + /// Represents the ComboBox's child (inner) edit native window control accessible object with UI Automation provider functionality. /// internal class ComboBoxChildEditUiaProvider : ChildAccessibleObject { @@ -5327,7 +5327,7 @@ internal class ComboBoxChildEditUiaProvider : ChildAccessibleObject private readonly IntPtr _handle; /// - /// Initializes new instance of ComboBoxChildEditUiaProvider. + /// Initializes new instance of ComboBoxChildEditUiaProvider. /// /// The ComboBox owning control. /// The child edit native window handle. @@ -5338,7 +5338,7 @@ public ComboBoxChildEditUiaProvider(ComboBox owner, IntPtr childEditControlhandl } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5383,7 +5383,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -5394,7 +5394,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -5446,7 +5446,7 @@ internal override UnsafeNativeMethods.IRawElementProviderSimple HostRawElementPr internal override bool IsIAccessibleExSupported() => true; /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -5462,7 +5462,7 @@ internal override int[] RuntimeId } /// - /// Represents the ComboBox's child (inner) list native window control accessible object with UI Automation provider functionality. + /// Represents the ComboBox's child (inner) list native window control accessible object with UI Automation provider functionality. /// [ComVisible(true)] internal class ComboBoxChildListUiaProvider : ChildAccessibleObject @@ -5473,7 +5473,7 @@ internal class ComboBoxChildListUiaProvider : ChildAccessibleObject private readonly IntPtr _childListControlhandle; /// - /// Initializes new instance of ComboBoxChildListUiaProvider. + /// Initializes new instance of ComboBoxChildListUiaProvider. /// /// /// @@ -5484,7 +5484,7 @@ public ComboBoxChildListUiaProvider(ComboBox owningComboBox, IntPtr childListCon } /// - /// Return the child object at the given screen coordinates. + /// Return the child object at the given screen coordinates. /// /// X coordinate. /// Y coordinate. @@ -5509,7 +5509,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProvide } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5533,7 +5533,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -5561,7 +5561,7 @@ public int GetChildFragmentCount() } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -5650,7 +5650,7 @@ internal override bool IsSelectionRequired } /// - /// Indicates whether specified pattern is supported. + /// Indicates whether specified pattern is supported. /// /// The pattern ID. /// True if specified @@ -5675,7 +5675,7 @@ internal override UnsafeNativeMethods.IRawElementProviderSimple HostRawElementPr } /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -5691,7 +5691,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -5709,7 +5709,7 @@ public override AccessibleStates State } /// - /// Represents the ComboBox's child text (is used instead of inner Edit when style is DropDownList but not DropDown) accessible object. + /// Represents the ComboBox's child text (is used instead of inner Edit when style is DropDownList but not DropDown) accessible object. /// [ComVisible(true)] internal class ComboBoxChildTextUiaProvider : AccessibleObject @@ -5719,7 +5719,7 @@ internal class ComboBoxChildTextUiaProvider : AccessibleObject private readonly ComboBox _owner; /// - /// Initializes new instance of ComboBoxChildTextUiaProvider. + /// Initializes new instance of ComboBoxChildTextUiaProvider. /// /// The owning ComboBox control. public ComboBoxChildTextUiaProvider(ComboBox owner) @@ -5728,7 +5728,7 @@ public ComboBoxChildTextUiaProvider(ComboBox owner) } /// - /// Gets the bounds. + /// Gets the bounds. /// public override Rectangle Bounds { @@ -5739,7 +5739,7 @@ public override Rectangle Bounds } /// - /// Gets the child ID. + /// Gets the child ID. /// /// The child ID. internal override int GetChildId() @@ -5748,7 +5748,7 @@ internal override int GetChildId() } /// - /// Gets or sets the accessible Name of ComboBox's child text element. + /// Gets or sets the accessible Name of ComboBox's child text element. /// public override string Name { @@ -5763,7 +5763,7 @@ public override string Name } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5802,7 +5802,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -5813,7 +5813,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -5848,7 +5848,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -5866,7 +5866,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -5884,7 +5884,7 @@ public override AccessibleStates State } /// - /// Represents the ComboBox child (inner) DropDown button accessible object with UI Automation functionality. + /// Represents the ComboBox child (inner) DropDown button accessible object with UI Automation functionality. /// [ComVisible(true)] internal class ComboBoxChildDropDownButtonUiaProvider : AccessibleObject @@ -5893,7 +5893,7 @@ internal class ComboBoxChildDropDownButtonUiaProvider : AccessibleObject private readonly ComboBox _owner; /// - /// Initializes new instance of ComboBoxChildDropDownButtonUiaProvider. + /// Initializes new instance of ComboBoxChildDropDownButtonUiaProvider. /// /// The owning ComboBox control. /// The owning ComboBox control's handle. @@ -5904,7 +5904,7 @@ public ComboBoxChildDropDownButtonUiaProvider(ComboBox owner, IntPtr comboBoxCon } /// - /// Gets or sets the accessible Name of ComboBox's child DropDown button. ("Open" or "Close" depending on stat of the DropDown) + /// Gets or sets the accessible Name of ComboBox's child DropDown button. ("Open" or "Close" depending on stat of the DropDown) /// public override string Name { @@ -5920,7 +5920,7 @@ public override string Name } /// - /// Gets the DropDown button bounds. + /// Gets the DropDown button bounds. /// public override Rectangle Bounds { @@ -5933,7 +5933,7 @@ public override Rectangle Bounds } /// - /// Gets the DropDown button default action. + /// Gets the DropDown button default action. /// public override string DefaultAction { @@ -5945,7 +5945,7 @@ public override string DefaultAction } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5973,7 +5973,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -5984,7 +5984,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Gets the child accessible object ID. + /// Gets the child accessible object ID. /// /// The child accessible object ID. internal override int GetChildId() @@ -5993,7 +5993,7 @@ internal override int GetChildId() } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -6029,7 +6029,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Gets the help text. + /// Gets the help text. /// public override string Help { @@ -6041,7 +6041,7 @@ public override string Help } /// - /// Gets the keyboard shortcut. + /// Gets the keyboard shortcut. /// public override string KeyboardShortcut { @@ -6053,7 +6053,7 @@ public override string KeyboardShortcut } /// - /// Indicates whether specified pattern is supported. + /// Indicates whether specified pattern is supported. /// /// The pattern ID. /// True if specified @@ -6069,7 +6069,7 @@ internal override bool IsPatternSupported(int patternId) } /// - /// Gets the accessible role. + /// Gets the accessible role. /// public override AccessibleRole Role { @@ -6081,7 +6081,7 @@ public override AccessibleRole Role } /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -6102,7 +6102,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -6212,8 +6212,8 @@ internal static void RegisterACWindow(IntPtr acHandle, bool subclass) } /// - /// This method clears out null entries so we get a clean BEFORE and AFTER snapshot - /// null entries are ACWindows that belong to someone else. + /// This method clears out null entries so we get a clean BEFORE and AFTER snapshot + /// null entries are ACWindows that belong to someone else. /// internal static void ClearNullACWindows() { @@ -6541,7 +6541,7 @@ public void ValidateOwnerDrawRegions(ComboBox comboBox, Rectangle updateRegionBo } /// - /// Represents the ComboBox child native window type. + /// Represents the ComboBox child native window type. /// private enum ChildWindowType { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxRenderer.cs index b187d5f4c54..7f29cafb5ef 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxRenderer.cs @@ -133,7 +133,7 @@ public static void DrawDropDownButton(Graphics g, Rectangle bounds, ComboBoxStat } /// - /// Renders a ComboBox drop-down button in per-monitor scenario. + /// Renders a ComboBox drop-down button in per-monitor scenario. /// /// graphics object /// dropdown button bounds diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxStyle.cs index 29776e23efd..4bf311f72fa 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComboBoxStyle.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms { /// - /// Specifies the style. + /// Specifies the style. /// public enum ComboBoxStyle { /// - /// The text portion is editable. The list portion is always visible. + /// The text portion is editable. The list portion is always visible. /// Simple = 0, /// - /// The text portion is editable. The user must click the arrow button to - /// display the list portion. + /// The text portion is editable. The user must click the arrow button to + /// display the list portion. /// DropDown = 1, /// - /// The user cannot directly edit the text portion. The user must click - /// the arrow button to display the list portion. + /// The user cannot directly edit the text portion. The user must click + /// the arrow button to display the list portion. /// DropDownList = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CommonDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CommonDialog.cs index 9aa16551be2..ba670318b29 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CommonDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CommonDialog.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms { /// - /// Specifies the base class used for displaying dialog boxes on the screen. + /// Specifies the base class used for displaying dialog boxes on the screen. /// [ToolboxItemFilter("System.Windows.Forms")] public abstract class CommonDialog : Component @@ -26,7 +26,7 @@ public abstract class CommonDialog : Component private IntPtr _defaultControlHwnd; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public CommonDialog() { @@ -41,8 +41,8 @@ public CommonDialog() public object Tag { get; set; } /// - /// Occurs when the user clicks the Help button on a common - /// dialog box. + /// Occurs when the user clicks the Help button on a common + /// dialog box. /// [SRDescription(nameof(SR.CommonDialogHelpRequested))] public event EventHandler HelpRequest @@ -52,8 +52,8 @@ public event EventHandler HelpRequest } /// - /// Defines the common dialog box hook procedure that is overridden to add specific - /// functionality to a common dialog box. + /// Defines the common dialog box hook procedure that is overridden to add specific + /// functionality to a common dialog box. /// protected virtual IntPtr HookProc(IntPtr hWnd, int msg, IntPtr wparam, IntPtr lparam) { @@ -82,9 +82,9 @@ protected virtual IntPtr HookProc(IntPtr hWnd, int msg, IntPtr wparam, IntPtr lp } /// - /// Centers the given window on the screen. This method is used by the default - /// common dialog hook procedure to center the dialog on the screen before it - /// is shown. + /// Centers the given window on the screen. This method is used by the default + /// common dialog hook procedure to center the dialog on the screen before it + /// is shown. /// private protected static void MoveToScreenCenter(IntPtr hWnd) { @@ -98,7 +98,7 @@ private protected static void MoveToScreenCenter(IntPtr hWnd) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnHelpRequest(EventArgs e) { @@ -107,8 +107,8 @@ protected virtual void OnHelpRequest(EventArgs e) } /// - /// Defines the owner window procedure that is overridden to add specific - /// functionality to a common dialog box. + /// Defines the owner window procedure that is overridden to add specific + /// functionality to a common dialog box. /// protected virtual IntPtr OwnerWndProc(IntPtr hWnd, int msg, IntPtr wparam, IntPtr lparam) { @@ -138,23 +138,23 @@ protected virtual IntPtr OwnerWndProc(IntPtr hWnd, int msg, IntPtr wparam, IntPt } /// - /// When overridden in a derived class, resets the properties of a common dialog - /// to their default values. + /// When overridden in a derived class, resets the properties of a common dialog + /// to their default values. /// public abstract void Reset(); /// - /// When overridden in a derived class, specifies a common dialog box. + /// When overridden in a derived class, specifies a common dialog box. /// protected abstract bool RunDialog(IntPtr hwndOwner); /// - /// Runs a common dialog box. + /// Runs a common dialog box. /// public DialogResult ShowDialog() => ShowDialog(owner: null); /// - /// Runs a common dialog box, parented to the given IWin32Window. + /// Runs a common dialog box, parented to the given IWin32Window. /// public DialogResult ShowDialog(IWin32Window owner) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ColorConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ColorConverter.cs index 58836e7cb3b..68c14d59d00 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ColorConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ColorConverter.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class maps an OLE_COLOR to a managed Color editor. + /// This class maps an OLE_COLOR to a managed Color editor. /// internal class Com2ColorConverter : Com2DataTypeToManagedDataTypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2DataTypeToManagedDataTypeConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2DataTypeToManagedDataTypeConverter.cs index 3fe7a6c4ef4..f6505333d98 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2DataTypeToManagedDataTypeConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2DataTypeToManagedDataTypeConverter.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This base class maps an ole defined data type (OLE_COLOR, IFont, etc.), + /// This base class maps an ole defined data type (OLE_COLOR, IFont, etc.), /// internal abstract class Com2DataTypeToManagedDataTypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Enum.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Enum.cs index 1555dc6a302..37494ae36fd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Enum.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Enum.cs @@ -7,42 +7,42 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class mimics a clr enum that we can create at runtime. - /// It associates an array of names with an array of values and converts - /// between them. + /// This class mimics a clr enum that we can create at runtime. + /// It associates an array of names with an array of values and converts + /// between them. /// - /// A note here: we compare string values when looking for the value of an item. - /// Typically these aren't large lists and the perf is worth it. The reason stems - /// from IPerPropertyBrowsing, which supplies a list of names and a list of - /// variants to mimic enum functionality. If the actual property value is a DWORD, - /// which translates to VT_UI4, and they specify their values as VT_I4 (which is a common - /// mistake), they won't compare properly and values can't be updated. - /// By comparing strings, we avoid this problem and add flexiblity to the system. + /// A note here: we compare string values when looking for the value of an item. + /// Typically these aren't large lists and the perf is worth it. The reason stems + /// from IPerPropertyBrowsing, which supplies a list of names and a list of + /// variants to mimic enum functionality. If the actual property value is a DWORD, + /// which translates to VT_UI4, and they specify their values as VT_I4 (which is a common + /// mistake), they won't compare properly and values can't be updated. + /// By comparing strings, we avoid this problem and add flexiblity to the system. /// internal class Com2Enum { /// - /// Our array of value string names + /// Our array of value string names /// private string[] names; /// - /// Our values + /// Our values /// private object[] values; /// - /// Our cached array of value.ToString()'s + /// Our cached array of value.ToString()'s /// private string[] stringValues; /// - /// Should we allow values besides what's in the listbox? + /// Should we allow values besides what's in the listbox? /// private readonly bool allowUnknownValues; /// - /// Our one and only ctor + /// Our one and only ctor /// public Com2Enum(string[] names, object[] values, bool allowUnknownValues) { @@ -60,7 +60,7 @@ public Com2Enum(string[] names, object[] values, bool allowUnknownValues) } /// - /// Can this enum be values other than the strict enum? + /// Can this enum be values other than the strict enum? /// public bool IsStrictEnum { @@ -71,7 +71,7 @@ public bool IsStrictEnum } /// - /// Retrieve a copy of the value array + /// Retrieve a copy of the value array /// public virtual object[] Values { @@ -82,7 +82,7 @@ public virtual object[] Values } /// - /// Retrieve a copy of the nme array. + /// Retrieve a copy of the nme array. /// public virtual string[] Names { @@ -93,7 +93,7 @@ public virtual string[] Names } /// - /// Associate a string to the appropriate value. + /// Associate a string to the appropriate value. /// public virtual object FromString(string s) { @@ -141,7 +141,7 @@ protected virtual void PopulateArrays(string[] names, object[] values) } /// - /// Retrieves the string name of a given value. + /// Retrieves the string name of a given value. /// public virtual string ToString(object v) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedBrowsingHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedBrowsingHandler.cs index 2875c06963e..bedf787f945 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedBrowsingHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedBrowsingHandler.cs @@ -5,21 +5,21 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This is the base class for handlers for COM2 extended browsing interface - /// such as IPerPropertyBrowsing, etc. + /// This is the base class for handlers for COM2 extended browsing interface + /// such as IPerPropertyBrowsing, etc. /// - /// These handlers should be stateless. That is, they should keep no refs to object - /// and should only work on a give object and dispid. That way all objects that - /// support a give interface can share a handler. + /// These handlers should be stateless. That is, they should keep no refs to object + /// and should only work on a give object and dispid. That way all objects that + /// support a give interface can share a handler. /// - /// See COM2Properties for the array of handler classes to interface classes - /// where handlers should be registered. + /// See COM2Properties for the array of handler classes to interface classes + /// where handlers should be registered. /// internal abstract class Com2ExtendedBrowsingHandler { /// - /// The interface that this handler managers - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// The interface that this handler managers + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// public abstract Type Interface { @@ -27,9 +27,9 @@ public abstract Type Interface } /// - /// Called to setup the property handlers on a given property - /// In this method, the handler will add listeners to the events that - /// the COM2PropertyDescriptor surfaces that it cares about. + /// Called to setup the property handlers on a given property + /// In this method, the handler will add listeners to the events that + /// the COM2PropertyDescriptor surfaces that it cares about. /// public virtual void SetupPropertyHandlers(Com2PropertyDescriptor propDesc) { @@ -37,9 +37,9 @@ public virtual void SetupPropertyHandlers(Com2PropertyDescriptor propDesc) } /// - /// Called to setup the property handlers on a given properties - /// In this method, the handler will add listeners to the events that - /// the Com2PropertyDescriptor surfaces that it cares about. + /// Called to setup the property handlers on a given properties + /// In this method, the handler will add listeners to the events that + /// the Com2PropertyDescriptor surfaces that it cares about. /// public abstract void SetupPropertyHandlers(Com2PropertyDescriptor[] propDesc); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedTypeConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedTypeConverter.cs index f2998d17113..2069538c2bc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedTypeConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2ExtendedTypeConverter.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// Base class for value editors that extend basic functionality. - /// calls will be delegated to the "base value editor". + /// Base class for value editors that extend basic functionality. + /// calls will be delegated to the "base value editor". /// internal class Com2ExtendedTypeConverter : TypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2FontConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2FontConverter.cs index 4e961005adb..7c92f53848e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2FontConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2FontConverter.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class maps an OLE_COLOR to a managed Color editor. + /// This class maps an OLE_COLOR to a managed Color editor. /// internal class Com2FontConverter : Com2DataTypeToManagedDataTypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IManagedPerPropertyBrowsingHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IManagedPerPropertyBrowsingHandler.cs index 9d3fb0ddee2..07690929d91 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IManagedPerPropertyBrowsingHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IManagedPerPropertyBrowsingHandler.cs @@ -33,8 +33,8 @@ public override void SetupPropertyHandlers(Com2PropertyDescriptor[] propDesc) } /// - /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// private void OnGetAttributes(Com2PropertyDescriptor sender, GetAttributesEvent attrEvent) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IPerPropertyBrowsingHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IPerPropertyBrowsingHandler.cs index fb3436d9f12..f261dc911b6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IPerPropertyBrowsingHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IPerPropertyBrowsingHandler.cs @@ -64,8 +64,8 @@ internal static string GetDisplayString(NativeMethods.IPerPropertyBrowsing ppb, } /// - /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// private void OnGetBaseAttributes(Com2PropertyDescriptor sender, GetAttributesEvent attrEvent) { @@ -247,7 +247,7 @@ public Com2IPerPropertyBrowsingEnum(Com2PropertyDescriptor targetObject, Com2IPe } /// - /// Retrieve a copy of the value array + /// Retrieve a copy of the value array /// public override object[] Values { @@ -259,7 +259,7 @@ public override object[] Values } /// - /// Retrieve a copy of the nme array. + /// Retrieve a copy of the nme array. /// public override string[] Names { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IProvidePropertyBuilderHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IProvidePropertyBuilderHandler.cs index 0058f0738af..3761c4816f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IProvidePropertyBuilderHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IProvidePropertyBuilderHandler.cs @@ -65,8 +65,8 @@ public override void SetupPropertyHandlers(Com2PropertyDescriptor[] propDesc) } /// - /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// private void OnGetBaseAttributes(Com2PropertyDescriptor sender, GetAttributesEvent attrEvent) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IVsPerPropertyBrowsingHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IVsPerPropertyBrowsingHandler.cs index 190ed9ceaf3..f1108837abb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IVsPerPropertyBrowsingHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2IVsPerPropertyBrowsingHandler.cs @@ -9,21 +9,21 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This is the base class for handlers for Com2 extended browsing interface - /// such as IPerPropertyBrowsing, etc. + /// This is the base class for handlers for Com2 extended browsing interface + /// such as IPerPropertyBrowsing, etc. /// - /// These handlers should be stateless. That is, they should keep no refs to object - /// and should only work on a give object and dispid. That way all objects that - /// support a give interface can share a handler. + /// These handlers should be stateless. That is, they should keep no refs to object + /// and should only work on a give object and dispid. That way all objects that + /// support a give interface can share a handler. /// - /// See Com2Properties for the array of handler classes to interface classes - /// where handlers should be registered. + /// See Com2Properties for the array of handler classes to interface classes + /// where handlers should be registered. /// internal class Com2IVsPerPropertyBrowsingHandler : Com2ExtendedBrowsingHandler { /// - /// The interface that this handler managers - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// The interface that this handler managers + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// public override Type Interface { @@ -45,9 +45,9 @@ public static bool AllowChildProperties(Com2PropertyDescriptor propDesc) } /// - /// Called to setup the property handlers on a given properties - /// In this method, the handler will add listeners to the events that - /// the Com2PropertyDescriptor surfaces that it cares about. + /// Called to setup the property handlers on a given properties + /// In this method, the handler will add listeners to the events that + /// the Com2PropertyDescriptor surfaces that it cares about. /// public override void SetupPropertyHandlers(Com2PropertyDescriptor[] propDesc) { @@ -88,8 +88,8 @@ private void OnGetBaseAttributes(Com2PropertyDescriptor sender, GetAttributesEve } /// - /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty - /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. + /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo and IVsPerPropertyBrowsing. HideProperty + /// such as IPerPropertyBrowsing, IProvidePropertyBuilder, etc. /// private void OnGetDynamicAttributes(Com2PropertyDescriptor sender, GetAttributesEvent attrEvent) { @@ -143,7 +143,7 @@ private void OnCanResetPropertyValue(Com2PropertyDescriptor sender, GetBoolValue } /// - /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo (part 2) + /// Here is where we handle IVsPerPropertyBrowsing.GetLocalizedPropertyInfo (part 2) /// private void OnGetDisplayName(Com2PropertyDescriptor sender, GetNameItemEvent nameItem) { @@ -162,7 +162,7 @@ private void OnGetDisplayName(Com2PropertyDescriptor sender, GetNameItemEvent na } /// - /// Here is where we handle IVsPerPropertyBrowsing.IsPropertyReadOnly + /// Here is where we handle IVsPerPropertyBrowsing.IsPropertyReadOnly /// private void OnGetIsReadOnly(Com2PropertyDescriptor sender, GetBoolValueEvent gbvevent) { @@ -181,7 +181,7 @@ private void OnGetIsReadOnly(Com2PropertyDescriptor sender, GetBoolValueEvent gb } /// - /// Here is where we handle IVsPerPropertyBrowsing.DisplayChildProperties + /// Here is where we handle IVsPerPropertyBrowsing.DisplayChildProperties /// private void OnGetTypeConverterAndTypeEditor(Com2PropertyDescriptor sender, GetTypeConverterAndTypeEditorEvent gveevent) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PictureConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PictureConverter.cs index af74606be50..5a00fac7c7e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PictureConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PictureConverter.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class maps an IPicture to a System.Drawing.Image. + /// This class maps an IPicture to a System.Drawing.Image. /// internal class Com2PictureConverter : Com2DataTypeToManagedDataTypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Properties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Properties.cs index b0f85e64c0b..1e29403fdae 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Properties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2Properties.cs @@ -9,45 +9,45 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class is responsible for managing a set or properties for a native object. It determines - /// when the properties need to be refreshed, and owns the extended handlers for those properties. + /// This class is responsible for managing a set or properties for a native object. It determines + /// when the properties need to be refreshed, and owns the extended handlers for those properties. /// internal class Com2Properties { private static readonly TraceSwitch DbgCom2PropertiesSwitch = new TraceSwitch("DbgCom2Properties", "Com2Properties: debug Com2 properties manager"); /// - /// This is the interval that we'll hold props for. If someone doesn't touch an object - /// for this amount of time, we'll dump the properties from our cache. + /// This is the interval that we'll hold props for. If someone doesn't touch an object + /// for this amount of time, we'll dump the properties from our cache. /// - /// 5 minutes -- ticks are 1/10,000,000th of a second + /// 5 minutes -- ticks are 1/10,000,000th of a second /// private static readonly long AGE_THRESHHOLD = (long)(10000000L * 60L * 5L); /// - /// This is the object that gave us the properties. We hold a WeakRef so we don't addref the object. + /// This is the object that gave us the properties. We hold a WeakRef so we don't addref the object. /// internal WeakReference weakObjRef; /// - /// This is our list of properties. + /// This is our list of properties. /// private Com2PropertyDescriptor[] props; /// - /// The index of the default property + /// The index of the default property /// private readonly int defaultIndex = -1; /// - /// The timestamp of the last operation on this property manager, usually - /// when the property list was fetched. + /// The timestamp of the last operation on this property manager, usually + /// when the property list was fetched. /// private long touchedTime; /// - /// For non-IProvideMultipleClassInfo ITypeInfos, this is the version number on the last - /// ITypeInfo we looked at. If this changes, we know we need to dump the cache. + /// For non-IProvideMultipleClassInfo ITypeInfos, this is the version number on the last + /// ITypeInfo we looked at. If this changes, we know we need to dump the cache. /// private long[] typeInfoVersions; @@ -59,7 +59,7 @@ internal class Com2Properties private int alwaysValid = 0; /// - /// These are the interfaces we recognize for extended browsing. + /// These are the interfaces we recognize for extended browsing. /// private static readonly Type[] extendedInterfaces = new Type[]{ typeof(NativeMethods.ICategorizeProperties), @@ -69,8 +69,8 @@ internal class Com2Properties typeof(NativeMethods.IManagedPerPropertyBrowsing)}; /// - /// These are the classes of handlers corresponding to the extended - /// interfaces above. + /// These are the classes of handlers corresponding to the extended + /// interfaces above. /// private static readonly Type[] extendedInterfaceHandlerTypes = new Type[]{ typeof(Com2ICategorizePropertiesHandler), @@ -82,7 +82,7 @@ internal class Com2Properties public event EventHandler Disposed; /// - /// Default ctor. + /// Default ctor. /// public Com2Properties(object obj, Com2PropertyDescriptor[] props, int defaultIndex) { @@ -143,7 +143,7 @@ internal bool AlwaysValid } /// - /// Retrieve the default property. + /// Retrieve the default property. /// public Com2PropertyDescriptor DefaultProperty { @@ -170,8 +170,8 @@ public Com2PropertyDescriptor DefaultProperty } /// - /// The object that created the list of properties. This will - /// return null if the timeout has passed or the ref has died. + /// The object that created the list of properties. This will + /// return null if the timeout has passed or the ref has died. /// public object TargetObject { @@ -192,7 +192,7 @@ public object TargetObject } /// - /// How long since these props have been queried. + /// How long since these props have been queried. /// public long TicksSinceTouched { @@ -207,7 +207,7 @@ public long TicksSinceTouched } /// - /// Returns the list of properties + /// Returns the list of properties /// public Com2PropertyDescriptor[] Properties { @@ -237,7 +237,7 @@ public Com2PropertyDescriptor[] Properties } /// - /// Should this guy be refreshed because of old age? + /// Should this guy be refreshed because of old age? /// public bool TooOld { @@ -254,9 +254,9 @@ public bool TooOld } /// - /// Checks the source object for eache extended browsing inteface - /// listed in extendedInterfaces and creates a handler from extendedInterfaceHandlerTypes - /// to handle it. + /// Checks the source object for eache extended browsing inteface + /// listed in extendedInterfaces and creates a handler from extendedInterfaceHandlerTypes + /// to handle it. /// public void AddExtendedBrowsingHandlers(Hashtable handlers) { @@ -335,10 +335,10 @@ public bool CheckValid() } /// - /// Make sure this property list is still valid. + /// Make sure this property list is still valid. /// - /// 1) WeakRef is still alive - /// 2) Our timeout hasn't passed + /// 1) WeakRef is still alive + /// 2) Our timeout hasn't passed /// public bool CheckValid(bool checkVersions) { @@ -346,9 +346,9 @@ public bool CheckValid(bool checkVersions) } /// - /// Gets a list of version longs for each type info in the COM object - /// representing hte current version stamp, function and variable count. - /// If any of these things change, we'll re-fetch the properties. + /// Gets a list of version longs for each type info in the COM object + /// representing hte current version stamp, function and variable count. + /// If any of these things change, we'll re-fetch the properties. /// private long[] GetTypeInfoVersions(object comObject) { @@ -547,8 +547,8 @@ internal bool CheckValid(bool checkVersions, bool callDispose) } /// - /// Set the props for this object, and notify each property - /// that we are now it's manager + /// Set the props for this object, and notify each property + /// that we are now it's manager /// internal void SetProps(Com2PropertyDescriptor[] props) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PropertyDescriptor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PropertyDescriptor.cs index f28c5d4e150..ee8c4e731b6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PropertyDescriptor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2PropertyDescriptor.cs @@ -14,32 +14,32 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This class wraps a com native property in a property descriptor. - /// It maintains all information relative to the basic (e.g. ITypeInfo) - /// information about the member dispid function, and converts that info - /// to meaningful managed code information. + /// This class wraps a com native property in a property descriptor. + /// It maintains all information relative to the basic (e.g. ITypeInfo) + /// information about the member dispid function, and converts that info + /// to meaningful managed code information. /// - /// It also allows other objects to register listeners to add extended - /// information at runtime such as attributes of TypeConverters. + /// It also allows other objects to register listeners to add extended + /// information at runtime such as attributes of TypeConverters. /// internal class Com2PropertyDescriptor : PropertyDescriptor, ICloneable { private EventHandlerList events; /// - /// Is this guy read only? + /// Is this guy read only? /// private readonly bool baseReadOnly; private bool readOnly; /// - /// The resoved native type -> clr type + /// The resoved native type -> clr type /// private readonly Type propertyType; /// - /// The dispid. This is also in a DispIDAttiribute, but we - /// need it a lot. + /// The dispid. This is also in a DispIDAttiribute, but we + /// need it a lot. /// private readonly int dispid; @@ -47,64 +47,64 @@ internal class Com2PropertyDescriptor : PropertyDescriptor, ICloneable private object editor; /// - /// The current display name to show for this property + /// The current display name to show for this property /// private string displayName; /// - /// This is any extra data needed. For IDispatch types, it's the GUID of - /// the interface, etc. + /// This is any extra data needed. For IDispatch types, it's the GUID of + /// the interface, etc. /// private readonly object typeData; /// - /// Keeps track of which data members need to be refreshed. + /// Keeps track of which data members need to be refreshed. /// private int refreshState; /// - /// Should we bother asking if refresh is needed? + /// Should we bother asking if refresh is needed? /// private readonly bool queryRefresh = false; /// - /// Our properties manager + /// Our properties manager /// private Com2Properties com2props; /// - /// Our original baseline properties + /// Our original baseline properties /// private Attribute[] baseAttrs; /// - /// Our cached last value -- this is only - /// for checking if we should ask for a display value + /// Our cached last value -- this is only + /// for checking if we should ask for a display value /// private object lastValue; /// - /// For Object and dispatch types, we hide them by default. + /// For Object and dispatch types, we hide them by default. /// private readonly bool typeHide; /// - /// Set if the metadata causes this property to always be hidden + /// Set if the metadata causes this property to always be hidden /// private readonly bool canShow; /// - /// This property is hidden because its get didn't return S_OK + /// This property is hidden because its get didn't return S_OK /// private bool hrHidden; /// - /// Set if we are in the process of asking handlers for attributes + /// Set if we are in the process of asking handlers for attributes /// private bool inAttrQuery; /// - /// Our event signitures. + /// Our event signitures. /// private static readonly object EventGetBaseAttributes = new object(); private static readonly object EventGetDynamicAttributes = new object(); @@ -120,7 +120,7 @@ internal class Com2PropertyDescriptor : PropertyDescriptor, ICloneable private static readonly Guid GUID_COLOR = new Guid("{66504301-BE0F-101A-8BBB-00AA00300CAB}"); /// - /// Our map of native types that we can map to managed types for editors + /// Our map of native types that we can map to managed types for editors /// private static readonly IDictionary oleConverters; @@ -137,12 +137,12 @@ static Com2PropertyDescriptor() } /// - /// Should we convert our type? + /// Should we convert our type? /// private readonly Com2DataTypeToManagedDataTypeConverter valueConverter; /// - /// Ctor. + /// Ctor. /// public Com2PropertyDescriptor(int dispid, string name, Attribute[] attrs, bool readOnly, Type propType, object typeData, bool hrHidden) : base(name, attrs) @@ -1412,9 +1412,9 @@ public override bool ShouldSerializeValue(object component) return gbv.Value; } /// - /// we wrap all value editors in this one so we can intercept - /// the GetTextFromValue calls for objects that would like - /// to modify the display name + /// we wrap all value editors in this one so we can intercept + /// the GetTextFromValue calls for objects that would like + /// to modify the display name /// private class Com2PropDescMainConverter : Com2ExtendedTypeConverter { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2TypeInfoProcessor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2TypeInfoProcessor.cs index 1c56ce59c3c..175e05a752a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2TypeInfoProcessor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/COM2TypeInfoProcessor.cs @@ -15,12 +15,12 @@ namespace System.Windows.Forms.ComponentModel.Com2Interop { /// - /// This is the main worker class of Com2 property interop. It takes an IDispatch Object - /// and translates it's ITypeInfo into Com2PropertyDescriptor objects that are understandable - /// by managed code. + /// This is the main worker class of Com2 property interop. It takes an IDispatch Object + /// and translates it's ITypeInfo into Com2PropertyDescriptor objects that are understandable + /// by managed code. /// - /// This class only knows how to process things that are natively in the typeinfo. Other property - /// information such as IPerPropertyBrowsing is handled elsewhere. + /// This class only knows how to process things that are natively in the typeinfo. Other property + /// information such as IPerPropertyBrowsing is handled elsewhere. /// internal class Com2TypeInfoProcessor { @@ -53,7 +53,7 @@ private static ModuleBuilder ModuleBuilder private static Hashtable processedLibraries; /// - /// Given an Object, this attempts to locate its type ifo + /// Given an Object, this attempts to locate its type ifo /// public static UnsafeNativeMethods.ITypeInfo FindTypeInfo(object obj, bool wantCoClass) { @@ -105,8 +105,8 @@ public static UnsafeNativeMethods.ITypeInfo FindTypeInfo(object obj, bool wantCo } /// - /// Given an Object, this attempts to locate its type info. If it implementes IProvideMultipleClassInfo - /// all available type infos will be returned, otherwise the primary one will be alled. + /// Given an Object, this attempts to locate its type info. If it implementes IProvideMultipleClassInfo + /// all available type infos will be returned, otherwise the primary one will be alled. /// public static UnsafeNativeMethods.ITypeInfo[] FindTypeInfos(object obj, bool wantCoClass) { @@ -150,8 +150,8 @@ public static UnsafeNativeMethods.ITypeInfo[] FindTypeInfos(object obj, bool wan } /// - /// Retrieve the dispid of the property that we are to use as the name - /// member. In this case, the grid will put parens around the name. + /// Retrieve the dispid of the property that we are to use as the name + /// member. In this case, the grid will put parens around the name. /// public static int GetNameDispId(UnsafeNativeMethods.IDispatch obj) { @@ -202,8 +202,8 @@ public static int GetNameDispId(UnsafeNativeMethods.IDispatch obj) } /// - /// Gets the properties for a given Com2 Object. The returned Com2Properties - /// Object contains the properties and relevant data about them. + /// Gets the properties for a given Com2 Object. The returned Com2Properties + /// Object contains the properties and relevant data about them. /// public static Com2Properties GetProperties(object obj) { @@ -325,9 +325,9 @@ private static Guid GetGuidForTypeInfo(UnsafeNativeMethods.ITypeInfo typeInfo, i } /// - /// Resolves a value type for a property from a TYPEDESC. Value types can be - /// user defined, which and may be aliased into other type infos. This function - /// will recusively walk the ITypeInfos to resolve the type to a clr Type. + /// Resolves a value type for a property from a TYPEDESC. Value types can be + /// user defined, which and may be aliased into other type infos. This function + /// will recusively walk the ITypeInfos to resolve the type to a clr Type. /// private static Type GetValueTypeFromTypeDesc(in NativeMethods.tagTYPEDESC typeDesc, UnsafeNativeMethods.ITypeInfo typeInfo, object[] typeData) { @@ -742,8 +742,8 @@ private static void ProcessFunctions(UnsafeNativeMethods.ITypeInfo typeInfo, IDi } /// - /// This converts a type info that describes a IDL defined enum - /// into one we can use + /// This converts a type info that describes a IDL defined enum + /// into one we can use /// private static Type ProcessTypeInfoEnum(UnsafeNativeMethods.ITypeInfo enumTypeInfo) { @@ -1152,7 +1152,7 @@ private class PropInfo } /// - /// A class included so we can recognize a variant properly. + /// A class included so we can recognize a variant properly. /// public class Com2Variant { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/ComNativeDescriptor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/ComNativeDescriptor.cs index 961d30935e2..93d66e34098 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/ComNativeDescriptor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/COM2Interop/ComNativeDescriptor.cs @@ -20,19 +20,19 @@ internal class ComNativeDescriptor : TypeDescriptionProvider private readonly AttributeCollection staticAttrs = new AttributeCollection(new Attribute[] { BrowsableAttribute.Yes, DesignTimeVisibleAttribute.No }); /// - /// Our collection of Object managers (Com2Properties) for native properties + /// Our collection of Object managers (Com2Properties) for native properties /// private readonly WeakHashtable nativeProps = new WeakHashtable(); /// - /// Our collection of browsing handlers, which are stateless and shared across objects. + /// Our collection of browsing handlers, which are stateless and shared across objects. /// private readonly Hashtable extendedBrowsingHandlers = new Hashtable(); /// - /// We increment this every time we look at an Object, at specified - /// intervals, we run through the properies list to see if we should - /// delete any. + /// We increment this every time we look at an Object, at specified + /// intervals, we run through the properies list to see if we should + /// delete any. /// private int clearCount = 0; private const int CLEAR_INTERVAL = 25; @@ -243,8 +243,8 @@ internal int GetPropertyValue(object component, int dispid, object[] retval) } /// - /// Checks if the given dispid matches the dispid that the Object would like to specify - /// as its identification proeprty (Name, ID, etc). + /// Checks if the given dispid matches the dispid that the Object would like to specify + /// as its identification proeprty (Name, ID, etc). /// internal bool IsNameDispId(object obj, int dispid) { @@ -256,7 +256,7 @@ internal bool IsNameDispId(object obj, int dispid) } /// - /// Checks all our property manages to see if any have become invalid. + /// Checks all our property manages to see if any have become invalid. /// private void CheckClear(object component) { @@ -313,7 +313,7 @@ private void CheckClear(object component) } /// - /// Gets the properties manager for an Object. + /// Gets the properties manager for an Object. /// private Com2Properties GetPropsInfo(object component) { @@ -341,7 +341,7 @@ private Com2Properties GetPropsInfo(object component) } /// - /// Got attributes? + /// Got attributes? /// internal AttributeCollection GetAttributes(object component) { @@ -375,7 +375,7 @@ internal AttributeCollection GetAttributes(object component) } /// - /// Default Property, please + /// Default Property, please /// internal PropertyDescriptor GetDefaultProperty(object component) { @@ -405,7 +405,7 @@ internal EventDescriptor GetDefaultEvent(object component) } /// - /// Props! + /// Props! /// internal PropertyDescriptorCollection GetProperties(object component, Attribute[] attributes) { @@ -431,7 +431,7 @@ internal PropertyDescriptorCollection GetProperties(object component, Attribute[ } /// - /// Fired when the property info gets disposed. + /// Fired when the property info gets disposed. /// private void OnPropsInfoDisposed(object sender, EventArgs e) { @@ -475,8 +475,8 @@ private void OnPropsInfoDisposed(object sender, EventArgs e) } /// - /// Looks at at value's type and creates an editor based on that. We use this to decide which editor to use - /// for a generic variant. + /// Looks at at value's type and creates an editor based on that. We use this to decide which editor to use + /// for a generic variant. /// internal static void ResolveVariantTypeConverterAndTypeEditor(object propertyValue, ref TypeConverter currentConverter, Type editorType, ref object currentEditor) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/IComponentEditorPageSite.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/IComponentEditorPageSite.cs index 6f4bb74d71f..4d812f0b6f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/IComponentEditorPageSite.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ComponentModel/IComponentEditorPageSite.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// The site for a ComponentEditorPage. + /// The site for a ComponentEditorPage. /// public interface IComponentEditorPageSite { /// - /// Returns the parent control for the page window. + /// Returns the parent control for the page window. /// Control GetControl(); /// - /// Notifies the site that the editor is in dirty state. + /// Notifies the site that the editor is in dirty state. /// void SetDirty(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ContainerControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ContainerControl.cs index b8c3b6d1ffd..9515fd06227 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ContainerControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ContainerControl.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms { /// - /// Defines a base class for controls that can parent other controls. + /// Defines a base class for controls that can parent other controls. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -22,17 +22,17 @@ public class ContainerControl : ScrollableControl, IContainerControl private Control _activeControl; /// - /// The current focused control. Do not directly edit this value. + /// The current focused control. Do not directly edit this value. /// private Control _focusedControl; /// - /// The last control that requires validation. Do not directly edit this value. + /// The last control that requires validation. Do not directly edit this value. /// private Control _unvalidatedControl; /// - /// Indicates whether automatic validation is turned on. + /// Indicates whether automatic validation is turned on. /// private AutoValidate _autoValidate = AutoValidate.Inherit; @@ -47,27 +47,27 @@ public class ContainerControl : ScrollableControl, IContainerControl private BitVector32 _state = new BitVector32(); /// - /// True if we need to perform scaling when layout resumes + /// True if we need to perform scaling when layout resumes /// private static readonly int s_stateScalingNeededOnLayout = BitVector32.CreateMask(); /// - /// Indicates whether we're currently state[stateValidating]. + /// Indicates whether we're currently state[stateValidating]. /// private static readonly int s_stateValidating = BitVector32.CreateMask(s_stateScalingNeededOnLayout); /// - /// Indicates whether we or one of our children is currently processing a mnemonic. + /// Indicates whether we or one of our children is currently processing a mnemonic. /// private static readonly int s_stateProcessingMnemonic = BitVector32.CreateMask(s_stateValidating); /// - /// True while we are scaling a child control + /// True while we are scaling a child control /// private static readonly int s_stateScalingChild = BitVector32.CreateMask(s_stateProcessingMnemonic); /// - /// Flagged when a parent changes so we can adpat our scaling logic to match. + /// Flagged when a parent changes so we can adpat our scaling logic to match. /// private static readonly int s_stateParentChanged = BitVector32.CreateMask(s_stateScalingChild); @@ -76,7 +76,7 @@ public class ContainerControl : ScrollableControl, IContainerControl private const string FontMeasureString = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ContainerControl() : base() { @@ -87,12 +87,12 @@ public ContainerControl() : base() } /// - /// AutoScaleDimensions represents the DPI or Font setting that the control has been scaled - /// to or designed at. Specifically, at design time this property will be set by the - /// designer to the value that the developer is designing at. Then, at runtime, when the - /// form loads if the CurrentAutoScaleDimensions are different from the AutoScaleDimensions, - /// PerformAutoScale will be called and AutoScaleDimensions will be set to the new value to - /// match the CurrentAutoScaleDimensions by PerformAutoScale. + /// AutoScaleDimensions represents the DPI or Font setting that the control has been scaled + /// to or designed at. Specifically, at design time this property will be set by the + /// designer to the value that the developer is designing at. Then, at runtime, when the + /// form loads if the CurrentAutoScaleDimensions are different from the AutoScaleDimensions, + /// PerformAutoScale will be called and AutoScaleDimensions will be set to the new value to + /// match the CurrentAutoScaleDimensions by PerformAutoScale. /// [Localizable(true)] [Browsable(false)] @@ -118,10 +118,10 @@ public SizeF AutoScaleDimensions } /// - /// AutoScaleFactor represents the scaling factor difference between - /// CurrentAutoScaleDimensions and AutoScaleDimensions. This value is - /// calculated on the fly. Eg: If CurrentAutoScaleDimensions is 192, 192 - /// and AutoScaleDimensions is 96, 96 then the AutoScaleFactor is 2.0, 2.0 + /// AutoScaleFactor represents the scaling factor difference between + /// CurrentAutoScaleDimensions and AutoScaleDimensions. This value is + /// calculated on the fly. Eg: If CurrentAutoScaleDimensions is 192, 192 + /// and AutoScaleDimensions is 96, 96 then the AutoScaleFactor is 2.0, 2.0 /// protected SizeF AutoScaleFactor { @@ -142,13 +142,13 @@ protected SizeF AutoScaleFactor } /// - /// Determines the scaling mode of this control. The default is no scaling. - /// Scaling by Font is useful if you wish to have a control - /// or form stretch or shrink according to the size of the fonts in the system, and should - /// be used when the control or form's size itself does not matter. - /// Scaling by DPI is useful when you wish to keep a control or form a specific size - /// independent of font. for example, a control displaying a chart or other graphic - /// may want to use DPI scaling to increase in size to account for higher DPI monitors. + /// Determines the scaling mode of this control. The default is no scaling. + /// Scaling by Font is useful if you wish to have a control + /// or form stretch or shrink according to the size of the fonts in the system, and should + /// be used when the control or form's size itself does not matter. + /// Scaling by DPI is useful when you wish to keep a control or form a specific size + /// independent of font. for example, a control displaying a chart or other graphic + /// may want to use DPI scaling to increase in size to account for higher DPI monitors. /// [SRCategory(nameof(SR.CatLayout))] [SRDescription(nameof(SR.ContainerControlAutoScaleModeDescr))] @@ -190,7 +190,7 @@ public AutoScaleMode AutoScaleMode } /// - /// Indicates whether controls in this container will be automatically validated when the focus changes. + /// Indicates whether controls in this container will be automatically validated when the focus changes. /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] @@ -236,7 +236,7 @@ public event EventHandler AutoValidateChanged } /// - /// The binding manager for the container control. + /// The binding manager for the container control. /// [Browsable(false)] [SRDescription(nameof(SR.ContainerControlBindingContextDescr))] @@ -257,7 +257,7 @@ public override BindingContext BindingContext } /// - /// Container controls support ImeMode only to allow child controls to inherit it from their parents. + /// Container controls support ImeMode only to allow child controls to inherit it from their parents. /// protected override bool CanEnableIme { @@ -274,7 +274,7 @@ protected override bool CanEnableIme } /// - /// Indicates the current active control on the container control. + /// Indicates the current active control on the container control. /// [SRCategory(nameof(SR.CatBehavior))] [Browsable(false)] @@ -297,8 +297,8 @@ protected override CreateParams CreateParams } /// - /// Represent the actual DPI or Font settings of the display at runtime. If the AutoScaleMode - /// is set to 'None' then the CurrentAutoScaleDimensions is equal to the ActualScaleDimensions. + /// Represent the actual DPI or Font settings of the display at runtime. If the AutoScaleMode + /// is set to 'None' then the CurrentAutoScaleDimensions is equal to the ActualScaleDimensions. /// [Browsable(false)] [SRCategory(nameof(SR.CatLayout))] @@ -339,7 +339,7 @@ public SizeF CurrentAutoScaleDimensions } /// - /// Indicates the form that the scrollable control is assigned to. This property is read-only. + /// Indicates the form that the scrollable control is assigned to. This property is read-only. /// [SRCategory(nameof(SR.CatAppearance))] [Browsable(false)] @@ -363,7 +363,7 @@ public Form ParentForm } /// - /// Activates the specified control. + /// Activates the specified control. /// bool IContainerControl.ActivateControl(Control control) { @@ -414,7 +414,7 @@ internal bool ActivateControl(Control control, bool originator) } /// - /// Used for UserControls - checks if the control has a focusable control inside or not + /// Used for UserControls - checks if the control has a focusable control inside or not /// private bool HasFocusableChild() { @@ -443,7 +443,7 @@ protected override void AdjustFormScrollbars(bool displayScrollbars) } /// - /// Cleans up form state after a control has been removed. + /// Cleans up form state after a control has been removed. /// internal virtual void AfterControlRemoved(Control control, Control oldParent) { @@ -561,8 +561,8 @@ private bool AssignActiveControlInternal(Control value) } /// - /// Used to notify the AxContainer that the form has been created. This should only be called - /// if there is an AX container. + /// Used to notify the AxContainer that the form has been created. This should only be called + /// if there is an AX container. /// private void AxContainerFormCreated() { @@ -570,7 +570,7 @@ private void AxContainerFormCreated() } /// - /// Specifies whether this control can process the mnemonic or not. + /// Specifies whether this control can process the mnemonic or not. /// internal override bool CanProcessMnemonic() { @@ -598,7 +598,7 @@ internal AxHost.AxContainer CreateAxContainer() } /// - /// Disposes of the resources (other than memory) used by the . + /// Disposes of the resources (other than memory) used by the . /// protected override void Dispose(bool disposing) { @@ -614,7 +614,7 @@ protected override void Dispose(bool disposing) } /// - /// Recursively enables required scaling from the given control + /// Recursively enables required scaling from the given control /// private void EnableRequiredScaling(Control start, bool enable) { @@ -626,8 +626,8 @@ private void EnableRequiredScaling(Control start, bool enable) } /// - /// Assigns focus to the activeControl. If there is no activeControl then focus is given to - /// the form. package scope for Form + /// Assigns focus to the activeControl. If there is no activeControl then focus is given to + /// the form. package scope for Form /// internal void FocusActiveControlInternal() { @@ -759,8 +759,8 @@ private SizeF GetFontAutoScaleDimensions() } /// - /// This method is called when one of the auto scale properties changes, indicating that we - /// should scale controls on the next layout. + /// This method is called when one of the auto scale properties changes, indicating that we + /// should scale controls on the next layout. /// private void LayoutScalingNeeded() { @@ -776,16 +776,16 @@ private void LayoutScalingNeeded() } /// - /// To maintain backwards compat with AutoScale on form, we need to keep the - /// two models from conflicting. This method is only here for Form to override - /// it and update its AutoScale property appropriately. + /// To maintain backwards compat with AutoScale on form, we need to keep the + /// two models from conflicting. This method is only here for Form to override + /// it and update its AutoScale property appropriately. /// private protected virtual void OnAutoScaleModeChanged() { } /// - /// Raises the AutoValidateChanged event. + /// Raises the AutoValidateChanged event. /// protected virtual void OnAutoValidateChanged(EventArgs e) => _autoValidateChanged?.Invoke(this, e); @@ -802,8 +802,8 @@ internal override void OnFrameWindowActivate(bool fActivate) } /// - /// Called when a child is about to resume its layout. The default implementation - /// calls OnChildLayoutResuming on the parent. + /// Called when a child is about to resume its layout. The default implementation + /// calls OnChildLayoutResuming on the parent. /// internal override void OnChildLayoutResuming(Control child, bool performLayout) { @@ -835,7 +835,7 @@ internal override void OnChildLayoutResuming(Control child, bool performLayout) } /// - /// Raises the CreateControl event. + /// Raises the CreateControl event. /// protected override void OnCreateControl() { @@ -849,7 +849,7 @@ protected override void OnCreateControl() } /// - /// We override this to clear the current autoscale cache. + /// We override this to clear the current autoscale cache. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnFontChanged(EventArgs e) @@ -879,7 +879,7 @@ protected override void OnFontChanged(EventArgs e) } /// - /// This is called by the top level form to clear the current autoscale cache. + /// This is called by the top level form to clear the current autoscale cache. /// private protected void FormDpiChanged(float factor) { @@ -900,7 +900,7 @@ private protected void FormDpiChanged(float factor) } /// - /// Container controls scale during layout. + /// Container controls scale during layout. /// protected override void OnLayout(LayoutEventArgs e) { @@ -909,9 +909,9 @@ protected override void OnLayout(LayoutEventArgs e) } /// - /// Called when the last resume layout call is made. If performLayout is true a layout will - /// occur as soon as this call returns. Layout is still suspended when this call is made. - /// The default implementation calls OnChildLayoutResuming on the parent, if it exists. + /// Called when the last resume layout call is made. If performLayout is true a layout will + /// occur as soon as this call returns. Layout is still suspended when this call is made. + /// The default implementation calls OnChildLayoutResuming on the parent, if it exists. /// internal override void OnLayoutResuming(bool performLayout) { @@ -920,11 +920,11 @@ internal override void OnLayoutResuming(bool performLayout) } /// - /// Called when the parent changes. Container controls prefer to have their parents scale - /// themselves, but when a parent is first changed, and as a result the font changes as - /// well, a container control should scale itself. We save off this state so a later - /// font change can trigger a scale of us. We only set this state if required scaling is - /// disabled: if it is enabled we are still initializing and parent changes are normal. + /// Called when the parent changes. Container controls prefer to have their parents scale + /// themselves, but when a parent is first changed, and as a result the font changes as + /// well, a container control should scale itself. We save off this state so a later + /// font change can trigger a scale of us. We only set this state if required scaling is + /// disabled: if it is enabled we are still initializing and parent changes are normal. /// protected override void OnParentChanged(EventArgs e) { @@ -933,24 +933,24 @@ protected override void OnParentChanged(EventArgs e) } /// - /// Performs scaling of this control. Scaling works by scaling all children of this control. - /// Those children that are ContainerControls will have their PerformAutoScale method called - /// so they can scale their children. + /// Performs scaling of this control. Scaling works by scaling all children of this control. + /// Those children that are ContainerControls will have their PerformAutoScale method called + /// so they can scale their children. /// public void PerformAutoScale() => PerformAutoScale(includedBounds: true, excludedBounds: true); /// - /// Performs scaling of this control. Scaling works by scaling all children of this control. + /// Performs scaling of this control. Scaling works by scaling all children of this control. /// - /// If includedBounds is true those controls whose bounds have changed since - /// they were last scaled will be auto scaled. If excludedBounds is true those - /// controls whose bounds have not changed since they were last scaled will be - /// auto scaled. + /// If includedBounds is true those controls whose bounds have changed since + /// they were last scaled will be auto scaled. If excludedBounds is true those + /// controls whose bounds have not changed since they were last scaled will be + /// auto scaled. /// - /// PerformAutoScale is automatically called during OnLayout. The parameters to - /// PerformAutoScale are passed as follows: - /// 1. If AutoScaleDimensions are set, includedBounds is set to true. - /// 2. If a font change occurred, excludedBounds is set to true. + /// PerformAutoScale is automatically called during OnLayout. The parameters to + /// PerformAutoScale are passed as follows: + /// 1. If AutoScaleDimensions are set, includedBounds is set to true. + /// 2. If a font change occurred, excludedBounds is set to true. /// private void PerformAutoScale(bool includedBounds, bool excludedBounds) { @@ -991,7 +991,7 @@ private void PerformAutoScale(bool includedBounds, bool excludedBounds) } /// - /// Checks to see if we need to perform an autoscale in response to a layout. + /// Checks to see if we need to perform an autoscale in response to a layout. /// private void PerformNeededAutoScaleOnLayout() { @@ -1002,7 +1002,7 @@ private void PerformNeededAutoScaleOnLayout() } /// - /// Recursively resumes all layout. + /// Recursively resumes all layout. /// internal void ResumeAllLayout(Control start, bool performLayout) { @@ -1020,7 +1020,7 @@ internal void ResumeAllLayout(Control start, bool performLayout) } /// - /// Recursively suspends all layout. + /// Recursively suspends all layout. /// internal void SuspendAllLayout(Control start) { @@ -1038,10 +1038,10 @@ internal void SuspendAllLayout(Control start) } /// - /// Overrides the default scaling mechanism to account for autoscaling. This override - /// behaves as follows: any unchanged controls are always scaled according to the container - /// control's AutoScaleFactor. Any changed controls are scaled according to the provided - /// scaling factor. + /// Overrides the default scaling mechanism to account for autoscaling. This override + /// behaves as follows: any unchanged controls are always scaled according to the container + /// control's AutoScaleFactor. Any changed controls are scaled according to the provided + /// scaling factor. /// internal override void Scale(SizeF includedFactor, SizeF excludedFactor, Control requestingControl) { @@ -1112,8 +1112,8 @@ internal override void Scale(SizeF includedFactor, SizeF excludedFactor, Control } /// - /// Process an arrowKey press by selecting the next control in the group that the activeControl - /// belongs to. + /// Process an arrowKey press by selecting the next control in the group that the activeControl + /// belongs to. /// private bool ProcessArrowKey(bool forward) { @@ -1127,10 +1127,10 @@ private bool ProcessArrowKey(bool forward) } /// - /// Processes a dialog character. Overrides Control.processDialogChar(). This method calls - /// the ProcessMnemonic() method to check if the character is a mnemonic for one of the - /// controls on the form. If processMnemonic() does not consume the character, then - /// base.ProcessDialogChar() is called. + /// Processes a dialog character. Overrides Control.processDialogChar(). This method calls + /// the ProcessMnemonic() method to check if the character is a mnemonic for one of the + /// controls on the form. If processMnemonic() does not consume the character, then + /// base.ProcessDialogChar() is called. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override bool ProcessDialogChar(char charCode) @@ -1147,10 +1147,10 @@ protected override bool ProcessDialogChar(char charCode) } /// - /// Processes a dialog key. Overrides Control.processDialogKey(). This method implements - /// handling of the TAB, LEFT, RIGHT, UP, and DOWN keys in dialogs. - /// The method performs no processing on keys that include the ALT or CONTROL modifiers. - /// For the TAB key, the method selects the next control on the form. For the arrow keys, !!! + /// Processes a dialog key. Overrides Control.processDialogKey(). This method implements + /// handling of the TAB, LEFT, RIGHT, UP, and DOWN keys in dialogs. + /// The method performs no processing on keys that include the ALT or CONTROL modifiers. + /// For the TAB key, the method selects the next control on the form. For the arrow keys, !!! /// protected override bool ProcessDialogKey(Keys keyData) { @@ -1300,7 +1300,7 @@ protected internal override bool ProcessMnemonic(char charCode) } /// - /// Selects the next available control and makes it the active control. + /// Selects the next available control and makes it the active control. /// protected virtual bool ProcessTabKey(bool forward) { @@ -1353,7 +1353,7 @@ protected override void Select(bool directed, bool forward) } /// - /// Implements ActiveControl property setter. + /// Implements ActiveControl property setter. /// internal void SetActiveControl(Control value) { @@ -1433,15 +1433,15 @@ private ContainerControl InnerMostFocusedContainerControl } /// - /// Updates the default button based on current selection, and the acceptButton property. + /// Updates the default button based on current selection, and the acceptButton property. /// protected virtual void UpdateDefaultButton() { } /// - /// Updates the focusedControl variable by walking towards the activeControl variable, firing - /// enter and leave events and validation as necessary. + /// Updates the focusedControl variable by walking towards the activeControl variable, firing + /// enter and leave events and validation as necessary. /// internal void UpdateFocusedControl() { @@ -1584,7 +1584,7 @@ internal void UpdateFocusedControl() } /// - /// Make sure we have a valid choice of last unvalidated control if at all possible. + /// Make sure we have a valid choice of last unvalidated control if at all possible. /// private void EnsureUnvalidatedControl(Control candidate) { @@ -1638,8 +1638,8 @@ private void EnsureUnvalidatedControl(Control candidate) } /// - /// Validates the last unvalidated control and its ancestors (up through the ancestor in common - /// with enterControl) if enterControl causes validation. + /// Validates the last unvalidated control and its ancestors (up through the ancestor in common + /// with enterControl) if enterControl causes validation. /// private void EnterValidation(Control enterControl) { @@ -1679,21 +1679,21 @@ private void EnterValidation(Control enterControl) } /// - /// Validates the last unvalidated control and its ancestors up through, but not including the current control. + /// Validates the last unvalidated control and its ancestors up through, but not including the current control. /// - /// This version always performs validation, regardless of the AutoValidate setting of the control's parent. + /// This version always performs validation, regardless of the AutoValidate setting of the control's parent. /// /// - /// This version is intended for user code that wants to force validation, even - /// while auto-validation is turned off. When adding any explicit Validate() calls to our code, consider using - /// Validate(true) rather than Validate(), so that you will be sensitive to the current auto-validation setting. + /// This version is intended for user code that wants to force validation, even + /// while auto-validation is turned off. When adding any explicit Validate() calls to our code, consider using + /// Validate(true) rather than Validate(), so that you will be sensitive to the current auto-validation setting. /// public bool Validate() => Validate(checkAutoValidate: false); /// - /// Validates the last unvalidated control and its ancestors up through, but not including the current control. - /// This version will skip validation if checkAutoValidate is true and the effective AutoValidate setting, as - /// determined by the control's parent, is AutoValidate.Disable. + /// Validates the last unvalidated control and its ancestors up through, but not including the current control. + /// This version will skip validation if checkAutoValidate is true and the effective AutoValidate setting, as + /// determined by the control's parent, is AutoValidate.Disable. public bool Validate(bool checkAutoValidate) { return ValidateInternal(checkAutoValidate, out bool validatedControlAllowsFocusChange); @@ -1749,16 +1749,16 @@ internal bool ValidateInternal(bool checkAutoValidate, out bool validatedControl } /// - /// Validates all selectable child controls in the container, including descendants. This is - /// equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See - /// for details of exactly which child controls will be validated. + /// Validates all selectable child controls in the container, including descendants. This is + /// equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See + /// for details of exactly which child controls will be validated. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] public virtual bool ValidateChildren() => ValidateChildren(ValidationConstraints.Selectable); /// - /// Validates all the child controls in the container. Exactly which controls are - /// validated and which controls are skipped is determined by . + /// Validates all the child controls in the container. Exactly which controls are + /// validated and which controls are skipped is determined by . /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] @@ -1905,7 +1905,7 @@ internal void ResetActiveAndFocusedControlsRecursive() internal virtual bool ShouldSerializeAutoValidate() => _autoValidate != AutoValidate.Inherit; /// - /// WM_SETFOCUS handler + /// WM_SETFOCUS handler /// private void WmSetFocus(ref Message m) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventArgs.cs index 105d587f3ac..74d198ba98b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class ContentsResizedEventArgs : EventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public ContentsResizedEventArgs(Rectangle newRectangle) { @@ -21,7 +21,7 @@ public ContentsResizedEventArgs(Rectangle newRectangle) } /// - /// Represents the requested size of the control. + /// Represents the requested size of the control. /// public Rectangle NewRectangle { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventHandler.cs index f511702da24..2635243764a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ContentsResizedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ContentsResizedEventHandler(object sender, ContentsResizedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ContextMenuStrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ContextMenuStrip.cs index 5211c3077d3..02e70998eb4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ContextMenuStrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ContextMenuStrip.cs @@ -18,7 +18,7 @@ namespace System.Windows.Forms public class ContextMenuStrip : ToolStripDropDownMenu { /// - /// Summary of ContextMenuStrip. + /// Summary of ContextMenuStrip. /// public ContextMenuStrip(IContainer container) : base() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlAccessibleObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlAccessibleObject.cs index d78da85b092..44aed6827f6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlAccessibleObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlAccessibleObject.cs @@ -422,9 +422,9 @@ public void NotifyClients(AccessibleEvents accEvent, int objectID, int childID) } /// - /// Raises the LiveRegionChanged UIA event. - /// To make this method effective, the control must implement System.Windows.Forms.Automation.IAutomationLiveRegion interface - /// and its LiveSetting property must return either AutomationLiveSetting.Polite or AutomationLiveSetting.Assertive value. + /// Raises the LiveRegionChanged UIA event. + /// To make this method effective, the control must implement System.Windows.Forms.Automation.IAutomationLiveRegion interface + /// and its LiveSetting property must return either AutomationLiveSetting.Polite or AutomationLiveSetting.Assertive value. /// /// True if operation succeeds, False otherwise. public override bool RaiseLiveRegionChanged() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlCollection.cs index d43e1392ddc..b289ebd35dc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlCollection.cs @@ -19,10 +19,10 @@ public partial class Control [ListBindable(false), ComVisible(false)] public class ControlCollection : ArrangedElementCollection, IList, ICloneable { - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. - /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. + /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. private int _lastAccessedIndex = -1; public ControlCollection(Control owner) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Control.Ime.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Control.Ime.cs index cc3686b491d..a75a32d3607 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Control.Ime.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Control.Ime.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// Control's IME feature. + /// Control's IME feature. /// public partial class Control : Component, @@ -660,8 +660,8 @@ internal void OnImeContextStatusChanged(IntPtr handle) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnImeModeChanged(EventArgs e) { @@ -920,8 +920,7 @@ private void WmImeKillFocus() } } // end class Control - ///////////////////////////////////////////////////////// ImeContext class ///////////////////////////////////////////////////////// - + ///////////////////////////////////////////////////////// ImeContext class ///////////////////////////////////////////////////////// /// /// Represents the native IME context. /// @@ -1350,8 +1349,7 @@ public static void SetOpenStatus(bool open, IntPtr handle) } }// end ImeContext class - ///////////////////////////////////////////////////////// ImeModeConversion structure ///////////////////////////////////////////////////////// - + ///////////////////////////////////////////////////////// ImeModeConversion structure ///////////////////////////////////////////////////////// /// /// Helper class that provides information about IME convertion mode. Convertion mode refers to how IME interprets input like /// ALPHANUMERIC or HIRAGANA and depending on its value the IME enables/disables the IME convertion window appropriately. @@ -1379,9 +1377,9 @@ public struct ImeModeConversion /// /// Supported input language ImeMode tables. - /// WARNING: Do not try to map 'active' IME modes from one table to another since they can have a different - /// meaning depending on the language; for instance ImeMode.Off means 'disable' or 'alpha' to Chinese - /// but to Japanese it is 'alpha' and to Korean it has no meaning. + /// WARNING: Do not try to map 'active' IME modes from one table to another since they can have a different + /// meaning depending on the language; for instance ImeMode.Off means 'disable' or 'alpha' to Chinese + /// but to Japanese it is 'alpha' and to Korean it has no meaning. /// private static readonly ImeMode[] japaneseTable = { ImeMode.Inherit, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs index fd3f9280126..5d5ea428f46 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs @@ -499,14 +499,14 @@ internal Control(bool autoInstallSyncContext) : base() } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Control(string text) : this(null, text) { } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Control(string text, int left, int top, int width, int height) : this(null, text, left, top, width, height) @@ -514,7 +514,7 @@ public Control(string text, int left, int top, int width, int height) : } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Control(Control parent, string text) : this() { @@ -523,7 +523,7 @@ public Control(Control parent, string text) : this() } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Control(Control parent, string text, int left, int top, int width, int height) : this(parent, text) { @@ -875,8 +875,8 @@ public event EventHandler AutoSizeChanged } /// - /// Controls the location of where this control is scrolled to in ScrollableControl.ScrollControlIntoView. - /// Default is the upper left hand corner of the control. + /// Controls the location of where this control is scrolled to in ScrollableControl.ScrollControlIntoView. + /// Default is the upper left hand corner of the control. /// [ Browsable(false), @@ -1352,10 +1352,10 @@ public event EventHandler CausesValidationChanged remove => Events.RemoveHandler(s_causesValidationEvent, value); } - /// This is for perf. Turn this property on to temporarily enable text caching. This is good for - /// operations such as layout or painting where we don't expect the text to change (we will update the - /// cache if it does) but prevents us from sending a ton of messages turing layout. See the PaintWithErrorHandling - /// function. + /// This is for perf. Turn this property on to temporarily enable text caching. This is good for + /// operations such as layout or painting where we don't expect the text to change (we will update the + /// cache if it does) but prevents us from sending a ton of messages turing layout. See the PaintWithErrorHandling + /// function. /// internal bool CacheTextInternal { @@ -3125,7 +3125,7 @@ public static MouseButtons MouseButtons } /// - /// The current position of the mouse in screen coordinates. + /// The current position of the mouse in screen coordinates. /// public static Point MousePosition { @@ -3362,8 +3362,8 @@ private bool RenderColorTransparent(Color c) => GetStyle(ControlStyles.SupportsTransparentBackColor) && c.A < 255; /// - /// This property is required by certain controls (TabPage) to render its transparency using theming API. - /// We dont want all controls (that are have transparent BackColor) to use theming API to render its background because it has HUGE PERF cost. + /// This property is required by certain controls (TabPage) to render its transparency using theming API. + /// We dont want all controls (that are have transparent BackColor) to use theming API to render its background because it has HUGE PERF cost. /// internal virtual bool RenderTransparencyWithVisualStyles => false; @@ -4836,20 +4836,20 @@ public IAsyncResult BeginInvoke(Delegate method) } /// - /// Executes the given delegate on the thread that owns this Control's - /// underlying window handle. The delegate is called asynchronously and this - /// method returns immediately. You may call this from any thread, even the - /// thread that owns the control's handle. If the control's handle doesn't - /// exist yet, this will follow up the control's parent chain until it finds a - /// control or form that does have a window handle. If no appropriate handle - /// can be found, BeginInvoke will throw an exception. Exceptions within the - /// delegate method are considered untrapped and will be sent to the - /// application's untrapped exception handler. + /// Executes the given delegate on the thread that owns this Control's + /// underlying window handle. The delegate is called asynchronously and this + /// method returns immediately. You may call this from any thread, even the + /// thread that owns the control's handle. If the control's handle doesn't + /// exist yet, this will follow up the control's parent chain until it finds a + /// control or form that does have a window handle. If no appropriate handle + /// can be found, BeginInvoke will throw an exception. Exceptions within the + /// delegate method are considered untrapped and will be sent to the + /// application's untrapped exception handler. /// - /// There are five functions on a control that are safe to call from any - /// thread: GetInvokeRequired, Invoke, BeginInvoke, EndInvoke and CreateGraphics. - /// For all other method calls, you should use one of the invoke methods to marshal - /// the call to the control's thread. + /// There are five functions on a control that are safe to call from any + /// thread: GetInvokeRequired, Invoke, BeginInvoke, EndInvoke and CreateGraphics. + /// For all other method calls, you should use one of the invoke methods to marshal + /// the call to the control's thread. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public IAsyncResult BeginInvoke(Delegate method, params object[] args) @@ -5586,8 +5586,8 @@ internal bool EndUpdateInternal(bool invalidate) } /// - /// Retrieves the form that this control is on. The control's parent may not be - /// the same as the form. + /// Retrieves the form that this control is on. The control's parent may not be + /// the same as the form. /// public Form FindForm() { @@ -5669,7 +5669,7 @@ protected void RaiseMouseEvent(object key, MouseEventArgs e) } /// - /// Attempts to set focus to this control. + /// Attempts to set focus to this control. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public bool Focus() @@ -5681,9 +5681,9 @@ public bool Focus() } /// - /// Internal method for setting focus to the control. - /// Form overrides this method - because MDI child forms - /// need to be focused by calling the MDIACTIVATE message. + /// Internal method for setting focus to the control. + /// Form overrides this method - because MDI child forms + /// need to be focused by calling the MDIACTIVATE message. /// private protected virtual bool FocusInternal() { @@ -5713,11 +5713,11 @@ private protected virtual bool FocusInternal() } /// - /// Returns the control that is currently associated with handle. - /// This method will search up the HWND parent chain until it finds some - /// handle that is associated with with a control. This method is more - /// robust that fromHandle because it will correctly return controls - /// that own more than one handle. + /// Returns the control that is currently associated with handle. + /// This method will search up the HWND parent chain until it finds some + /// handle that is associated with with a control. This method is more + /// robust that fromHandle because it will correctly return controls + /// that own more than one handle. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public static Control FromChildHandle(IntPtr handle) @@ -5736,7 +5736,7 @@ public static Control FromChildHandle(IntPtr handle) } /// - /// Returns the control that is currently associated with handle. + /// Returns the control that is currently associated with handle. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public static Control FromHandle(IntPtr handle) @@ -5819,8 +5819,8 @@ public Control GetChildAtPoint(Point pt) } /// - /// Returns the closest ContainerControl in the control's chain of parent controls - /// and forms. + /// Returns the closest ContainerControl in the control's chain of parent controls + /// and forms. /// public IContainerControl GetContainerControl() { @@ -7060,8 +7060,8 @@ private void ListenToUserPreferenceChanged(bool listen) } /// - /// Transforms an integer coordinate from logical to device units - /// by scaling it for the current DPI and rounding down to the nearest integer value. + /// Transforms an integer coordinate from logical to device units + /// by scaling it for the current DPI and rounding down to the nearest integer value. /// public int LogicalToDeviceUnits(int value) { @@ -7268,7 +7268,7 @@ private void NotifyValidated() } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected void InvokeOnClick(Control toInvoke, EventArgs e) @@ -7626,9 +7626,9 @@ protected virtual void OnRightToLeftChanged(EventArgs e) } /// - /// OnNotifyMessage is called if the ControlStyles.EnableNotifyMessage bit is set. - /// This allows for controls to listen to window messages, without allowing them to - /// actually modify the message. + /// OnNotifyMessage is called if the ControlStyles.EnableNotifyMessage bit is set. + /// This allows for controls to listen to window messages, without allowing them to + /// actually modify the message. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnNotifyMessage(Message m) @@ -7867,8 +7867,8 @@ protected virtual void OnTextChanged(EventArgs e) } /// - /// Raises the event. - /// Inheriting classes should override this method to handle this event. + /// Raises the event. + /// Inheriting classes should override this method to handle this event. /// Call base.OnVisible to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] @@ -7948,8 +7948,8 @@ protected virtual void OnParentChanged(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnClick(EventArgs e) @@ -7967,7 +7967,7 @@ protected virtual void OnClientSizeChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnControlAdded(ControlEventArgs e) @@ -7976,7 +7976,7 @@ protected virtual void OnControlAdded(ControlEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnControlRemoved(ControlEventArgs e) @@ -8133,7 +8133,7 @@ protected virtual void OnLocationChanged(EventArgs e) /// Inheriting classes should override this method to find out when the /// handle is about to be destroyed. /// Call base.OnHandleDestroyed last. - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnHandleDestroyed(EventArgs e) @@ -8192,7 +8192,7 @@ protected virtual void OnHandleDestroyed(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDoubleClick(EventArgs e) @@ -8201,8 +8201,8 @@ protected virtual void OnDoubleClick(EventArgs e) } /// - /// Raises the event. - /// Inheriting classes should override this method to handle this event. + /// Raises the event. + /// Inheriting classes should override this method to handle this event. /// Call base.onEnter to send this event to any registered event listeners. /// /// @@ -8262,7 +8262,7 @@ protected virtual void OnEnter(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected void InvokeGotFocus(Control toInvoke, EventArgs e) @@ -8275,7 +8275,7 @@ protected void InvokeGotFocus(Control toInvoke, EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnGotFocus(EventArgs e) @@ -8292,8 +8292,8 @@ protected virtual void OnGotFocus(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onHelp to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onHelp to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnHelpRequested(HelpEventArgs hevent) @@ -8345,7 +8345,7 @@ protected virtual void OnInvalidated(InvalidateEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnKeyDown(KeyEventArgs e) @@ -8354,7 +8354,7 @@ protected virtual void OnKeyDown(KeyEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnKeyPress(KeyPressEventArgs e) @@ -8363,7 +8363,7 @@ protected virtual void OnKeyPress(KeyPressEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnKeyUp(KeyEventArgs e) @@ -8372,10 +8372,10 @@ protected virtual void OnKeyUp(KeyEventArgs e) } /// - /// Core layout logic. Inheriting controls should override this function to do any custom - /// layout logic. It is not neccessary to call base.OnLayout, however for normal docking - /// an functions to work, base.OnLayout must be called. - /// Raises the event. + /// Core layout logic. Inheriting controls should override this function to do any custom + /// layout logic. It is not neccessary to call base.OnLayout, however for normal docking + /// an functions to work, base.OnLayout must be called. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnLayout(LayoutEventArgs levent) @@ -8400,9 +8400,9 @@ protected virtual void OnLayout(LayoutEventArgs levent) } /// - /// Called when the last resume layout call is made. If performLayout is true a layout will - /// occur as soon as this call returns. Layout is still suspended when this call is made. - /// The default implementation calls OnChildLayoutResuming on the parent, if it exists. + /// Called when the last resume layout call is made. If performLayout is true a layout will + /// occur as soon as this call returns. Layout is still suspended when this call is made. + /// The default implementation calls OnChildLayoutResuming on the parent, if it exists. /// internal virtual void OnLayoutResuming(bool performLayout) { @@ -8414,7 +8414,7 @@ internal virtual void OnLayoutSuspended() } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnLeave(EventArgs e) @@ -8433,7 +8433,7 @@ protected void InvokeLostFocus(Control toInvoke, EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnLostFocus(EventArgs e) @@ -8450,7 +8450,7 @@ protected virtual void OnMarginChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseDoubleClick(MouseEventArgs e) @@ -8459,7 +8459,7 @@ protected virtual void OnMouseDoubleClick(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseClick(MouseEventArgs e) @@ -8468,7 +8468,7 @@ protected virtual void OnMouseClick(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseCaptureChanged(EventArgs e) @@ -8477,7 +8477,7 @@ protected virtual void OnMouseCaptureChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseDown(MouseEventArgs e) @@ -8486,7 +8486,7 @@ protected virtual void OnMouseDown(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseEnter(EventArgs e) @@ -8495,7 +8495,7 @@ protected virtual void OnMouseEnter(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseLeave(EventArgs e) @@ -8504,10 +8504,10 @@ protected virtual void OnMouseLeave(EventArgs e) } /// - /// Raises the event. - /// Occurs when the form is moved to a monitor with a different resolution (number of dots per inch), - /// or when scaling level is changed in the windows setting by the user. - /// This message is not sent to the top level windows. + /// Raises the event. + /// Occurs when the form is moved to a monitor with a different resolution (number of dots per inch), + /// or when scaling level is changed in the windows setting by the user. + /// This message is not sent to the top level windows. /// [ Browsable(true), @@ -8519,10 +8519,10 @@ protected virtual void OnDpiChangedBeforeParent(EventArgs e) } /// - /// Raises the event. - /// Occurs when the form is moved to a monitor with a different resolution (number of dots per inch), - /// or when scaling level is changed in windows setting by the user. - /// This message is not sent to the top level windows. + /// Raises the event. + /// Occurs when the form is moved to a monitor with a different resolution (number of dots per inch), + /// or when scaling level is changed in windows setting by the user. + /// This message is not sent to the top level windows. /// [ Browsable(true), @@ -8534,7 +8534,7 @@ protected virtual void OnDpiChangedAfterParent(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseHover(EventArgs e) @@ -8543,7 +8543,7 @@ protected virtual void OnMouseHover(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseMove(MouseEventArgs e) @@ -8552,7 +8552,7 @@ protected virtual void OnMouseMove(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseUp(MouseEventArgs e) @@ -8561,7 +8561,7 @@ protected virtual void OnMouseUp(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMouseWheel(MouseEventArgs e) @@ -8570,7 +8570,7 @@ protected virtual void OnMouseWheel(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMove(EventArgs e) @@ -8655,7 +8655,7 @@ protected virtual void OnQueryContinueDrag(QueryContinueDragEventArgs qcdevent) } /// - /// Raises the event when the Region property has changed. + /// Raises the event when the Region property has changed. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnRegionChanged(EventArgs e) @@ -8667,7 +8667,7 @@ protected virtual void OnRegionChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnResize(EventArgs e) @@ -8682,7 +8682,7 @@ protected virtual void OnResize(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnPreviewKeyDown(PreviewKeyDownEventArgs e) @@ -8742,8 +8742,8 @@ protected virtual void OnSystemColorsChanged(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnValidating(CancelEventArgs e) @@ -8752,7 +8752,7 @@ protected virtual void OnValidating(CancelEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnValidated(EventArgs e) @@ -8761,9 +8761,9 @@ protected virtual void OnValidated(EventArgs e) } /// - /// Is invoked when the control handle is created or right before the top level parent receives WM_DPICHANGED message. - /// This method is an opportunity to rescale any constant sizes, glyphs or bitmaps before re-painting. - /// The derived class can choose to not call the base class implementation. + /// Is invoked when the control handle is created or right before the top level parent receives WM_DPICHANGED message. + /// This method is an opportunity to rescale any constant sizes, glyphs or bitmaps before re-painting. + /// The derived class can choose to not call the base class implementation. /// [ Browsable(true), @@ -9227,7 +9227,7 @@ internal bool PerformContainerValidation(ValidationConstraints validationConstra } /// - /// Computes the location of the screen point p in client coords. + /// Computes the location of the screen point p in client coords. /// public Point PointToClient(Point p) { @@ -9236,7 +9236,7 @@ public Point PointToClient(Point p) } /// - /// Computes the location of the client point p in screen coords. + /// Computes the location of the client point p in screen coords. /// public Point PointToScreen(Point p) { @@ -9250,21 +9250,21 @@ public Point PointToScreen(Point p) /// msg.message field are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. /// If this method processes the message it must return true, in which case /// the message loop will not dispatch the message. - /// For WM_KEYDOWN and WM_SYSKEYDOWN messages, preProcessMessage() first + /// For WM_KEYDOWN and WM_SYSKEYDOWN messages, preProcessMessage() first /// calls processCmdKey() to check for command keys such as accelerators and /// menu shortcuts. If processCmdKey() doesn't process the message, then /// isInputKey() is called to check whether the key message represents an /// input key for the control. Finally, if isInputKey() indicates that the /// control isn't interested in the key message, then processDialogKey() is /// called to check for dialog keys such as TAB, arrow keys, and mnemonics. - /// For WM_CHAR messages, preProcessMessage() first calls isInputChar() to + /// For WM_CHAR messages, preProcessMessage() first calls isInputChar() to /// check whether the character message represents an input character for /// the control. If isInputChar() indicates that the control isn't interested /// in the character message, then processDialogChar() is called to check for /// dialog characters such as mnemonics. - /// For WM_SYSCHAR messages, preProcessMessage() calls processDialogChar() + /// For WM_SYSCHAR messages, preProcessMessage() calls processDialogChar() /// to check for dialog characters such as mnemonics. - /// When overriding preProcessMessage(), a control should return true to + /// When overriding preProcessMessage(), a control should return true to /// indicate that it has processed the message. For messages that aren't /// processed by the control, the result of "base.preProcessMessage()" /// should be returned. Controls will typically override one of the more @@ -9427,15 +9427,15 @@ internal static PreProcessControlState PreProcessControlMessageInternal(Control /// include accelerators and menu shortcuts. The method must return true to /// indicate that it has processed the command key, or false to indicate /// that the key is not a command key. - /// processCmdKey() first checks if the control has a context menu, and if + /// processCmdKey() first checks if the control has a context menu, and if /// so calls the menu's processCmdKey() to check for menu shortcuts. If the /// command key isn't a menu shortcut, and if the control has a parent, the /// key is passed to the parent's processCmdKey() method. The net effect is /// that command keys are "bubbled" up the control hierarchy. - /// When overriding processCmdKey(), a control should return true to + /// When overriding processCmdKey(), a control should return true to /// indicate that it has processed the key. For keys that aren't processed by /// the control, the result of "base.processCmdKey()" should be returned. - /// Controls will seldom, if ever, need to override this method. + /// Controls will seldom, if ever, need to override this method. /// protected virtual bool ProcessCmdKey(ref Message msg, Keys keyData) { @@ -9557,15 +9557,15 @@ private void PrintToMetaFile_SendPrintMessage(HandleRef hDC, IntPtr lParam) /// pre-processing to handle dialog characters, such as control mnemonics. /// This method is called only if the isInputChar() method indicates that /// the control isn't interested in the character. - /// processDialogChar() simply sends the character to the parent's + /// processDialogChar() simply sends the character to the parent's /// processDialogChar() method, or returns false if the control has no /// parent. The Form class overrides this method to perform actual /// processing of dialog characters. - /// When overriding processDialogChar(), a control should return true to + /// When overriding processDialogChar(), a control should return true to /// indicate that it has processed the character. For characters that aren't /// processed by the control, the result of "base.processDialogChar()" /// should be returned. - /// Controls will seldom, if ever, need to override this method. + /// Controls will seldom, if ever, need to override this method. /// protected virtual bool ProcessDialogChar(char charCode) { @@ -9578,15 +9578,15 @@ protected virtual bool ProcessDialogChar(char charCode) /// pre-processing to handle dialog characters, such as TAB, RETURN, ESCAPE, /// and arrow keys. This method is called only if the isInputKey() method /// indicates that the control isn't interested in the key. - /// processDialogKey() simply sends the character to the parent's + /// processDialogKey() simply sends the character to the parent's /// processDialogKey() method, or returns false if the control has no /// parent. The Form class overrides this method to perform actual /// processing of dialog keys. - /// When overriding processDialogKey(), a control should return true to + /// When overriding processDialogKey(), a control should return true to /// indicate that it has processed the key. For keys that aren't processed /// by the control, the result of "base.processDialogKey(...)" should be /// returned. - /// Controls will seldom, if ever, need to override this method. + /// Controls will seldom, if ever, need to override this method. /// protected virtual bool ProcessDialogKey(Keys keyData) { @@ -9601,11 +9601,11 @@ protected virtual bool ProcessDialogKey(Keys keyData) /// onKeyUp(). The m parameter contains the window message that must /// be processed. Possible values for the m.msg field are WM_CHAR, /// WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, WM_SYSKEYUP, and WM_IMECHAR. - /// When overriding processKeyEventArgs(), a control should return true to + /// When overriding processKeyEventArgs(), a control should return true to /// indicate that it has processed the key. For keys that aren't processed /// by the control, the result of "base.processKeyEventArgs()" should be /// returned. - /// Controls will seldom, if ever, need to override this method. + /// Controls will seldom, if ever, need to override this method. /// protected virtual bool ProcessKeyEventArgs(ref Message m) { @@ -9696,11 +9696,11 @@ protected virtual bool ProcessKeyEventArgs(ref Message m) /// The m parameter contains the window message that must be /// processed. Possible values for the m.msg field are WM_CHAR, /// WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. - /// When overriding processKeyMessage(), a control should return true to + /// When overriding processKeyMessage(), a control should return true to /// indicate that it has processed the key. For keys that aren't processed /// by the control, the result of "base.processKeyMessage()" should be /// returned. - /// Controls will seldom, if ever, need to override this method. + /// Controls will seldom, if ever, need to override this method. /// protected internal virtual bool ProcessKeyMessage(ref Message m) { @@ -9722,11 +9722,11 @@ protected internal virtual bool ProcessKeyMessage(ref Message m) /// parameter contains the window message to preview. Possible values for /// the m.msg field are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, /// and WM_SYSKEYUP. - /// processKeyPreview() simply sends the character to the parent's + /// processKeyPreview() simply sends the character to the parent's /// processKeyPreview() method, or returns false if the control has no /// parent. The Form class overrides this method to perform actual /// processing of dialog keys. - /// When overriding processKeyPreview(), a control should return true to + /// When overriding processKeyPreview(), a control should return true to /// indicate that it has processed the key. For keys that aren't processed /// by the control, the result of "base.ProcessKeyPreview(...)" should be /// returned. @@ -9744,7 +9744,7 @@ protected virtual bool ProcessKeyPreview(ref Message m) /// character represents a mnemonic. If so, the method should perform the /// action associated with the mnemonic and return true. If not, the method /// should return false. - /// Implementations of this method often use the isMnemonic() method to + /// Implementations of this method often use the isMnemonic() method to /// check if the given character matches a mnemonic in the control's text, /// for example: /// @@ -9752,7 +9752,7 @@ protected virtual bool ProcessKeyPreview(ref Message m) /// // perform action associated with mnemonic /// } /// - /// This default implementation of processMnemonic() simply returns false + /// This default implementation of processMnemonic() simply returns false /// to indicate that the control has no mnemonic. /// protected internal virtual bool ProcessMnemonic(char charCode) @@ -10072,7 +10072,7 @@ internal virtual void RecreateHandleCore() } /// - /// Computes the location of the screen rectangle r in client coords. + /// Computes the location of the screen rectangle r in client coords. /// public Rectangle RectangleToClient(Rectangle r) { @@ -10082,7 +10082,7 @@ public Rectangle RectangleToClient(Rectangle r) } /// - /// Computes the location of the client rectangle r in screen coords. + /// Computes the location of the client rectangle r in screen coords. /// public Rectangle RectangleToScreen(Rectangle r) { @@ -10092,7 +10092,7 @@ public Rectangle RectangleToScreen(Rectangle r) } /// - /// Reflects the specified message to the control that is bound to hWnd. + /// Reflects the specified message to the control that is bound to hWnd. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected static bool ReflectMessage(IntPtr hWnd, ref Message m) @@ -10118,7 +10118,7 @@ public virtual void Refresh() } /// - /// /Releases UI Automation provinder for specified window. + /// /Releases UI Automation provinder for specified window. /// /// The window handle. internal virtual void ReleaseUiaProvider(IntPtr handle) @@ -10430,8 +10430,8 @@ internal void ScaleChildControls(SizeF includedFactor, SizeF excludedFactor, Con } /// - /// Calls SetWindowFont if DpiHelper.IsPerMonitorV2Awareness is true, - /// control uses default or inherited font and is not user-painted. + /// Calls SetWindowFont if DpiHelper.IsPerMonitorV2Awareness is true, + /// control uses default or inherited font and is not user-painted. /// internal void UpdateWindowFontIfNeeded() { @@ -11563,7 +11563,7 @@ internal bool ShouldSerializePadding() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal virtual bool ShouldSerializeSize() @@ -11575,7 +11575,7 @@ internal virtual bool ShouldSerializeSize() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal virtual bool ShouldSerializeText() @@ -13827,8 +13827,8 @@ void IArrangedElement.SetBounds(Rectangle bounds, BoundsSpecified specified) } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces /// internal virtual bool SupportsUiaProviders { @@ -13840,7 +13840,7 @@ internal virtual bool SupportsUiaProviders /// - /// Explicit support of DropTarget + /// Explicit support of DropTarget /// void IDropTarget.OnDragEnter(DragEventArgs drgEvent) { @@ -13863,7 +13863,7 @@ void IDropTarget.OnDragDrop(DragEventArgs drgEvent) } /// - /// Explicit support of DropSource + /// Explicit support of DropSource /// void ISupportOleDropSource.OnGiveFeedback(GiveFeedbackEventArgs giveFeedbackEventArgs) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlBindingsCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlBindingsCollection.cs index 90b146671c8..570e11349fe 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlBindingsCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlBindingsCollection.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Represents the collection of data bindings for a control. + /// Represents the collection of data bindings for a control. /// [DefaultEvent(nameof(CollectionChanged))] [Editor("System.Drawing.Design.UITypeEditor, " + AssemblyRef.SystemDrawing, typeof(UITypeEditor))] @@ -44,20 +44,20 @@ public Binding this[string propertyName] } /// - /// Adds the binding to the collection. An ArgumentNullException is thrown if this - /// binding is null. An exception is thrown if a binding to the same target and - /// Property as an existing binding or if the binding's column isn't a valid column - /// given this DataSource.Table's schema. - /// Fires the CollectionChangedEvent. + /// Adds the binding to the collection. An ArgumentNullException is thrown if this + /// binding is null. An exception is thrown if a binding to the same target and + /// Property as an existing binding or if the binding's column isn't a valid column + /// given this DataSource.Table's schema. + /// Fires the CollectionChangedEvent. /// public new void Add(Binding binding) => base.Add(binding); /// - /// Creates the binding and adds it to the collection. An InvalidBindingException is - /// thrown if this binding can't be constructed. An exception is thrown if a binding - /// to the same target and Property as an existing binding or if the binding's column - /// isn't a valid column given this DataSource.Table's schema. - /// Fires the CollectionChangedEvent. + /// Creates the binding and adds it to the collection. An InvalidBindingException is + /// thrown if this binding can't be constructed. An exception is thrown if a binding + /// to the same target and Property as an existing binding or if the binding's column + /// isn't a valid column given this DataSource.Table's schema. + /// Fires the CollectionChangedEvent. /// public Binding Add(string propertyName, object dataSource, string dataMember) { @@ -97,11 +97,11 @@ public Binding Add(string propertyName, object dataSource, string dataMember, bo } /// - /// Creates the binding and adds it to the collection. An InvalidBindingException is - /// thrown if this binding can't be constructed. An exception is thrown if a binding to - /// the same target and Property as an existing binding or if the binding's column isn't - /// a valid column given this DataSource.Table's schema. - /// Fires the CollectionChangedEvent. + /// Creates the binding and adds it to the collection. An InvalidBindingException is + /// thrown if this binding can't be constructed. An exception is thrown if a binding to + /// the same target and Property as an existing binding or if the binding's column isn't + /// a valid column given this DataSource.Table's schema. + /// Fires the CollectionChangedEvent. /// protected override void AddCore(Binding dataBinding) { @@ -140,8 +140,8 @@ internal void CheckDuplicates(Binding binding) } /// - /// Clears the collection of any bindings. - /// Fires the CollectionChangedEvent. + /// Clears the collection of any bindings. + /// Fires the CollectionChangedEvent. /// public new void Clear() => base.Clear(); @@ -160,17 +160,17 @@ protected override void ClearCore() public DataSourceUpdateMode DefaultDataSourceUpdateMode { get; set; } = DataSourceUpdateMode.OnValidation; /// - /// Removes the given binding from the collection. - /// An ArgumentNullException is thrown if this binding is null. An ArgumentException is - /// thrown if this binding doesn't belong to this collection. - /// The CollectionChanged event is fired if it succeeds. + /// Removes the given binding from the collection. + /// An ArgumentNullException is thrown if this binding is null. An ArgumentException is + /// thrown if this binding doesn't belong to this collection. + /// The CollectionChanged event is fired if it succeeds. /// public new void Remove(Binding binding) => base.Remove(binding); /// - /// Removes the given binding from the collection. - /// It throws an IndexOutOfRangeException if this doesn't have a valid binding. - /// The CollectionChanged event is fired if it succeeds. + /// Removes the given binding from the collection. + /// It throws an IndexOutOfRangeException if this doesn't have a valid binding. + /// The CollectionChanged event is fired if it succeeds. /// public new void RemoveAt(int index) => base.RemoveAt(index); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventArgs.cs index dbbd7770650..e180f43f54a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventArgs.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// A ControlEventArgs is an event that has a control as a property. + /// A ControlEventArgs is an event that has a control as a property. /// public class ControlEventArgs : EventArgs { /// - /// Creates a new ControlEventArgs. + /// Creates a new ControlEventArgs. /// public ControlEventArgs(Control control) { @@ -18,7 +18,7 @@ public ControlEventArgs(Control control) } /// - /// Retrieves the control object stored in this event. + /// Retrieves the control object stored in this event. /// public Control Control { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventHandler.cs index bb3894c6e03..0130350f8dc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Describes a delegate for an event that has a ControlEventArgs as - /// a parameter. + /// Describes a delegate for an event that has a ControlEventArgs as + /// a parameter. /// public delegate void ControlEventHandler(object sender, ControlEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlPaint.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlPaint.cs index 4fb1099fe50..0f94ce9c698 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlPaint.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlPaint.cs @@ -3068,7 +3068,7 @@ internal static TextFormatFlags CreateTextFormatFlags(Control ctl, ContentAlignm } /// - /// Logic copied from Windows sources to copy the lightening and darkening of colors. + /// Logic copied from Windows sources to copy the lightening and darkening of colors. /// private struct HLSColor { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlStyles.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlStyles.cs index d1c5b886b45..0ea70c16345 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlStyles.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlStyles.cs @@ -7,133 +7,133 @@ namespace System.Windows.Forms { /// - /// Specifies control functionality. + /// Specifies control functionality. /// [Flags] public enum ControlStyles { /// - /// Indicates whether the control is a container-like control. + /// Indicates whether the control is a container-like control. /// ContainerControl = 0x00000001, /// - /// The control paints itself; WM_PAINT and WM_ERASEBKGND messages are not - /// passed on to the underlying NativeWindow. - /// This style only applies to subclasses of Control. + /// The control paints itself; WM_PAINT and WM_ERASEBKGND messages are not + /// passed on to the underlying NativeWindow. + /// This style only applies to subclasses of Control. /// UserPaint = 0x00000002, /// - /// If specified, a PaintBackground event will not be raised, - /// OnPaintBackground will not be called, and Invalidate() will not - /// invalidate the background of the HWND. + /// If specified, a PaintBackground event will not be raised, + /// OnPaintBackground will not be called, and Invalidate() will not + /// invalidate the background of the HWND. /// Opaque = 0x00000004, /// - /// The control is completely redrawn when it is resized. + /// The control is completely redrawn when it is resized. /// ResizeRedraw = 0x00000010, /// - /// The control has a fixed width. + /// The control has a fixed width. /// FixedWidth = 0x00000020, /// - /// The control has a fixed height. + /// The control has a fixed height. /// FixedHeight = 0x00000040, /// - /// If set, windows forms calls OnClick and raises the Click event when the - /// control is clicked (unless it's the second click of a double-click and - /// StandardDoubleClick is specified). - /// Regardless of this style, the control may call OnClick directly. + /// If set, windows forms calls OnClick and raises the Click event when the + /// control is clicked (unless it's the second click of a double-click and + /// StandardDoubleClick is specified). + /// Regardless of this style, the control may call OnClick directly. /// StandardClick = 0x00000100, /// - /// The control can get the focus. + /// The control can get the focus. /// Selectable = 0x00000200, /// - /// The control does its own mouse processing; WM_MOUSEDOWN, WM_MOUSEMOVE, - /// and WM_MOUSEUP messages are not passed on to the underlying NativeWindow. + /// The control does its own mouse processing; WM_MOUSEDOWN, WM_MOUSEMOVE, + /// and WM_MOUSEUP messages are not passed on to the underlying NativeWindow. /// UserMouse = 0x00000400, /// - /// If the BackColor is set to a color whose alpha component is less than - /// 255 (i.e., BackColor.A is less than 255), OnPaintBackground will simulate - /// transparency by asking its parent control to paint our background. - /// This is not true transparency -- if there is another control between us - /// and our parent, we will not show the control in the middle. - /// This style only applies to subclasses of Control. It only works if - /// UserPaint is set, and the parent control is a Control. + /// If the BackColor is set to a color whose alpha component is less than + /// 255 (i.e., BackColor.A is less than 255), OnPaintBackground will simulate + /// transparency by asking its parent control to paint our background. + /// This is not true transparency -- if there is another control between us + /// and our parent, we will not show the control in the middle. + /// This style only applies to subclasses of Control. It only works if + /// UserPaint is set, and the parent control is a Control. /// SupportsTransparentBackColor = 0x00000800, /// - /// If set, windows forms calls OnDoubleClick and raises the DoubleClick - /// event when the control is double clicked. - /// Regardless of whether it is set, the control may call OnDoubleClick - /// directly. - /// This style is ignored if StandardClick is not set. + /// If set, windows forms calls OnDoubleClick and raises the DoubleClick + /// event when the control is double clicked. + /// Regardless of whether it is set, the control may call OnDoubleClick + /// directly. + /// This style is ignored if StandardClick is not set. /// StandardDoubleClick = 0x00001000, /// - /// If true, WM_ERASEBKGND is ignored, and both OnPaintBackground and - /// OnPaint are called directly from WM_PAINT. This generally reduces - /// flicker, but can cause problems if other controls send WM_ERASEBKGND - /// messages to us. (This is sometimes done to achieve a pseudo-transparent - /// effect similar to ControlStyles.SupportsTransparentBackColor; for instance, - /// ToolBar with flat appearance does this). - /// This style only makes sense if UserPaint is true. + /// If true, WM_ERASEBKGND is ignored, and both OnPaintBackground and + /// OnPaint are called directly from WM_PAINT. This generally reduces + /// flicker, but can cause problems if other controls send WM_ERASEBKGND + /// messages to us. (This is sometimes done to achieve a pseudo-transparent + /// effect similar to ControlStyles.SupportsTransparentBackColor; for instance, + /// ToolBar with flat appearance does this). + /// This style only makes sense if UserPaint is true. /// AllPaintingInWmPaint = 0x00002000, /// - /// If true, the control keeps a copy of the text rather than going to the - /// hWnd for the text every time. This improves performance but makes it - /// difficult to keep the control and hWnd's text synchronized. - /// This style defaults to false. + /// If true, the control keeps a copy of the text rather than going to the + /// hWnd for the text every time. This improves performance but makes it + /// difficult to keep the control and hWnd's text synchronized. + /// This style defaults to false. /// CacheText = 0x00004000, /// - /// If true, the OnNotifyMessage method will be called for every message - /// sent to the control's WndProc. - /// This style defaults to false. + /// If true, the OnNotifyMessage method will be called for every message + /// sent to the control's WndProc. + /// This style defaults to false. /// EnableNotifyMessage = 0x00008000, /// - /// If set, all control painting will be double buffered. You must also - /// set the UserPaint and AllPaintingInWmPaint style. Note: This is - /// obsolete, please - /// use OptimizedDoubleBuffer instead. + /// If set, all control painting will be double buffered. You must also + /// set the UserPaint and AllPaintingInWmPaint style. Note: This is + /// obsolete, please + /// use OptimizedDoubleBuffer instead. /// [EditorBrowsable(EditorBrowsableState.Never)] // It is recommended that you use the DoubleBuffer property instead. DoubleBuffer = 0x00010000, /// - /// If set, all control painting will be double buffered. + /// If set, all control painting will be double buffered. /// OptimizedDoubleBuffer = 0x00020000, /// - /// If this style is set, and there is a value in the control's Text property, - /// that value will be used to determine the control's default Active - /// Accessibility name and shortcut key. Otherwise, the text of the preceding - /// Label control will be used instead. + /// If this style is set, and there is a value in the control's Text property, + /// that value will be used to determine the control's default Active + /// Accessibility name and shortcut key. Otherwise, the text of the preceding + /// Label control will be used instead. /// - /// This style is set by default. Certain built-in control types such as - /// TextBox and ComboBox un-set this style, so that their current text will - /// not be used by Active Accessibility. + /// This style is set by default. Certain built-in control types such as + /// TextBox and ComboBox un-set this style, so that their current text will + /// not be used by Active Accessibility. /// UseTextForAccessibility = 0x00040000, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ControlUpdateMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ControlUpdateMode.cs index 073e993f011..0abc8777a8d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ControlUpdateMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ControlUpdateMode.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Determines when changes to a data source property get propagated up to - /// the corresponding data-bound control property. + /// Determines when changes to a data source property get propagated up to + /// the corresponding data-bound control property. /// public enum ControlUpdateMode { /// - /// Control property is updated whenever the data source property changes, or - /// the data source position changes. - /// This is the default update mode. + /// Control property is updated whenever the data source property changes, or + /// the data source position changes. + /// This is the default update mode. /// OnPropertyChanged = 0, /// - /// Control property is never updated. Binding is "write-only" with respect - /// to the data source. To force the control property to be updated, use - /// the Binding.ReadValue method. + /// Control property is never updated. Binding is "write-only" with respect + /// to the data source. To force the control property to be updated, use + /// the Binding.ReadValue method. /// Never = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CreateParams.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CreateParams.cs index d74ecef4d55..c2667cd4c31 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CreateParams.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CreateParams.cs @@ -9,64 +9,64 @@ namespace System.Windows.Forms public class CreateParams { /// - /// Name of the window class to subclass. The default value for this field - /// is null, indicating that the window is not a subclass of an existing - /// window class. To subclass an existing window class, store the window - /// class name in this field. For example, to subclass the standard edit - /// control, set this field to "EDIT". + /// Name of the window class to subclass. The default value for this field + /// is null, indicating that the window is not a subclass of an existing + /// window class. To subclass an existing window class, store the window + /// class name in this field. For example, to subclass the standard edit + /// control, set this field to "EDIT". /// public string ClassName { get; set; } /// - /// The initial caption your control will have. + /// The initial caption your control will have. /// public string Caption { get; set; } /// - /// Window style bits. This must be a combination of WS_XXX style flags and - /// other control-specific style flags. + /// Window style bits. This must be a combination of WS_XXX style flags and + /// other control-specific style flags. /// public int Style { get; set; } /// - /// Extended window style bits. This must be a combination of WS_EX_XXX - /// style flags. + /// Extended window style bits. This must be a combination of WS_EX_XXX + /// style flags. /// public int ExStyle { get; set; } /// - /// Class style bits. This must be a combination of CS_XXX style flags. This - /// field is ignored if the className field is not null. + /// Class style bits. This must be a combination of CS_XXX style flags. This + /// field is ignored if the className field is not null. /// public int ClassStyle { get; set; } /// - /// The left portion of the initial proposed location. + /// The left portion of the initial proposed location. /// public int X { get; set; } /// - /// The top portion of the initial proposed location. + /// The top portion of the initial proposed location. /// public int Y { get; set; } /// - /// The initially proposed width. + /// The initially proposed width. /// public int Width { get; set; } /// - /// The initially proposed height. + /// The initially proposed height. /// public int Height { get; set; } /// - /// The controls parent. + /// The controls parent. /// public IntPtr Parent { get; set; } /// - /// Any extra information that the underlying handle might want. + /// Any extra information that the underlying handle might want. /// public object Param { get; set; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/CurrencyManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/CurrencyManager.cs index 1f190d8ba82..f3aadfb5806 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/CurrencyManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/CurrencyManager.cs @@ -564,7 +564,7 @@ internal void SetSort(PropertyDescriptor property, ListSortDirection sortDirecti } /// - /// Gets a for a CurrencyManager. + /// Gets a for a CurrencyManager. /// internal PropertyDescriptor GetSortProperty() { @@ -652,7 +652,7 @@ internal override PropertyDescriptorCollection GetItemProperties(PropertyDescrip } /// - /// Gets the for + /// Gets the for /// the list. /// public override PropertyDescriptorCollection GetItemProperties() @@ -661,7 +661,7 @@ public override PropertyDescriptorCollection GetItemProperties() } /// - /// Gets the for the specified list. + /// Gets the for the specified list. /// private void List_ListChanged(object sender, ListChangedEventArgs e) { @@ -878,7 +878,7 @@ public event EventHandler MetaDataChanged } /// - /// Causes the CurrentChanged event to occur. + /// Causes the CurrentChanged event to occur. /// internal protected override void OnCurrentChanged(EventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Cursor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Cursor.cs index 146717a358c..2da2bbd6b87 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Cursor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Cursor.cs @@ -291,7 +291,7 @@ public IntPtr CopyHandle() /// /// Destroys the Win32 handle of this , if the /// - /// owns the handle + /// owns the handle /// private void DestroyHandle() { @@ -468,7 +468,7 @@ public void DrawStretched(Graphics g, Rectangle targetRect) } /// - /// ISerializable private implementation + /// ISerializable private implementation /// void ISerializable.GetObjectData(SerializationInfo si, StreamingContext context) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataFormats.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataFormats.cs index b18c78c78d6..9bf9d59a5da 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataFormats.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataFormats.cs @@ -9,139 +9,139 @@ namespace System.Windows.Forms { /// - /// Translates between WinForms text-based - /// formats and 32-bit signed integer-based clipboard - /// formats. Provides methods to create new + /// Translates between WinForms text-based + /// formats and 32-bit signed integer-based clipboard + /// formats. Provides methods to create new /// formats and add them to the Windows Registry. /// public static class DataFormats { /// - /// Specifies the standard ANSI text format. This - /// field is read-only. + /// Specifies the standard ANSI text format. This + /// field is read-only. /// public static readonly string Text = "Text"; /// - /// Specifies the standard Windows Unicode text format. - /// This field is read-only. + /// Specifies the standard Windows Unicode text format. + /// This field is read-only. /// public static readonly string UnicodeText = "UnicodeText"; /// - /// Specifies the Windows Device Independent Bitmap (DIB) format. - /// This field is read-only. + /// Specifies the Windows Device Independent Bitmap (DIB) format. + /// This field is read-only. /// public static readonly string Dib = "DeviceIndependentBitmap"; /// - /// Specifies a Windows bitmap format. - /// This field is read-only. + /// Specifies a Windows bitmap format. + /// This field is read-only. public static readonly string Bitmap = "Bitmap"; /// - /// Specifies the Windows enhanced metafile format. - /// This field is read-only. + /// Specifies the Windows enhanced metafile format. + /// This field is read-only. /// public static readonly string EnhancedMetafile = "EnhancedMetafile"; /// - /// Specifies the Windows metafile format, which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Windows metafile format, which WinForms does not directly use. + /// This field is read-only. /// public static readonly string MetafilePict = "MetaFilePict"; /// - /// Specifies the Windows symbolic link format, which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Windows symbolic link format, which WinForms does not directly use. + /// This field is read-only. /// public static readonly string SymbolicLink = "SymbolicLink"; /// - /// Specifies the Windows data interchange format, which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Windows data interchange format, which WinForms does not directly use. + /// This field is read-only. /// public static readonly string Dif = "DataInterchangeFormat"; /// - /// Specifies the Tagged Image File Format (TIFF), which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Tagged Image File Format (TIFF), which WinForms does not directly use. + /// This field is read-only. /// public static readonly string Tiff = "TaggedImageFileFormat"; /// - /// Specifies the standard Windows original equipment manufacturer (OEM) text format. - /// This field is read-only. + /// Specifies the standard Windows original equipment manufacturer (OEM) text format. + /// This field is read-only. /// public static readonly string OemText = "OEMText"; /// - /// Specifies the Windows palette format. - /// This field is read-only. + /// Specifies the Windows palette format. + /// This field is read-only. /// public static readonly string Palette = "Palette"; /// - /// Specifies the Windows pen data format, which consists of pen strokes for handwriting - /// software; Win Formsdoes not use this format. - /// This field is read-only. + /// Specifies the Windows pen data format, which consists of pen strokes for handwriting + /// software; Win Formsdoes not use this format. + /// This field is read-only. /// public static readonly string PenData = "PenData"; /// - /// Specifies the Resource Interchange File Format (RIFF) audio format, which WinForms - /// does not directly use. - /// This field is read-only. + /// Specifies the Resource Interchange File Format (RIFF) audio format, which WinForms + /// does not directly use. + /// This field is read-only. /// public static readonly string Riff = "RiffAudio"; /// - /// Specifies the wave audio format, which Win Forms does not + /// Specifies the wave audio format, which Win Forms does not /// directly use. This field is read-only. /// public static readonly string WaveAudio = "WaveAudio"; /// - /// Specifies the Windows file drop format, which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Windows file drop format, which WinForms does not directly use. + /// This field is read-only. /// public static readonly string FileDrop = "FileDrop"; /// - /// Specifies the Windows culture format, which WinForms does not directly use. - /// This field is read-only. + /// Specifies the Windows culture format, which WinForms does not directly use. + /// This field is read-only. /// public static readonly string Locale = "Locale"; /// - /// Specifies text consisting of HTML data. - /// This field is read-only. + /// Specifies text consisting of HTML data. + /// This field is read-only. /// public static readonly string Html = "HTML Format"; /// - /// Specifies text consisting of Rich Text Format (RTF) data. - /// This field is read-only. + /// Specifies text consisting of Rich Text Format (RTF) data. + /// This field is read-only. /// public static readonly string Rtf = "Rich Text Format"; /// - /// Specifies a comma-separated value (CSV) format, which is a common interchange format - /// used by spreadsheets. This format is not used directly by WinForms. - /// This field is read-only. + /// Specifies a comma-separated value (CSV) format, which is a common interchange format + /// used by spreadsheets. This format is not used directly by WinForms. + /// This field is read-only. /// public static readonly string CommaSeparatedValue = "Csv"; /// - /// Specifies the Win Forms string class format, which WinForms uses to store string - /// objects. - /// This field is read-only. + /// Specifies the Win Forms string class format, which WinForms uses to store string + /// objects. + /// This field is read-only. /// public static readonly string StringFormat = typeof(string).FullName; /// - /// Specifies a format that encapsulates any type of WinForms object. - /// This field is read-only. + /// Specifies a format that encapsulates any type of WinForms object. + /// This field is read-only. /// public static readonly string Serializable = Application.WindowsFormsVersion + "PersistentObject"; @@ -151,8 +151,8 @@ public static class DataFormats private static readonly object s_internalSyncObject = new object(); /// - /// Gets a with the Windows - /// Clipboard numeric ID and name for the specified format. + /// Gets a with the Windows + /// Clipboard numeric ID and name for the specified format. /// public static Format GetFormat(string format) { @@ -192,8 +192,8 @@ public static Format GetFormat(string format) } /// - /// Gets a with the Windows - /// Clipboard numeric ID and name for the specified ID. + /// Gets a with the Windows + /// Clipboard numeric ID and name for the specified ID. /// public static Format GetFormat(int id) { @@ -235,7 +235,7 @@ public static Format GetFormat(int id) } /// - /// Ensures that we have enough room in our format list + /// Ensures that we have enough room in our format list /// private static void EnsureFormatSpace(int size) { @@ -254,8 +254,8 @@ private static void EnsureFormatSpace(int size) } /// - /// Ensures that the Win32 predefined formats are setup in our format list. - /// This is called anytime we need to search the list + /// Ensures that the Win32 predefined formats are setup in our format list. + /// This is called anytime we need to search the list /// private static void EnsurePredefined() { @@ -287,13 +287,13 @@ private static void EnsurePredefined() } /// - /// Represents a format type. + /// Represents a format type. /// public class Format { /// - /// Initializes a new instance of the - /// class and specifies whether a handle is expected with this format. + /// Initializes a new instance of the + /// class and specifies whether a handle is expected with this format. /// public Format(string name, int id) { @@ -302,12 +302,12 @@ public Format(string name, int id) } /// - /// Specifies the name of this format. + /// Specifies the name of this format. /// public string Name { get; } /// - /// Specifies the ID number for this format. + /// Specifies the ID number for this format. /// public int Id { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGrid.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGrid.cs index 5c90647427e..8034aa42142 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGrid.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGrid.cs @@ -306,8 +306,8 @@ public class DataGrid : Control, ISupportInitialize, IDataGridEditingService // =----------------------------------------------------------------- /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public DataGrid() : base() { @@ -1379,7 +1379,7 @@ internal override bool ShouldSerializeForeColor() } /// - /// Indicates whether the property should be + /// Indicates whether the property should be /// persisted. /// internal override bool ShouldSerializeBackColor() @@ -3248,7 +3248,7 @@ public int VisibleRowCount } /// - /// Gets or sets the value of a specified . + /// Gets or sets the value of a specified . /// public object this[DataGridCell cell] { @@ -3772,7 +3772,7 @@ internal void OnNodeClick(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected void OnRowHeaderClick(EventArgs e) { @@ -4180,8 +4180,8 @@ protected override void OnHandleDestroyed(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected override void OnEnter(EventArgs e) { @@ -4196,8 +4196,8 @@ protected override void OnEnter(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected override void OnLeave(EventArgs e) { @@ -4254,7 +4254,7 @@ protected override void OnKeyDown(KeyEventArgs ke) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnKeyPress(KeyPressEventArgs kpe) { @@ -4275,7 +4275,7 @@ protected override void OnKeyPress(KeyPressEventArgs kpe) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -4481,8 +4481,8 @@ protected override void OnMouseDown(MouseEventArgs e) } /// - /// Creates the - /// event. + /// Creates the + /// event. /// protected override void OnMouseLeave(EventArgs e) { @@ -4506,8 +4506,8 @@ internal void TextBoxOnMouseWheel(MouseEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected override void OnMouseMove(MouseEventArgs e) { @@ -4626,7 +4626,7 @@ protected override void OnMouseMove(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseUp(MouseEventArgs e) { @@ -4670,7 +4670,7 @@ protected override void OnMouseUp(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseWheel(MouseEventArgs e) { @@ -4730,8 +4730,8 @@ protected override void OnMouseWheel(MouseEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected override void OnPaint(PaintEventArgs pe) { @@ -4817,7 +4817,7 @@ protected override void OnPaint(PaintEventArgs pe) // Since Win32 only invalidates the area that gets uncovered, // we have to manually invalidate the old border area /// - /// Raises the event. + /// Raises the event. /// protected override void OnResize(EventArgs e) { @@ -7059,8 +7059,8 @@ private void EnsureVisible(int row, int col) } /// - /// Gets a - /// that specifies the four corners of the selected cell. + /// Gets a + /// that specifies the four corners of the selected cell. /// public Rectangle GetCurrentCellBounds() { @@ -7069,7 +7069,7 @@ public Rectangle GetCurrentCellBounds() } /// - /// Gets the of the cell specified by row and column number. + /// Gets the of the cell specified by row and column number. /// public Rectangle GetCellBounds(int row, int col) { @@ -7082,7 +7082,7 @@ public Rectangle GetCellBounds(int row, int col) } /// - /// Gets the of the cell specified by . + /// Gets the of the cell specified by . /// public Rectangle GetCellBounds(DataGridCell dgc) { @@ -10415,7 +10415,7 @@ public sealed class HitTestInfo internal int col; /// - /// Allows the object to inform you the + /// Allows the object to inform you the /// extent of the grid. /// public static readonly HitTestInfo Nowhere = new HitTestInfo(); @@ -10456,7 +10456,7 @@ public int Row } /// - /// Gets the part of the control, other than the row or column, that was + /// Gets the part of the control, other than the row or column, that was /// clicked. /// public HitTestType Type @@ -10482,7 +10482,7 @@ public override bool Equals(object value) } /// - /// Gets the hash code for the instance. + /// Gets the hash code for the instance. /// public override int GetHashCode() => HashCode.Combine(type, row, col); @@ -10496,8 +10496,8 @@ public override string ToString() } /// - /// Specifies the part of the - /// control the user has clicked.< + /// Specifies the part of the + /// control the user has clicked.< /// [Flags] public enum HitTestType diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridBoolColumn.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridBoolColumn.cs index 48faf319bfe..546335eb109 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridBoolColumn.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridBoolColumn.cs @@ -32,12 +32,12 @@ public class DataGridBoolColumn : DataGridColumnStyle private static readonly object EventAllowNull = new object(); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridBoolColumn() : base() { } /// - /// Initializes a new instance of a with the specified . + /// Initializes a new instance of a with the specified . /// public DataGridBoolColumn(PropertyDescriptor prop) : base(prop) { } @@ -353,8 +353,8 @@ private void OnAllowNullChanged(EventArgs e) } /// - /// Draws the - /// with the given , + /// Draws the + /// with the given , /// and row number. /// protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum) @@ -363,9 +363,9 @@ protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyMan } /// - /// Draws the - /// with the given , , - /// row number, and alignment settings. + /// Draws the + /// with the given , , + /// row number, and alignment settings. /// protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, bool alignToRight) { @@ -373,7 +373,7 @@ protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyMan } /// - /// Draws the with the given , , + /// Draws the with the given , , /// row number, , and . /// protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, @@ -466,7 +466,7 @@ public event EventHandler AllowNullChanged } /// - /// Enters a into the column. + /// Enters a into the column. /// protected internal override void EnterNullValue() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridCell.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridCell.cs index 9afefe9ffac..448f34fd09a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridCell.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridCell.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Identifies a cell in the grid. + /// Identifies a cell in the grid. /// public struct DataGridCell { /// - /// Gets or sets the number of a column in the control. + /// Gets or sets the number of a column in the control. /// public int ColumnNumber { get; set; } /// - /// Gets or sets the number of a row in the control. + /// Gets or sets the number of a row in the control. /// public int RowNumber { get; set; } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridCell(int r, int c) { @@ -29,8 +29,8 @@ public DataGridCell(int r, int c) } /// - /// Gets a value indicating whether the is - /// identical to a second . + /// Gets a value indicating whether the is + /// identical to a second . /// public override bool Equals(object o) { @@ -43,12 +43,12 @@ public override bool Equals(object o) } /// - /// Gets a hash value that uniquely identifies the cell. + /// Gets a hash value that uniquely identifies the cell. /// public override int GetHashCode() => HashCode.Combine(RowNumber, ColumnNumber); /// - /// Gets the row number and column number of the cell. + /// Gets the row number and column number of the cell. /// public override string ToString() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnCollection.cs index 40cf25b01d8..139a6273713 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnCollection.cs @@ -11,8 +11,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of System.Windows.Forms.DataGridColumnStyle objects in the - /// control. + /// Represents a collection of System.Windows.Forms.DataGridColumnStyle objects in the + /// control. /// [ Editor("System.Windows.Forms.Design.DataGridColumnCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)), @@ -136,14 +136,14 @@ protected override ArrayList List /// property to determine how many System.Windows.Forms.DataGridColumnStyle objects are in a System.Windows.Forms.GridColumnsStyleCollection, and uses that number to iterate through the /// collection. /// - /// Private Sub PrintGridColumns() + /// Private Sub PrintGridColumns() /// Dim colsCount As Integer /// colsCount = DataGrid1.GridColumns.Count /// Dim i As Integer /// For i = 0 to colsCount - 1 /// Debug.Print DataGrid1.GridColumns(i).GetType.ToString /// Next i - /// End Sub + /// End Sub /// /// /// @@ -156,7 +156,7 @@ public override int Count { */ /// - /// Gets the System.Windows.Forms.DataGridColumnStyle at a specified index. + /// Gets the System.Windows.Forms.DataGridColumnStyle at a specified index. /// public DataGridColumnStyle this[int index] { @@ -167,8 +167,8 @@ public DataGridColumnStyle this[int index] } /// - /// Gets the System.Windows.Forms.DataGridColumnStyle - /// with the specified name. + /// Gets the System.Windows.Forms.DataGridColumnStyle + /// with the specified name. /// public DataGridColumnStyle this[string columnName] { @@ -204,7 +204,7 @@ internal DataGridColumnStyle MapColumnStyleToPropertyName(string mappingName) } /// - /// Gets the System.Windows.Forms.DataGridColumnStyle associated with the + /// Gets the System.Windows.Forms.DataGridColumnStyle associated with the /// specified . /// public DataGridColumnStyle this[PropertyDescriptor propertyDesciptor] @@ -233,7 +233,7 @@ internal DataGridTableStyle DataGridTableStyle } /// - /// Adds a System.Windows.Forms.DataGridColumnStyle to the System.Windows.Forms.GridColumnStylesCollection + /// Adds a System.Windows.Forms.DataGridColumnStyle to the System.Windows.Forms.GridColumnStylesCollection /// internal void CheckForMappingNameDuplicates(DataGridColumnStyle column) { @@ -326,7 +326,7 @@ internal void ResetDefaultColumnCollection() } /// - /// Occurs when a change is made to the System.Windows.Forms.GridColumnStylesCollection. + /// Occurs when a change is made to the System.Windows.Forms.GridColumnStylesCollection. /// public event CollectionChangeEventHandler CollectionChanged { @@ -396,7 +396,7 @@ public bool Contains(string name) /// of each /// associated with the object. /// - /// Private Sub EnumerateThroughGridColumns() + /// Private Sub EnumerateThroughGridColumns() /// Dim ie As System.Collections.IEnumerator /// Dim dgCol As DataGridColumn /// Set ie = DataGrid1.GridColumns.GetEnumerator @@ -404,7 +404,7 @@ public bool Contains(string name) /// Set dgCol = ie.GetObject /// Debug.Print dgCol.DataColumn.Caption /// Loop - /// End Sub + /// End Sub /// /// /// @@ -420,7 +420,7 @@ public override IEnumerator GetEnumerator() { /// . /// /// - /// A value that indicates if the enumerator can remove elements. , if removals are allowed; otherwise, . The default is . + /// A value that indicates if the enumerator can remove elements. , if removals are allowed; otherwise, . The default is . /// /// /// An that can be used to iterate through the @@ -438,7 +438,7 @@ public override IEnumerator GetEnumerator() { /// /// The following example gets an for that iterates through the System.Windows.Forms.GridColumnsStyleCollection. If a column in the collection is of type , it is deleted. /// - /// Private Sub RemoveBoolColumns() + /// Private Sub RemoveBoolColumns() /// Dim ie As System.Collections.IEnumerator /// Dim dgCol As DataGridColumn /// Set ie = DataGrid1.GridColumns.GetEnumerator(true) @@ -449,7 +449,7 @@ public override IEnumerator GetEnumerator() { /// DataGrid1.GridColumns.Remove dgCol /// End If /// Loop - /// End If + /// End If /// /// /// @@ -465,7 +465,7 @@ public override IEnumerator GetEnumerator(bool allowRemove) { */ /// - /// Gets the index of a specified System.Windows.Forms.DataGridColumnStyle. + /// Gets the index of a specified System.Windows.Forms.DataGridColumnStyle. /// public int IndexOf(DataGridColumnStyle element) { @@ -482,7 +482,7 @@ public int IndexOf(DataGridColumnStyle element) } /// - /// Raises the System.Windows.Forms.GridColumnsCollection.CollectionChanged event. + /// Raises the System.Windows.Forms.GridColumnsCollection.CollectionChanged event. /// protected void OnCollectionChanged(CollectionChangeEventArgs e) { @@ -496,7 +496,7 @@ protected void OnCollectionChanged(CollectionChangeEventArgs e) } /// - /// Removes the specified System.Windows.Forms.DataGridColumnStyle from the System.Windows.Forms.GridColumnsStyleCollection. + /// Removes the specified System.Windows.Forms.DataGridColumnStyle from the System.Windows.Forms.GridColumnsStyleCollection. /// public void Remove(DataGridColumnStyle column) { @@ -527,7 +527,7 @@ public void Remove(DataGridColumnStyle column) } /// - /// Removes the System.Windows.Forms.DataGridColumnStyle with the specified index from the System.Windows.Forms.GridColumnsStyleCollection. + /// Removes the System.Windows.Forms.DataGridColumnStyle with the specified index from the System.Windows.Forms.GridColumnsStyleCollection. /// public void RemoveAt(int index) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnStyle.cs index 42f782a64d4..c562ba8d7ef 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridColumnStyle.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// Specifies the appearance and text formatting and behavior of a control column. + /// Specifies the appearance and text formatting and behavior of a control column. /// [ToolboxItem(false)] [DesignTimeVisible(false)] @@ -40,7 +40,7 @@ public abstract class DataGridColumnStyle : Component, IDataGridColumnStyleEditi private static readonly object s_widthEvent = new object(); /// - /// In a derived class, initializes a new instance of the + /// In a derived class, initializes a new instance of the /// class. /// public DataGridColumnStyle() @@ -48,8 +48,8 @@ public DataGridColumnStyle() } /// - /// Initializes a new instance of the - /// class with the specified . + /// Initializes a new instance of the + /// class with the specified . /// public DataGridColumnStyle(PropertyDescriptor prop) : this() { @@ -78,7 +78,7 @@ private protected DataGridColumnStyle(PropertyDescriptor prop, bool isDefault) : #endif /// - /// Gets or sets the alignment of text in a column. + /// Gets or sets the alignment of text in a column. /// [SRCategory(nameof(SR.CatDisplay))] [Localizable(true)] @@ -109,15 +109,15 @@ public event EventHandler AlignmentChanged } /// - /// When overridden in a derived class, updates the value of a specified row with - /// the given text. + /// When overridden in a derived class, updates the value of a specified row with + /// the given text. /// protected internal virtual void UpdateUI(CurrencyManager source, int rowNum, string displayText) { } /// - /// Gets or sets the background color of the column. + /// Gets or sets the background color of the column. /// [Browsable(false)] public AccessibleObject HeaderAccessibleObject @@ -126,8 +126,8 @@ public AccessibleObject HeaderAccessibleObject } /// - /// Gets or sets the that determines the - /// attributes of data displayed by the . + /// Gets or sets the that determines the + /// attributes of data displayed by the . /// [DefaultValue(null)] [Browsable(false)] @@ -158,8 +158,8 @@ protected virtual AccessibleObject CreateHeaderAccessibleObject() } /// - /// When overridden in a derived class, sets the - /// control that this column belongs to. + /// When overridden in a derived class, sets the + /// control that this column belongs to. /// protected virtual void SetDataGrid(DataGrid value) { @@ -167,8 +167,8 @@ protected virtual void SetDataGrid(DataGrid value) } /// - /// When overridden in a derived class, sets the - /// for the column. + /// When overridden in a derived class, sets the + /// for the column. /// protected virtual void SetDataGridInColumn(DataGrid value) { @@ -206,7 +206,7 @@ internal void SetDataGridInternalInColumn(DataGrid value) } /// - /// Gets the System.Windows.Forms.DataGridTableStyle for the column. + /// Gets the System.Windows.Forms.DataGridTableStyle for the column. /// [Browsable(false)] public virtual DataGridTableStyle DataGridTableStyle => _dataGridTableStyle; @@ -227,7 +227,7 @@ internal void SetDataGridTableInColumn(DataGridTableStyle value, bool force) } /// - /// Gets the height of the column's font. + /// Gets the height of the column's font. /// protected int FontHeight { @@ -235,7 +235,7 @@ protected int FontHeight } /// - /// Indicates whether the Font property should be persisted. + /// Indicates whether the Font property should be persisted. /// private bool ShouldSerializeFont() => _font != null; @@ -246,7 +246,7 @@ public event EventHandler FontChanged } /// - /// Gets or sets the text of the column header. + /// Gets or sets the text of the column header. /// [Localizable(true)] [SRCategory(nameof(SR.CatDisplay))] @@ -318,8 +318,8 @@ public event EventHandler MappingNameChanged } /// - /// Indicates whether the System.Windows.Forms.DataGridColumnStyle.HeaderText property - /// should be persisted. + /// Indicates whether the System.Windows.Forms.DataGridColumnStyle.HeaderText property + /// should be persisted. /// private bool ShouldSerializeHeaderText() { @@ -327,13 +327,13 @@ private bool ShouldSerializeHeaderText() } /// - /// Resets the System.Windows.Forms.DataGridColumnStyle.HeaderText to its default value. + /// Resets the System.Windows.Forms.DataGridColumnStyle.HeaderText to its default value. /// public void ResetHeaderText() => HeaderText = string.Empty; /// - /// Gets or sets the text that is displayed when the column contains a null - /// value. + /// Gets or sets the text that is displayed when the column contains a null + /// value. /// [Localizable(true)] [SRCategory(nameof(SR.CatDisplay))] @@ -358,7 +358,7 @@ public event EventHandler NullTextChanged } /// - /// Gets or sets a value indicating whether the data in the column cannot be edited. + /// Gets or sets a value indicating whether the data in the column cannot be edited. /// [DefaultValue(false)] public virtual bool ReadOnly @@ -381,7 +381,7 @@ public event EventHandler ReadOnlyChanged } /// - /// Gets or sets the width of the column. + /// Gets or sets the width of the column. /// [SRCategory(nameof(SR.CatLayout))] [Localizable(true)] @@ -416,13 +416,13 @@ public event EventHandler WidthChanged } /// - /// Suspends the painting of the column until the - /// method is called. + /// Suspends the painting of the column until the + /// method is called. /// protected void BeginUpdate() => _updating = true; /// - /// Resumes the painting of columns suspended by calling the + /// Resumes the painting of columns suspended by calling the /// method. /// protected void EndUpdate() @@ -442,24 +442,24 @@ protected void EndUpdate() private bool ShouldSerializeNullText() => !SR.DataGridNullText.Equals(_nullText); /// - /// When overridden in a derived class, gets the optimum width and height of the - /// specified value. + /// When overridden in a derived class, gets the optimum width and height of the + /// specified value. /// protected internal abstract Size GetPreferredSize(Graphics g, object value); /// - /// Gets the minimum height of a row. + /// Gets the minimum height of a row. /// protected internal abstract int GetMinimumHeight(); /// - /// When overridden in a derived class, gets the height to be used in for - /// automatically resizing columns. + /// When overridden in a derived class, gets the height to be used in for + /// automatically resizing columns. /// protected internal abstract int GetPreferredHeight(Graphics g, object value); /// - /// Gets the value in the specified row from the specified System.Windows.Forms.ListManager. + /// Gets the value in the specified row from the specified System.Windows.Forms.ListManager. /// protected internal virtual object GetColumnValueAtRow(CurrencyManager source, int rowNum) { @@ -474,7 +474,7 @@ protected internal virtual object GetColumnValueAtRow(CurrencyManager source, in } /// - /// Redraws the column and causes a paint message to be sent to the control. + /// Redraws the column and causes a paint message to be sent to the control. /// protected virtual void Invalidate() { @@ -488,7 +488,7 @@ protected virtual void Invalidate() } /// - /// Checks if the specified DataView is valid. + /// Checks if the specified DataView is valid. /// protected void CheckValidDataSource(CurrencyManager value) { @@ -508,19 +508,19 @@ protected void CheckValidDataSource(CurrencyManager value) } /// - /// When overridden in a derived class, initiates a request to interrrupt an edit - /// procedure. + /// When overridden in a derived class, initiates a request to interrrupt an edit + /// procedure. /// protected internal abstract void Abort(int rowNum); /// - /// When overridden in a derived class, inititates a request to complete an - /// editing procedure. + /// When overridden in a derived class, inititates a request to complete an + /// editing procedure. /// protected internal abstract bool Commit(CurrencyManager dataSource, int rowNum); /// - /// When overridden in a deriving class, prepares a cell for editing. + /// When overridden in a deriving class, prepares a cell for editing. /// protected internal virtual void Edit(CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly) { @@ -528,9 +528,9 @@ protected internal virtual void Edit(CurrencyManager source, int rowNum, Rectang } /// - /// Prepares the cell for editing, passing the specified , - /// row number, , argument indicating whether - /// the column is read-only, and the text to display in the new control. + /// Prepares the cell for editing, passing the specified , + /// row number, , argument indicating whether + /// the column is read-only, and the text to display in the new control. /// protected internal virtual void Edit(CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly, string displayText) { @@ -538,13 +538,13 @@ protected internal virtual void Edit(CurrencyManager source, int rowNum, Rectang } /// - /// When overridden in a deriving class, prepares a cell for editing. + /// When overridden in a deriving class, prepares a cell for editing. /// protected internal abstract void Edit(CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly, string displayText, bool cellIsVisible); /// - /// Indicates whether the a mouse down event occurred at the specified row, at - /// the specified x and y coordinates. + /// Indicates whether the a mouse down event occurred at the specified row, at + /// the specified x and y coordinates. /// internal virtual bool MouseDown(int rowNum, int x, int y) { @@ -552,16 +552,16 @@ internal virtual bool MouseDown(int rowNum, int x, int y) } /// - /// When overriden in a derived class, enters a - /// into the column. + /// When overriden in a derived class, enters a + /// into the column. /// protected internal virtual void EnterNullValue() { } /// - /// Provides a handler for determining which key was pressed, and whether to - /// process it. + /// Provides a handler for determining which key was pressed, and whether to + /// process it. /// internal virtual bool KeyPress(int rowNum, Keys keyData) { @@ -580,29 +580,29 @@ internal virtual bool KeyPress(int rowNum, Keys keyData) } /// - /// When overridden in a derived class, directs the column to concede focus with - /// an appropriate action. + /// When overridden in a derived class, directs the column to concede focus with + /// an appropriate action. /// protected internal virtual void ConcedeFocus() { } /// - /// Paints the a with the specified + /// Paints the a with the specified /// , , - /// System.Windows.Forms.CurrencyManager, and row number. + /// System.Windows.Forms.CurrencyManager, and row number. /// protected internal abstract void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum); /// - /// When overridden in a derived class, paints a - /// with the specified , , - /// see Rectangle, row number, and alignment. + /// When overridden in a derived class, paints a + /// with the specified , , + /// see Rectangle, row number, and alignment. /// protected internal abstract void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, bool alignToRight); /// - /// Paints a with the specified , , see System.Data.DataView, row number, background color, foreground color, and alignment. + /// Paints a with the specified , , see System.Data.DataView, row number, background color, foreground color, and alignment. /// protected internal virtual void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, Brush backBrush, Brush foreBrush, bool alignToRight) @@ -653,7 +653,7 @@ private void OnWidthChanged(EventArgs e) } /// - /// Sets the value in a specified row with the value from a specified see DataView. + /// Sets the value in a specified row with the value from a specified see DataView. /// protected internal virtual void SetColumnValueAtRow(CurrencyManager source, int rowNum, object value) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridLineStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridLineStyle.cs index 765a67a8e98..84d9184fa47 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridLineStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridLineStyle.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Specifies the style of gridlines in a . + /// Specifies the style of gridlines in a . /// public enum DataGridLineStyle { /// - /// No gridlines between cells. + /// No gridlines between cells. /// None, /// - /// Solid gridlines between cells. + /// Solid gridlines between cells. /// Solid } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridParentRowsLabel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridParentRowsLabel.cs index c948daea82b..210192dc28d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridParentRowsLabel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridParentRowsLabel.cs @@ -5,29 +5,29 @@ namespace System.Windows.Forms { /// - /// Specifies how parent row labels of a DataGrid - /// control are displayed. + /// Specifies how parent row labels of a DataGrid + /// control are displayed. /// public enum DataGridParentRowsLabelStyle { /// - /// Display no parent row labels. + /// Display no parent row labels. /// None = 0, /// - /// Displaya the parent table name. + /// Displaya the parent table name. /// TableName = 1, /// - /// Displaya the parent column name. + /// Displaya the parent column name. /// ColumnName = 2, /// - /// Displays - /// both the parent table and column names. + /// Displays + /// both the parent table and column names. /// Both = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridRow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridRow.cs index 1c0684dc865..d9b7ddcb25e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridRow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridRow.cs @@ -48,7 +48,7 @@ internal abstract class DataGridRow : MarshalByRefObject protected const int yOffset = 2; /// - /// Initializes a new instance of a . + /// Initializes a new instance of a . /// public DataGridRow(DataGrid dataGrid, DataGridTableStyle dgTable, int rowNumber) { @@ -125,7 +125,7 @@ internal protected virtual int MinimumRowHeight(GridColumnStylesCollection colum // =------------------------------------------------------------------ /// - /// Gets the control the row belongs to. + /// Gets the control the row belongs to. /// public DataGrid DataGrid { @@ -234,8 +234,8 @@ protected Bitmap GetBitmap(string bitmapName) } /// - /// When overridden in a derived class, gets the - /// where a cell's contents gets painted. + /// When overridden in a derived class, gets the + /// where a cell's contents gets painted. /// public virtual Rectangle GetCellBounds(int col) { @@ -263,7 +263,7 @@ public virtual Rectangle GetCellBounds(int col) } /// - /// When overridden in a derived class, gets the of the non-scrollable area of + /// When overridden in a derived class, gets the of the non-scrollable area of /// the row. /// public virtual Rectangle GetNonScrollableArea() @@ -350,7 +350,7 @@ public virtual void OnEdit() } /// - /// When overridden in a derived class, called by the control when a key press occurs on a row with focus. + /// When overridden in a derived class, called by the control when a key press occurs on a row with focus. /// public virtual bool OnKeyPress(Keys keyData) { @@ -378,7 +378,7 @@ public virtual bool OnMouseDown(int x, int y, Rectangle rowHeaders) } /// - /// When overridden in a derived class, is called by the when a click occurs + /// When overridden in a derived class, is called by the when a click occurs /// in the row's /// client area, specified by x and y coordinates. /// @@ -399,7 +399,7 @@ public virtual bool OnMouseMove(int x, int y, Rectangle rowHeaders) } /// - /// When overridden in a derived class, is called by the when + /// When overridden in a derived class, is called by the when /// the mouse moves within the row's client area. /// public virtual bool OnMouseMove(int x, int y, Rectangle rowHeaders, bool alignToRight) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableCollection.cs index e2517efddd6..403eb46a5e7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableCollection.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of objects in the - /// control. + /// Represents a collection of objects in the + /// control. /// [ListBindable(false)] public class GridTableStylesCollection : BaseCollection, IList @@ -176,7 +176,7 @@ internal void CheckForMappingNameDuplicates(DataGridTableStyle table) } /// - /// Adds a to this collection. + /// Adds a to this collection. /// public virtual int Add(DataGridTableStyle table) { @@ -249,7 +249,7 @@ public bool Contains(DataGridTableStyle table) } /// - /// Checks to see if a with the given name + /// Checks to see if a with the given name /// is contained in this collection. /// public bool Contains(string name) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableStyle.cs index 70075e9a2b1..0fc0a1e0de1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTableStyle.cs @@ -126,7 +126,7 @@ public bool AllowSorting } /// - /// [To be supplied] + /// [To be supplied] /// public event EventHandler AllowSortingChanged { @@ -1192,7 +1192,7 @@ private void InvalidateInside() public static readonly DataGridTableStyle DefaultTableStyle = new DataGridTableStyle(true); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridTableStyle(bool isDefaultTableStyle) { @@ -1206,7 +1206,7 @@ public DataGridTableStyle() : this(false) } /// - /// Initializes a new instance of the class with the specified + /// Initializes a new instance of the class with the specified /// . /// public DataGridTableStyle(CurrencyManager listManager) : this() @@ -1457,7 +1457,7 @@ internal void SetInternalDataGrid(DataGrid dG, bool force) } /// - /// Gets or sets the control for the drawn table. + /// Gets or sets the control for the drawn table. /// [Browsable(false)] public virtual DataGrid DataGrid diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBox.cs index 9ba4ac013e4..48317aff472 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBox.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Represents a control that is hosted in a + /// Represents a control that is hosted in a /// . /// [ @@ -30,7 +30,7 @@ public DataGridTextBox() : base() TabStop = false; } /// - /// Sets the to which this control belongs. + /// Sets the to which this control belongs. /// public void SetDataGrid(DataGrid parentGrid) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBoxColumn.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBoxColumn.cs index 5dcc8387afe..7a1f1e66ee0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBoxColumn.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridTextBoxColumn.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms { /// - /// Hosts a System.Windows.Forms.TextBox control in a cell of a System.Windows.Forms.DataGridColumnStyle for editing strings. + /// Hosts a System.Windows.Forms.TextBox control in a cell of a System.Windows.Forms.DataGridColumnStyle for editing strings. /// public class DataGridTextBoxColumn : DataGridColumnStyle { @@ -31,15 +31,15 @@ public class DataGridTextBoxColumn : DataGridColumnStyle private int editRow = -1; /// - /// Initializes a new instance of the System.Windows.Forms.DataGridTextBoxColumn - /// class. + /// Initializes a new instance of the System.Windows.Forms.DataGridTextBoxColumn + /// class. /// public DataGridTextBoxColumn() : this(null, null) { } /// - /// Initializes a new instance of a System.Windows.Forms.DataGridTextBoxColumn with + /// Initializes a new instance of a System.Windows.Forms.DataGridTextBoxColumn with /// a specified System.Data.DataColumn. /// public DataGridTextBoxColumn(PropertyDescriptor prop) @@ -48,7 +48,7 @@ public DataGridTextBoxColumn(PropertyDescriptor prop) } /// - /// Initializes a new instance of a System.Windows.Forms.DataGridTextBoxColumn. with + /// Initializes a new instance of a System.Windows.Forms.DataGridTextBoxColumn. with /// the specified System.Data.DataColumn and System.Windows.Forms.ComponentModel.Format. /// public DataGridTextBoxColumn(PropertyDescriptor prop, string format) : this(prop, format, false) { } @@ -72,7 +72,7 @@ public DataGridTextBoxColumn(PropertyDescriptor prop, bool isDefault) : this(pro // =------------------------------------------------------------------ /// - /// Gets the hosted System.Windows.Forms.TextBox control. + /// Gets the hosted System.Windows.Forms.TextBox control. /// [Browsable(false)] public virtual TextBox TextBox @@ -130,8 +130,8 @@ public override Font Font { */ /// - /// Gets or sets the System.Windows.Forms.ComponentModel.Format for the System.Windows.Forms.DataGridTextBoxColumn - /// . + /// Gets or sets the System.Windows.Forms.ComponentModel.Format for the System.Windows.Forms.DataGridTextBoxColumn + /// . /// [ SRDescription(nameof(SR.FormatControlFormatDescr)), @@ -287,8 +287,8 @@ protected internal override void UpdateUI(CurrencyManager source, int rowNum, st } /// - /// Ends an edit operation on the System.Windows.Forms.DataGridColumnStyle - /// . + /// Ends an edit operation on the System.Windows.Forms.DataGridColumnStyle + /// . /// protected void EndEdit() { @@ -551,8 +551,8 @@ private string GetText(object value) } /// - /// Paints the a System.Windows.Forms.DataGridColumnStyle with the specified System.Drawing.Graphics, - /// System.Drawing.Rectangle, DataView.Rectangle, and row number. + /// Paints the a System.Windows.Forms.DataGridColumnStyle with the specified System.Drawing.Graphics, + /// System.Drawing.Rectangle, DataView.Rectangle, and row number. /// protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum) { @@ -569,8 +569,8 @@ protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyMan } /// - /// Paints a System.Windows.Forms.DataGridColumnStyle with the specified System.Drawing.Graphics, - /// System.Drawing.Rectangle, DataView.Rectangle, row number, background color, + /// Paints a System.Windows.Forms.DataGridColumnStyle with the specified System.Drawing.Graphics, + /// System.Drawing.Rectangle, DataView.Rectangle, row number, background color, /// and foreground color.. /// protected internal override void Paint(Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.HitTestInfo.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.HitTestInfo.cs index f318271a94b..cf3671bc4f0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.HitTestInfo.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.HitTestInfo.cs @@ -22,7 +22,7 @@ public sealed class HitTestInfo internal int colStart; /// - /// Allows the object to inform you the + /// Allows the object to inform you the /// extent of the grid. /// public static readonly HitTestInfo Nowhere = new HitTestInfo(); @@ -83,7 +83,7 @@ public int RowY } /// - /// Gets the part of the control, other than the row or column, that was + /// Gets the part of the control, other than the row or column, that was /// clicked. /// public DataGridViewHitTestType Type @@ -109,7 +109,7 @@ public override bool Equals(object value) } /// - /// Gets the hash code for the instance. + /// Gets the hash code for the instance. /// public override int GetHashCode() => HashCode.Combine(type, row, col); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.Methods.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.Methods.cs index 6b220d90c25..4314326c35b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.Methods.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.Methods.cs @@ -3316,7 +3316,6 @@ private bool CanValidateDataBoundDataGridViewCell(DataGridViewCell dataGridViewC // FROM HERE DOWN THE DATA CONNECTION DETERMINES IF THE DATAGRIDVIEW SHOULD VALIDATE THE CELL. // // // ///////////////////////////////////////////////////////////////////////////////////////////////// - if (dataConnection.ProcessingMetaDataChanges) { // don't validate a cell in a data bound column while the property descriptors change under us diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs index 63abea9baa9..db374ec0090 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs @@ -400,7 +400,7 @@ public partial class DataGridView : Control, ISupportInitialize #pragma warning restore 0414 #endif /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridView() { @@ -514,7 +514,7 @@ public DataGridView() } /// - /// Scaling row header width and column header height. + /// Scaling row header width and column header height. /// private int ScaleToCurrentDpi(int value) { @@ -1902,12 +1902,12 @@ public event DataGridViewAutoSizeModeEventHandler ColumnHeadersHeightSizeModeCha } /// - /// Indicates whether the ComboBox editing control was just detached. (focused out to another cell) + /// Indicates whether the ComboBox editing control was just detached. (focused out to another cell) /// internal bool ComboBoxControlWasDetached { get; set; } /// - /// Indicates whether the TextBox editing control was just detached. (focused out to another cell) + /// Indicates whether the TextBox editing control was just detached. (focused out to another cell) /// internal bool TextBoxControlWasDetached { get; set; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewBand.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewBand.cs index e7ec972d383..a471385eae5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewBand.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewBand.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Identifies a band or column in the dataGridView. + /// Identifies a band or column in the dataGridView. /// public class DataGridViewBand : DataGridViewElement, ICloneable, IDisposable { @@ -27,7 +27,7 @@ public class DataGridViewBand : DataGridViewElement, ICloneable, IDisposable private int _minimumThickness; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// internal DataGridViewBand() { @@ -412,7 +412,7 @@ internal int MinimumThickness } /// - /// Contains all properties that are not always set. + /// Contains all properties that are not always set. /// private protected PropertyStore Properties { get; private set; } = new PropertyStore(); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs index a731960d91e..9d4c7799af7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs @@ -97,7 +97,7 @@ public AccessibleObject AccessibilityObject } /// - /// Gets or sets the Index of a column in the control. + /// Gets or sets the Index of a column in the control. /// public int ColumnIndex => OwningColumn?.Index ?? -1; @@ -571,7 +571,7 @@ public virtual bool Resizable } /// - /// Gets or sets the index of a row in the control. + /// Gets or sets the index of a row in the control. /// [Browsable(false)] public int RowIndex => OwningRow?.Index ?? -1; @@ -5092,7 +5092,7 @@ public override void Select(AccessibleSelection flags) } /// - /// Sets the detachable child accessible object which may be added or removed to/from hierachy nodes. + /// Sets the detachable child accessible object which may be added or removed to/from hierachy nodes. /// /// The child accessible object. internal override void SetDetachableChild(AccessibleObject child) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellCollection.cs index e7af3509052..9006ae312b8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellCollection.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of objects in the - /// control. + /// Represents a collection of objects in the + /// control. /// [ListBindable(false)] public class DataGridViewCellCollection : BaseCollection, IList @@ -203,7 +203,7 @@ public event CollectionChangeEventHandler CollectionChanged } /// - /// Adds a to this collection. + /// Adds a to this collection. /// public virtual int Add(DataGridViewCell dataGridViewCell) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellLinkedList.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellLinkedList.cs index 783f3815988..d8d75964a5e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellLinkedList.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCellLinkedList.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Represents a linked list of objects + /// Represents a linked list of objects /// internal class DataGridViewCellLinkedList : IEnumerable { @@ -201,7 +201,7 @@ public int RemoveAllCellsAtBand(bool column, int bandIndex) } /// - /// Represents an emunerator of elements in a linked list. + /// Represents an emunerator of elements in a linked list. /// internal class DataGridViewCellLinkedListEnumerator : IEnumerator { @@ -248,7 +248,7 @@ void IEnumerator.Reset() } /// - /// Represents an element in a linked list. + /// Represents an element in a linked list. /// internal class DataGridViewCellLinkedListElement { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumn.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumn.cs index e222e239653..8bfab8e7de6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumn.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumn.cs @@ -62,7 +62,7 @@ public DataGridViewColumn(DataGridViewCell cellTemplate) : base() } /// - /// Scale to current device dpi settings + /// Scale to current device dpi settings /// /// initial value /// scaled metric diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumnCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumnCollection.cs index 8f39de037ad..c08554a59ab 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumnCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewColumnCollection.cs @@ -11,8 +11,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of objects in the - /// control. + /// Represents a collection of objects in the + /// control. /// [ListBindable(false)] public class DataGridViewColumnCollection : BaseCollection, IList @@ -202,7 +202,7 @@ internal int ActualDisplayIndexToColumnIndex(int actualDisplayIndex, DataGridVie } /// - /// Adds a to this collection. + /// Adds a to this collection. /// [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public virtual int Add(string columnName, string headerText) @@ -217,7 +217,7 @@ public virtual int Add(string columnName, string headerText) } /// - /// Adds a to this collection. + /// Adds a to this collection. /// public virtual int Add(DataGridViewColumn dataGridViewColumn) { @@ -888,7 +888,7 @@ public int IndexOf(DataGridViewColumn dataGridViewColumn) } /// - /// Inserts a in this collection. + /// Inserts a in this collection. /// public virtual void Insert(int columnIndex, DataGridViewColumn dataGridViewColumn) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxCell.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxCell.cs index 098a1056524..716b4d1b66e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxCell.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxCell.cs @@ -84,11 +84,11 @@ public DataGridViewComboBoxCell() } /// - /// Creates a new AccessibleObject for this DataGridViewComboBoxCell instance. - /// The AccessibleObject instance returned by this method supports ControlType UIA property. + /// Creates a new AccessibleObject for this DataGridViewComboBoxCell instance. + /// The AccessibleObject instance returned by this method supports ControlType UIA property. /// /// - /// AccessibleObject for this DataGridViewComboBoxCell instance. + /// AccessibleObject for this DataGridViewComboBoxCell instance. /// protected override AccessibleObject CreateAccessibilityInstance() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxEditingControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxEditingControl.cs index b6a269ef723..b52e668d6b4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxEditingControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewComboBoxEditingControl.cs @@ -166,14 +166,14 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Defines the DataGridView ComboBox EditingControl accessible object. + /// Defines the DataGridView ComboBox EditingControl accessible object. /// internal class DataGridViewComboBoxEditingControlAccessibleObject : ComboBox.ComboBoxAccessibleObject { private readonly DataGridViewComboBoxEditingControl ownerControl; /// - /// The parent is changed when the editing control is attached to another editing cell. + /// The parent is changed when the editing control is attached to another editing cell. /// private AccessibleObject _parentAccessibleObject = null; @@ -243,7 +243,7 @@ internal override UnsafeNativeMethods.ExpandCollapseState ExpandCollapseState } /// - /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. + /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. /// /// The parent accessible object. internal override void SetParent(AccessibleObject parent) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewContentAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewContentAlignment.cs index b8f0abaf1a3..abbb751ea99 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewContentAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewContentAlignment.cs @@ -9,56 +9,56 @@ public enum DataGridViewContentAlignment NotSet = 0x000, /// - /// Content is vertically aligned at the top, and horizontally aligned - /// on the left. + /// Content is vertically aligned at the top, and horizontally aligned + /// on the left. /// TopLeft = 0x001, /// - /// Content is vertically aligned at the top, and horizontally aligned - /// at the center. + /// Content is vertically aligned at the top, and horizontally aligned + /// at the center. /// TopCenter = 0x002, /// - /// Content is vertically aligned at the top, and horizontally aligned - /// on the right. + /// Content is vertically aligned at the top, and horizontally aligned + /// on the right. /// TopRight = 0x004, /// - /// Content is vertically aligned in the middle, and horizontally aligned - /// on the left. + /// Content is vertically aligned in the middle, and horizontally aligned + /// on the left. /// MiddleLeft = 0x010, /// - /// Content is vertically aligned in the middle, and horizontally aligned - /// at the center. + /// Content is vertically aligned in the middle, and horizontally aligned + /// at the center. /// MiddleCenter = 0x020, /// - /// Content is vertically aligned in the middle, and horizontally aligned - /// on the right. + /// Content is vertically aligned in the middle, and horizontally aligned + /// on the right. /// MiddleRight = 0x040, /// - /// Content is vertically aligned at the bottom, and horizontally aligned - /// on the left. + /// Content is vertically aligned at the bottom, and horizontally aligned + /// on the left. /// BottomLeft = 0x100, /// - /// Content is vertically aligned at the bottom, and horizontally aligned - /// at the center. + /// Content is vertically aligned at the bottom, and horizontally aligned + /// at the center. /// BottomCenter = 0x200, /// - /// Content is vertically aligned at the bottom, and horizontally aligned - /// on the right. + /// Content is vertically aligned at the bottom, and horizontally aligned + /// on the right. /// BottomRight = 0x400, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewElement.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewElement.cs index 76727c5a948..7147ad6872d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewElement.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewElement.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Identifies an element in the dataGridView (base class for TCell, TBand, TRow, TColumn. + /// Identifies an element in the dataGridView (base class for TCell, TBand, TRow, TColumn. /// public class DataGridViewElement { private DataGridView _dataGridView; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridViewElement() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewHitTestType.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewHitTestType.cs index 22c1fbbd023..e629934399e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewHitTestType.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewHitTestType.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Specifies the part of the - /// control where the mouse is. + /// Specifies the part of the + /// control where the mouse is. /// public enum DataGridViewHitTestType { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewIntLinkedList.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewIntLinkedList.cs index fa6a6ba4045..6b17e3ebdd0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewIntLinkedList.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewIntLinkedList.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Represents a linked list of integers + /// Represents a linked list of integers /// internal class DataGridViewIntLinkedList : IEnumerable { @@ -201,7 +201,7 @@ public void RemoveAt(int index) } /// - /// Represents an emunerator of elements in a linked list. + /// Represents an emunerator of elements in a linked list. /// internal class DataGridViewIntLinkedListEnumerator : IEnumerator { @@ -248,7 +248,7 @@ void IEnumerator.Reset() } /// - /// Represents an element in a linked list. + /// Represents an element in a linked list. /// internal class DataGridViewIntLinkedListElement { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRow.cs index 7490d85a637..07f2d1efca2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRow.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// Identifies a row in the dataGridView. + /// Identifies a row in the dataGridView. /// [TypeConverter(typeof(DataGridViewRowConverter))] public class DataGridViewRow : DataGridViewBand @@ -28,7 +28,7 @@ public class DataGridViewRow : DataGridViewBand private DataGridViewCellCollection _rowCells; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DataGridViewRow() : base() { @@ -1103,8 +1103,8 @@ public void CreateCells(DataGridView dataGridView, params object[] values) } /// - /// Constructs the new instance of the Cells collection objects. Subclasses - /// should not call base.CreateCellsInstance. + /// Constructs the new instance of the Cells collection objects. Subclasses + /// should not call base.CreateCellsInstance. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual DataGridViewCellCollection CreateCellsInstance() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRowCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRowCollection.cs index ba1ef651559..98d0fb29f4b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRowCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewRowCollection.cs @@ -12,8 +12,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of objects in the - /// control. + /// Represents a collection of objects in the + /// control. /// [ ListBindable(false), @@ -400,7 +400,7 @@ public virtual int Add(params object[] values) } /// - /// Adds a to this collection. + /// Adds a to this collection. /// public virtual int Add(DataGridViewRow dataGridViewRow) { @@ -1418,7 +1418,7 @@ public virtual void Insert(int rowIndex, params object[] values) } /// - /// Inserts a to this collection. + /// Inserts a to this collection. /// public virtual void Insert(int rowIndex, DataGridViewRow dataGridViewRow) { @@ -1784,7 +1784,7 @@ private void InsertDuplicateRow(int indexDestination, DataGridViewRow rowTemplat } /// - /// Inserts a range of to this collection. + /// Inserts a range of to this collection. /// public virtual void InsertRange(int rowIndex, params DataGridViewRow[] dataGridViewRows) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedCellCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedCellCollection.cs index 3ab396d9e52..6595bcdb20f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedCellCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedCellCollection.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of selected objects in the - /// control. + /// Represents a collection of selected objects in the + /// control. /// [ListBindable(false)] public class DataGridViewSelectedCellCollection : BaseCollection, IList @@ -114,7 +114,7 @@ public DataGridViewCell this[int index] } /// - /// Adds a to this collection. + /// Adds a to this collection. /// internal int Add(DataGridViewCell dataGridViewCell) { @@ -145,7 +145,7 @@ internal void AddCellCollection(DataGridViewSelectedCellCollection dataGridViewC */ /// - /// Adds all the objects from the provided linked list to this collection. + /// Adds all the objects from the provided linked list to this collection. /// internal void AddCellLinkedList(DataGridViewCellLinkedList dataGridViewCells) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedColumnCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedColumnCollection.cs index ddd04564068..70ce1fc5507 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedColumnCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedColumnCollection.cs @@ -109,7 +109,7 @@ public DataGridViewColumn this[int index] } /// - /// Adds a to this collection. + /// Adds a to this collection. /// internal int Add(DataGridViewColumn dataGridViewColumn) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedRowCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedRowCollection.cs index 5b605cc6833..1fce2272f7a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedRowCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewSelectedRowCollection.cs @@ -8,8 +8,8 @@ namespace System.Windows.Forms { /// - /// Represents a collection of selected objects in the - /// control. + /// Represents a collection of selected objects in the + /// control. /// [ListBindable(false)] public class DataGridViewSelectedRowCollection : BaseCollection, IList @@ -113,7 +113,7 @@ public DataGridViewRow this[int index] } /// - /// Adds a to this collection. + /// Adds a to this collection. /// internal int Add(DataGridViewRow dataGridViewRow) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxCell.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxCell.cs index 4f5a951a0c8..514f3de5989 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxCell.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxCell.cs @@ -41,11 +41,11 @@ public DataGridViewTextBoxCell() } /// - /// Creates a new AccessibleObject for this DataGridViewTextBoxCell instance. - /// The AccessibleObject instance returned by this method supports ControlType UIA property. + /// Creates a new AccessibleObject for this DataGridViewTextBoxCell instance. + /// The AccessibleObject instance returned by this method supports ControlType UIA property. /// /// - /// AccessibleObject for this DataGridViewTextBoxCell instance. + /// AccessibleObject for this DataGridViewTextBoxCell instance. /// protected override AccessibleObject CreateAccessibilityInstance() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxEditingControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxEditingControl.cs index 26446da4494..cb4f7a6e4f5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxEditingControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewTextBoxEditingControl.cs @@ -305,14 +305,14 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Defines the DataGridView TextBox EditingControl accessible object. + /// Defines the DataGridView TextBox EditingControl accessible object. /// internal class DataGridViewTextBoxEditingControlAccessibleObject : Control.ControlAccessibleObject { private readonly DataGridViewTextBoxEditingControl ownerControl; /// - /// The parent is changed when the editing control is attached to another editing cell. + /// The parent is changed when the editing control is attached to another editing cell. /// private AccessibleObject _parentAccessibleObject = null; @@ -400,7 +400,7 @@ internal override bool IsPatternSupported(int patternId) } /// - /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. + /// Sets the parent accessible object for the node which can be added or removed to/from hierachy nodes. /// /// The parent accessible object. internal override void SetParent(AccessibleObject parent) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataObject.cs index 7b4022b5303..04da77e72be 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataObject.cs @@ -57,7 +57,7 @@ public class DataObject : IDataObject, IComDataObject private static readonly byte[] serializedObjectID = new Guid("FD9EA796-3B13-4370-A679-56106BB288FB").ToByteArray(); /// - /// Initializes a new instance of the class, with the specified . + /// Initializes a new instance of the class, with the specified . /// internal DataObject(IDataObject data) { @@ -67,7 +67,7 @@ internal DataObject(IDataObject data) } /// - /// Initializes a new instance of the class, with the specified . + /// Initializes a new instance of the class, with the specified . /// internal DataObject(IComDataObject data) { @@ -95,7 +95,7 @@ public DataObject() } /// - /// Initializes a new instance of the class, containing the specified data. + /// Initializes a new instance of the class, containing the specified data. /// public DataObject(object data) { @@ -117,7 +117,7 @@ public DataObject(object data) } /// - /// Initializes a new instance of the class, containing the specified data and its + /// Initializes a new instance of the class, containing the specified data and its /// associated format. /// public DataObject(string format, object data) : this() @@ -751,7 +751,7 @@ void IComDataObject.SetData(ref FORMATETC pFormatetcIn, ref STGMEDIUM pmedium, b } /// - /// We are restricting serialization of formats that represent strings, bitmaps or OLE types. + /// We are restricting serialization of formats that represent strings, bitmaps or OLE types. /// /// format name /// true - serialize only safe types, strings or bitmaps. @@ -2145,9 +2145,9 @@ public virtual string[] GetFormats() } /// - /// Binder that restricts DataObject content deserialization to Bitmap type and - /// serialization to strings and Bitmaps. - /// Deserialization of known safe types(strings and arrays of primitives) does not invoke the binder. + /// Binder that restricts DataObject content deserialization to Bitmap type and + /// serialization to strings and Bitmaps. + /// Deserialization of known safe types(strings and arrays of primitives) does not invoke the binder. /// private class BitmapBinder : SerializationBinder { @@ -2211,7 +2211,7 @@ public override Type BindToType(string assemblyName, string typeName) } /// - /// Bitmap and string types are safe type to serialize/deserialize. + /// Bitmap and string types are safe type to serialize/deserialize. /// /// /// @@ -2229,8 +2229,8 @@ public override void BindToName(Type serializedType, out string assemblyName, ou } /// - /// This exception is used to indicate that clipboard contains a serialized - /// managed object that contains unexpected types and that we should stop processing this data. + /// This exception is used to indicate that clipboard contains a serialized + /// managed object that contains unexpected types and that we should stop processing this data. /// private class RestrictedTypeDeserializationException : Exception { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataSourceUpdateMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataSourceUpdateMode.cs index 509ebba42ed..23a6d8107e1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataSourceUpdateMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataSourceUpdateMode.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms { /// - /// Determines when changes to a data-bound control property get propagated - /// back to the corresponding data source property. + /// Determines when changes to a data-bound control property get propagated + /// back to the corresponding data source property. /// public enum DataSourceUpdateMode { /// - /// Data source is updated when the control property is validated, ie. - /// during the Validating event. Typically this does not occur until the - /// input focus leaves the control. After validation, the value in the - /// control property will also be re-formatted. - /// This is the default update mode. + /// Data source is updated when the control property is validated, ie. + /// during the Validating event. Typically this does not occur until the + /// input focus leaves the control. After validation, the value in the + /// control property will also be re-formatted. + /// This is the default update mode. /// OnValidation = 0, /// - /// Data source is updated whenever the control property changes (and also - /// updated again during validation). After validation, the value in the - /// control property will also be re-formatted. + /// Data source is updated whenever the control property changes (and also + /// updated again during validation). After validation, the value in the + /// control property will also be re-formatted. /// OnPropertyChanged = 1, /// - /// Data source is never updated. Binding is "read-only" with respect to - /// the data source. Values entered into the control are *not* parsed, - /// validated or re-formatted. To force the data source to be updated, - /// use the Binding.WriteValue method. + /// Data source is never updated. Binding is "read-only" with respect to + /// the data source. Values entered into the control are *not* parsed, + /// validated or re-formatted. To force the data source to be updated, + /// use the Binding.WriteValue method. /// Never = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DataStreamFromComStream.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DataStreamFromComStream.cs index 5e2606b0f55..d1f34917f07 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DataStreamFromComStream.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DataStreamFromComStream.cs @@ -68,7 +68,7 @@ public override void Flush() } /// - /// Read the data into the given buffer + /// Read the data into the given buffer /// /// The buffer receiving the data /// The offset from the beginning of the buffer @@ -86,7 +86,7 @@ public override int Read(byte[] buffer, int index, int count) } /// - /// Read the data into the given buffer + /// Read the data into the given buffer /// /// The buffer receiving the data /// The number of bytes read @@ -117,7 +117,7 @@ public unsafe override long Seek(long offset, SeekOrigin origin) } /// - /// Writes the data contained in the given buffer + /// Writes the data contained in the given buffer /// /// The buffer containing the data to write /// The offset from the beginning of the buffer @@ -140,7 +140,7 @@ public override void Write(byte[] buffer, int index, int count) } /// - /// Writes the data contained in the given buffer + /// Writes the data contained in the given buffer /// /// The buffer to write public unsafe override void Write(ReadOnlySpan buffer) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DateBoldEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DateBoldEventArgs.cs index dd9a4242b4a..d4e2cd99ee8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DateBoldEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DateBoldEventArgs.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// The month calendar control fires this event to request information about how - /// the days within the visible months should be displayed. + /// The month calendar control fires this event to request information about how + /// the days within the visible months should be displayed. /// public class DateBoldEventArgs : EventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DateRangeEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DateRangeEventArgs.cs index 44d6b1b5ad6..af7529c57a8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DateRangeEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DateRangeEventArgs.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// The SelectEvent is fired when the user makes an explicit date selection within a - /// month calendar control. + /// The SelectEvent is fired when the user makes an explicit date selection within a + /// month calendar control. /// public class DateRangeEventArgs : EventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePicker.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePicker.cs index dd56bc8d420..77003079448 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePicker.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePicker.cs @@ -105,7 +105,7 @@ public class DateTimePicker : Control private bool rightToLeftLayout = false; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DateTimePicker() : base() @@ -392,7 +392,7 @@ public Color CalendarMonthBackground } /// - /// Indicates whether the property has been set. + /// Indicates whether the property has been set. /// [ SRCategory(nameof(SR.CatBehavior)), @@ -1108,8 +1108,8 @@ public event EventHandler DropDown } /// - /// Constructs the new instance of the accessibility object for this control. Subclasses - /// should not call base.CreateAccessibilityObject. + /// Constructs the new instance of the accessibility object for this control. Subclasses + /// should not call base.CreateAccessibilityObject. /// protected override AccessibleObject CreateAccessibilityInstance() { @@ -1225,8 +1225,8 @@ protected override bool IsInputKey(Keys keyData) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnCloseUp(EventArgs eventargs) { @@ -1234,7 +1234,7 @@ protected virtual void OnCloseUp(EventArgs eventargs) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnDropDown(EventArgs eventargs) { @@ -1268,7 +1268,7 @@ protected override void OnHandleDestroyed(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnValueChanged(EventArgs eventargs) { @@ -1341,7 +1341,7 @@ private void ResetCalendarTrailingForeColor() } /// - /// Resets the property to its default + /// Resets the property to its default /// value. /// private void ResetFormat() @@ -1350,7 +1350,7 @@ private void ResetFormat() } /// - /// Resets the property to its default value. + /// Resets the property to its default value. /// private void ResetMaxDate() { @@ -1358,7 +1358,7 @@ private void ResetMaxDate() } /// - /// Resets the property to its default value. + /// Resets the property to its default value. /// private void ResetMinDate() { @@ -1508,7 +1508,7 @@ private bool ShouldSerializeCalendarForeColor() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeCalendarFont() { @@ -1516,7 +1516,7 @@ private bool ShouldSerializeCalendarFont() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeCalendarTitleBackColor() { @@ -1524,7 +1524,7 @@ private bool ShouldSerializeCalendarTitleBackColor() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeCalendarTitleForeColor() { @@ -1532,7 +1532,7 @@ private bool ShouldSerializeCalendarTitleForeColor() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeCalendarTrailingForeColor() { @@ -1540,7 +1540,7 @@ private bool ShouldSerializeCalendarTrailingForeColor() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeCalendarMonthBackground() { @@ -1548,7 +1548,7 @@ private bool ShouldSerializeCalendarMonthBackground() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeMaxDate() { @@ -1556,7 +1556,7 @@ private bool ShouldSerializeMaxDate() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeMinDate() { @@ -1564,7 +1564,7 @@ private bool ShouldSerializeMinDate() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeValue() { @@ -1572,7 +1572,7 @@ private bool ShouldSerializeValue() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeFormat() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePickerFormats.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePickerFormats.cs index 085a499ed21..4dbb93309dd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePickerFormats.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DateTimePickerFormats.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - /// Constants that specify how the date and time picker control displays - /// date and time information. + /// Constants that specify how the date and time picker control displays + /// date and time information. /// public enum DateTimePickerFormat { /// - /// Long format - produces output in the form "Wednesday, April 7, 1999" + /// Long format - produces output in the form "Wednesday, April 7, 1999" /// Long = 0x0001, /// - /// Short format - produces output in the form "4/7/99" + /// Short format - produces output in the form "4/7/99" /// Short = 0x0002, /// - /// Time format - produces output in time format + /// Time format - produces output in time format /// Time = 0x0004, /// - /// Custom format - produces output in custom format. + /// Custom format - produces output in custom format. /// Custom = 0x0008, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Day.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Day.cs index 88922070a05..6186dc4e9c1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Day.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Day.cs @@ -5,47 +5,47 @@ namespace System.Windows.Forms { /// - /// Specifies the day of the week. + /// Specifies the day of the week. /// public enum Day { /// - /// The day Monday. + /// The day Monday. /// Monday = 0, /// - /// The day Tuesday. + /// The day Tuesday. /// Tuesday = 1, /// - /// The day Wednesday. + /// The day Wednesday. /// Wednesday = 2, /// - /// The day Thursday. + /// The day Thursday. /// Thursday = 3, /// - /// The day Friday. + /// The day Friday. /// Friday = 4, /// - /// The day Saturday. + /// The day Saturday. /// Saturday = 5, /// - /// The day Sunday. + /// The day Sunday. /// Sunday = 6, /// - /// A default day of the week specified by the application. + /// A default day of the week specified by the application. /// Default = 7, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorForm.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorForm.cs index b5d33c088f9..d73c0f87762 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorForm.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorForm.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a user interface for . + /// Provides a user interface for . /// [ComVisible(true), ClassInterface(ClassInterfaceType.AutoDispatch) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorPage.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorPage.cs index 9ce9fe2b7e6..3658b9f4928 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorPage.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ComponentEditorPage.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a base implementation for a . + /// Provides a base implementation for a . /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -19,7 +19,7 @@ public abstract class ComponentEditorPage : Panel private Icon _icon; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ComponentEditorPage() : base() { @@ -27,7 +27,7 @@ public ComponentEditorPage() : base() } /// - /// Hide the property + /// Hide the property /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] @@ -47,27 +47,27 @@ public override bool AutoSize } /// - /// Gets or sets the page site + /// Gets or sets the page site /// protected IComponentEditorPageSite PageSite { get; set; } /// - /// Gets or sets the component to edit + /// Gets or sets the component to edit /// protected IComponent Component { get; set; } /// - /// Indicates whether the page is being activated for the first time + /// Indicates whether the page is being activated for the first time /// protected bool FirstActivate { get; set; } = true; /// - /// Indicates whether a load is required previous to editing + /// Indicates whether a load is required previous to editing /// protected bool LoadRequired { get; set; } /// - /// Indicates if loading is taking place + /// Indicates if loading is taking place /// protected int Loading { get; set; } @@ -77,7 +77,7 @@ public override bool AutoSize public bool CommitOnDeactivate { get; set; } /// - /// Gets or sets the creation parameters for this control + /// Gets or sets the creation parameters for this control /// protected override CreateParams CreateParams { @@ -90,7 +90,7 @@ protected override CreateParams CreateParams } /// - /// Gets or sets the icon for this page + /// Gets or sets the icon for this page /// public Icon Icon { @@ -99,12 +99,12 @@ public Icon Icon } /// - /// Gets or sets the title of the page + /// Gets or sets the title of the page /// public virtual string Title => base.Text; /// - /// Activates and displays the page. + /// Activates and displays the page. /// public virtual void Activate() { @@ -122,12 +122,12 @@ public virtual void Activate() } /// - /// Applies changes to all the components being edited + /// Applies changes to all the components being edited /// public virtual void ApplyChanges() => SaveComponent(); /// - /// Deactivates and hides the page + /// Deactivates and hides the page /// public virtual void Deactivate() { @@ -135,12 +135,12 @@ public virtual void Deactivate() } /// - /// Increments the loading counter, which determines whether a page is in loading mode. + /// Increments the loading counter, which determines whether a page is in loading mode. /// protected void EnterLoadingMode() => Loading++; /// - /// Decrements the loading counter, which determines whether a page is in loading mode. + /// Decrements the loading counter, which determines whether a page is in loading mode. /// protected void ExitLoadingMode() { @@ -153,42 +153,42 @@ protected void ExitLoadingMode() } /// - /// Gets the control that represents the window for this page + /// Gets the control that represents the window for this page /// public virtual Control GetControl() => this; /// - /// Gets the component that is to be edited + /// Gets the component that is to be edited /// protected IComponent GetSelectedComponent() => Component; /// - /// Processes messages that could be handled by the page + /// Processes messages that could be handled by the page /// public virtual bool IsPageMessage(ref Message msg) => PreProcessMessage(ref msg); /// - /// Gets a value indicating whether the page is being activated for the first time + /// Gets a value indicating whether the page is being activated for the first time /// protected bool IsFirstActivate() => FirstActivate; /// - /// Gets a value indicating whether the page is being loaded + /// Gets a value indicating whether the page is being loaded /// protected bool IsLoading() => Loading != 0; /// - /// Loads the component into the page UI + /// Loads the component into the page UI /// protected abstract void LoadComponent(); /// - /// Called when the page along with its sibling pages have applied their changes + /// Called when the page along with its sibling pages have applied their changes /// public virtual void OnApplyComplete() => ReloadComponent(); /// - /// Called when the current component may have changed elsewhere and needs to be reloded into the UI + /// Called when the current component may have changed elsewhere and needs to be reloded into the UI /// protected virtual void ReloadComponent() { @@ -199,12 +199,12 @@ protected virtual void ReloadComponent() } /// - /// Saves the component from the page UI + /// Saves the component from the page UI /// protected abstract void SaveComponent(); /// - /// Sets the page to be in dirty state + /// Sets the page to be in dirty state /// protected virtual void SetDirty() { @@ -215,7 +215,7 @@ protected virtual void SetDirty() } /// - /// Sets the component to be edited + /// Sets the component to be edited /// public virtual void SetComponent(IComponent component) { @@ -224,7 +224,7 @@ public virtual void SetComponent(IComponent component) } /// - /// Sets the site for this page. + /// Sets the site for this page. /// public virtual void SetSite(IComponentEditorPageSite site) { @@ -233,14 +233,14 @@ public virtual void SetSite(IComponentEditorPageSite site) } /// - /// Provides help information to the help system + /// Provides help information to the help system /// public virtual void ShowHelp() { } /// - /// Gets a value indicating whether the editor supports Help + /// Gets a value indicating whether the editor supports Help /// public virtual bool SupportsHelp() => false; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/EventsTab.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/EventsTab.cs index dc1f2493e0f..0b7459413fc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/EventsTab.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/EventsTab.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a tab on the property browser to display events for selection and linking. + /// Provides a tab on the property browser to display events for selection and linking. /// public class EventsTab : PropertyTab { @@ -19,7 +19,7 @@ public class EventsTab : PropertyTab private bool _sunkEvent; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public EventsTab(IServiceProvider sp) { @@ -27,17 +27,17 @@ public EventsTab(IServiceProvider sp) } /// - /// Gets or sets the name of the tab. + /// Gets or sets the name of the tab. /// public override string TabName => SR.PBRSToolTipEvents; /// - /// Gets or sets the help keyword for the tab. + /// Gets or sets the help keyword for the tab. /// public override string HelpKeyword => "Events"; /// - /// Gets a value indicating whether the specified object can be extended. + /// Gets a value indicating whether the specified object can be extended. /// public override bool CanExtend(object extendee) => extendee == null || !Marshal.IsComObject(extendee); @@ -47,7 +47,7 @@ private void OnActiveDesignerChanged(object sender, ActiveDesignerEventArgs adev } /// - /// Gets the default property from the specified object. + /// Gets the default property from the specified object. /// public override PropertyDescriptor GetDefaultProperty(object obj) { @@ -109,7 +109,7 @@ private IEventBindingService GetEventPropertyService(object obj, ITypeDescriptor } /// - /// Gets all the properties of the tab. + /// Gets all the properties of the tab. /// public override PropertyDescriptorCollection GetProperties(object component, Attribute[] attributes) { @@ -117,7 +117,7 @@ public override PropertyDescriptorCollection GetProperties(object component, Att } /// - /// Gets the properties of the specified component. + /// Gets the properties of the specified component. /// public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object component, Attribute[] attributes) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/IUIService.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/IUIService.cs index 61a569368a1..6bd91ba9be3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/IUIService.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/IUIService.cs @@ -8,75 +8,75 @@ namespace System.Windows.Forms.Design { /// - /// Provides support for interaction with the user interface of the development - /// environment object that is hosting the designer + /// Provides support for interaction with the user interface of the development + /// environment object that is hosting the designer /// [Guid("06A9C74B-5E32-4561-BE73-381B37869F4F")] public interface IUIService { /// - /// Gets or sets the collections of styles that are specific to the host's environment + /// Gets or sets the collections of styles that are specific to the host's environment /// IDictionary Styles { get; } /// - /// Indicates whether the component can display a ComponentDesigner + /// Indicates whether the component can display a ComponentDesigner /// bool CanShowComponentEditor(object component); /// - /// Gets the window that should be used for dialog parenting + /// Gets the window that should be used for dialog parenting /// IWin32Window GetDialogOwnerWindow(); /// - /// Sets a flag indicating the UI is dirty + /// Sets a flag indicating the UI is dirty /// void SetUIDirty(); /// - /// Attempts to display a ComponentEditor for a component + /// Attempts to display a ComponentEditor for a component /// bool ShowComponentEditor(object component, IWin32Window parent); /// - /// Attempts to display the specified form in a dialog box + /// Attempts to display the specified form in a dialog box /// DialogResult ShowDialog(Form form); /// - /// Displays the specified error message in a message box + /// Displays the specified error message in a message box /// void ShowError(string message); /// - /// Displays the specified exception and its information in a message box + /// Displays the specified exception and its information in a message box /// void ShowError(Exception ex); /// - /// Displays the specified exception and its information in a message box + /// Displays the specified exception and its information in a message box /// void ShowError(Exception ex, string message); /// - /// Displays the specified message in a message box + /// Displays the specified message in a message box /// void ShowMessage(string message); /// - /// Displays the specified message in a message box with the specified caption + /// Displays the specified message in a message box with the specified caption /// void ShowMessage(string message, string caption); /// - /// Displays the specified message in a message box with the specified caption and - /// buttons to place on the dialog box + /// Displays the specified message in a message box with the specified caption and + /// buttons to place on the dialog box /// DialogResult ShowMessage(string message, string caption, MessageBoxButtons buttons); /// - /// Displays the specified tool window + /// Displays the specified tool window /// bool ShowToolWindow(Guid toolWindow); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/IWindowsFormsEditorService.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/IWindowsFormsEditorService.cs index 18bf6c01dd5..9ea72598c20 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/IWindowsFormsEditorService.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/IWindowsFormsEditorService.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms.Design { /// - /// Provides an interface to display Win Forms dialog boxes and controls. + /// Provides an interface to display Win Forms dialog boxes and controls. /// public interface IWindowsFormsEditorService { /// - /// Closes a previously opened drop down list + /// Closes a previously opened drop down list /// void CloseDropDown(); /// - /// Displays the specified control in a drop down list + /// Displays the specified control in a drop down list /// void DropDownControl(Control control); /// - /// Shows the specified dialog box. + /// Shows the specified dialog box. /// DialogResult ShowDialog(Form dialog); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/PropertyTab.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/PropertyTab.cs index d1a0dfb7807..da3093e36d4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/PropertyTab.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/PropertyTab.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms.Design { /// - /// Provides a base class for property tabs. + /// Provides a base class for property tabs. /// public abstract class PropertyTab : IExtenderProvider { @@ -18,7 +18,7 @@ public abstract class PropertyTab : IExtenderProvider ~PropertyTab() => Dispose(false); /// - /// Gets or sets a bitmap to display in the property tab. + /// Gets or sets a bitmap to display in the property tab. /// public virtual Bitmap Bitmap { @@ -43,23 +43,23 @@ public virtual Bitmap Bitmap } /// - /// Gets or sets the array of components the property tab is associated with. + /// Gets or sets the array of components the property tab is associated with. /// public virtual object[] Components { get; set; } /// - /// Gets or sets the name for the property tab. + /// Gets or sets the name for the property tab. /// public abstract string TabName { get; } /// - /// Gets or sets the help keyword that is to be associated with this tab. This - /// defaults to the tab name. + /// Gets or sets the help keyword that is to be associated with this tab. This + /// defaults to the tab name. /// public virtual string HelpKeyword => TabName; /// - /// Gets a value indicating whether the specified object be can extended. + /// Gets a value indicating whether the specified object be can extended. /// public virtual bool CanExtend(object extendee) => true; @@ -82,7 +82,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Gets the default property of the specified component. + /// Gets the default property of the specified component. /// public virtual PropertyDescriptor GetDefaultProperty(object component) { @@ -90,7 +90,7 @@ public virtual PropertyDescriptor GetDefaultProperty(object component) } /// - /// Gets the properties of the specified component. + /// Gets the properties of the specified component. /// public virtual PropertyDescriptorCollection GetProperties(object component) { @@ -98,13 +98,13 @@ public virtual PropertyDescriptorCollection GetProperties(object component) } /// - /// Gets the properties of the specified component which match the specified - /// attributes. + /// Gets the properties of the specified component which match the specified + /// attributes. /// public abstract PropertyDescriptorCollection GetProperties(object component, Attribute[] attributes); /// - /// Gets the properties of the specified component. + /// Gets the properties of the specified component. /// public virtual PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object component, Attribute[] attributes) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ToolStripItemDesignerAvailabilityAttribute.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ToolStripItemDesignerAvailabilityAttribute.cs index ecf247fe6d0..4d31777fccf 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/ToolStripItemDesignerAvailabilityAttribute.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/ToolStripItemDesignerAvailabilityAttribute.cs @@ -10,8 +10,8 @@ public sealed class ToolStripItemDesignerAvailabilityAttribute : Attribute public static readonly ToolStripItemDesignerAvailabilityAttribute Default = new ToolStripItemDesignerAvailabilityAttribute(); /// - /// Specifies which ToolStrip types the Item can appear in - ToolStrip,MenuStrip,StatusStrip,ContextMenuStrip - /// Adding this attribute over a class lets you add to the list of custom items in the ToolStrip design time. + /// Specifies which ToolStrip types the Item can appear in - ToolStrip,MenuStrip,StatusStrip,ContextMenuStrip + /// Adding this attribute over a class lets you add to the list of custom items in the ToolStrip design time. /// public ToolStripItemDesignerAvailabilityAttribute() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Design/WindowsFormsComponentEditor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Design/WindowsFormsComponentEditor.cs index 89728f2cd99..1ea52cd1586 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Design/WindowsFormsComponentEditor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Design/WindowsFormsComponentEditor.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms.Design { /// - /// Provides a base class for editors that support any type of + /// Provides a base class for editors that support any type of /// objects. /// public abstract class WindowsFormsComponentEditor : ComponentEditor { /// - /// Activates a UI used to edit the component. + /// Activates a UI used to edit the component. /// public override bool EditComponent(ITypeDescriptorContext context, object component) { @@ -21,7 +21,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon } /// - /// Activates the advanced UI used to edit the component. + /// Activates the advanced UI used to edit the component. /// public bool EditComponent(object component, IWin32Window owner) { @@ -29,7 +29,7 @@ public bool EditComponent(object component, IWin32Window owner) } /// - //// Activates the advanced UI used to edit the component. + //// Activates the advanced UI used to edit the component. /// public virtual bool EditComponent(ITypeDescriptorContext context, object component, IWin32Window owner) { @@ -44,13 +44,13 @@ public virtual bool EditComponent(ITypeDescriptorContext context, object compone } /// - /// Gets the set of pages to be used. + /// Gets the set of pages to be used. /// protected virtual Type[] GetComponentEditorPages() => null; /// - /// Gets the index of the - /// to be shown by default as the first active page. + /// Gets the index of the + /// to be shown by default as the first active page. /// protected virtual int GetInitialComponentEditorPageIndex() => 0; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DialogResult.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DialogResult.cs index 02d0e7b4411..0a99ff0307f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DialogResult.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DialogResult.cs @@ -7,55 +7,55 @@ namespace System.Windows.Forms { /// - /// Specifies identifiers to indicate the return value of a dialog box. + /// Specifies identifiers to indicate the return value of a dialog box. /// [ComVisible(true)] public enum DialogResult { /// - /// Nothing is returned from the dialog box. This means that the modal - /// dialog continues running. + /// Nothing is returned from the dialog box. This means that the modal + /// dialog continues running. /// None = 0, /// - /// The dialog box return value is OK (usually sent from a button labeled OK). + /// The dialog box return value is OK (usually sent from a button labeled OK). /// OK = 1, /// - /// The dialog box return value is Cancel (usually sent from a button - /// labeled Cancel). + /// The dialog box return value is Cancel (usually sent from a button + /// labeled Cancel). /// Cancel = 2, /// - /// The dialog box return value is Abort (usually sent from a button - /// labeled Abort). + /// The dialog box return value is Abort (usually sent from a button + /// labeled Abort). /// Abort = 3, /// - /// The dialog box return value is Retry (usually sent from a button - /// labeled Retry). + /// The dialog box return value is Retry (usually sent from a button + /// labeled Retry). /// Retry = 4, /// - /// The dialog box return value is Ignore (usually sent from a button - /// labeled Ignore). + /// The dialog box return value is Ignore (usually sent from a button + /// labeled Ignore). /// Ignore = 5, /// - /// The dialog box return value is Yes (usually sent from a button - /// labeled Yes). + /// The dialog box return value is Yes (usually sent from a button + /// labeled Yes). /// Yes = 6, /// - /// The dialog box return value is No (usually sent from a button - /// labeled No). + /// The dialog box return value is No (usually sent from a button + /// labeled No). /// No = 7, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DockStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DockStyle.cs index e0720196abe..68befc93e9a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DockStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DockStyle.cs @@ -8,11 +8,11 @@ namespace System.Windows.Forms { /// - /// Control Dock values. - /// When a control is docked to an edge of it's container it will - /// always be positioned flush against that edge while the container - /// resizes. If more than one control is docked to an edge, the controls - /// will not be placed on top of each other. + /// Control Dock values. + /// When a control is docked to an edge of it's container it will + /// always be positioned flush against that edge while the container + /// resizes. If more than one control is docked to an edge, the controls + /// will not be placed on top of each other. /// [Editor("System.Windows.Forms.Design.DockEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor))] public enum DockStyle diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DockingAttribute.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DockingAttribute.cs index e43b750ad91..ab431e2dacc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DockingAttribute.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DockingAttribute.cs @@ -5,13 +5,13 @@ namespace System.Windows.Forms { /// - /// Specifies how a control should be docked by default when added through the designer. + /// Specifies how a control should be docked by default when added through the designer. /// [AttributeUsage(AttributeTargets.Class)] public sealed class DockingAttribute : Attribute { /// - /// Default constructor. + /// Default constructor. /// public DockingAttribute() { @@ -19,7 +19,7 @@ public DockingAttribute() } /// - /// Constructor. + /// Constructor. /// public DockingAttribute(DockingBehavior dockingBehavior) { @@ -27,13 +27,13 @@ public DockingAttribute(DockingBehavior dockingBehavior) } /// - /// Specifies the default value for the . - /// This field is read-only. + /// Specifies the default value for the . + /// This field is read-only. /// public static readonly DockingAttribute Default = new DockingAttribute(); /// - /// DockingBehavior property. + /// DockingBehavior property. /// public DockingBehavior DockingBehavior { get; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DockingBehavior.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DockingBehavior.cs index 2c58edb37be..b4dd9591bb2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DockingBehavior.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DockingBehavior.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies whether any characters in the current selection have the - /// style or attribute. + /// Specifies whether any characters in the current selection have the + /// style or attribute. /// public enum DockingBehavior { /// - /// Some but not all characters. + /// Some but not all characters. /// Never = 0, /// - /// No characters. + /// No characters. /// Ask = 1, /// - /// All characters. + /// All characters. /// AutoDock = 2 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DomainUpDown.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DomainUpDown.cs index 8b2f9794b0b..575ad43b38c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DomainUpDown.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DomainUpDown.cs @@ -33,7 +33,6 @@ public class DomainUpDown : UpDownBase // Member variables // ////////////////////////////////////////////////////////////// - /// /// Allowable strings for the domain updown. /// @@ -236,7 +235,6 @@ public bool Wrap // Methods // ////////////////////////////////////////////////////////////// - /// /// Occurs when the property has /// been changed. @@ -394,9 +392,9 @@ protected override void OnChanged(object source, EventArgs e) } /// - /// Handles the - /// event, using the input character to find the next matching item in our - /// item collection. + /// Handles the + /// event, using the input character to find the next matching item in our + /// item collection. /// protected override void OnTextBoxKeyPress(object source, KeyPressEventArgs e) { @@ -608,8 +606,8 @@ internal override Size GetPreferredSizeCore(Size proposedConstraints) // DomainUpDown collection class /// - /// Encapsulates a collection of objects for use by the - /// class. + /// Encapsulates a collection of objects for use by the + /// class. /// public class DomainUpDownItemCollection : ArrayList { @@ -739,7 +737,7 @@ public DomainUpDownAccessibleObject(Control owner) : base(owner) } /// - /// Gets or sets the accessible name. + /// Gets or sets the accessible name. /// public override string Name { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventArgs.cs index c07c0ce6a51..c44335bf4b5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventArgs.cs @@ -10,12 +10,12 @@ namespace System.Windows.Forms { /// - /// Provides information about a DpiChanged event. + /// Provides information about a DpiChanged event. /// public sealed class DpiChangedEventArgs : CancelEventArgs { /// - /// Parameter units are pixels(dots) per inch. + /// Parameter units are pixels(dots) per inch. /// internal DpiChangedEventArgs(int old, Message m) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventHandler.cs index c8e86259451..faf537ef038 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DpiChangedEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , or - /// event of a . + /// event of a . /// public delegate void DpiChangedEventHandler(object sender, DpiChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DpiHelper.WinForms.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DpiHelper.WinForms.cs index e1e3d1fd576..6f35dab3a14 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DpiHelper.WinForms.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DpiHelper.WinForms.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Part of DpiHelper class, with methods specific to WinForms assembly - /// Also handles configuration switches that control states of various WinForms features + /// Part of DpiHelper class, with methods specific to WinForms assembly + /// Also handles configuration switches that control states of various WinForms features /// internal static partial class DpiHelper { /// - /// Returns a new Padding with the input's - /// dimensions converted from logical units to device units. + /// Returns a new Padding with the input's + /// dimensions converted from logical units to device units. /// /// Padding in logical units /// Padding in device units diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DragAction.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DragAction.cs index dd654b3a41e..329959e299d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DragAction.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DragAction.cs @@ -7,23 +7,23 @@ namespace System.Windows.Forms { /// - /// Specifies how and if a drag-and-drop operation should continue. + /// Specifies how and if a drag-and-drop operation should continue. /// [ComVisible(true)] public enum DragAction { /// - /// The operation will continue. + /// The operation will continue. /// Continue = 0, /// - /// The operation will stop with a drop. + /// The operation will stop with a drop. /// Drop = 1, /// - /// The operation is canceled with no drop message. + /// The operation is canceled with no drop message. /// Cancel = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DragDropEffects.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DragDropEffects.cs index dafb75fbf24..dc090fe15b2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DragDropEffects.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DragDropEffects.cs @@ -8,33 +8,33 @@ namespace System.Windows.Forms public enum DragDropEffects { /// - /// The drop target does not accept the data. + /// The drop target does not accept the data. /// None = 0x00000000, /// - /// The data is copied to the drop target. + /// The data is copied to the drop target. /// Copy = 0x00000001, /// - /// The data from the drag source is moved to the drop target. + /// The data from the drag source is moved to the drop target. /// Move = 0x00000002, /// - /// The data from the drag source is linked to the drop target. + /// The data from the drag source is linked to the drop target. /// Link = 0x00000004, /// - /// Scrolling is about to start or is currently occurring in the drop target. + /// Scrolling is about to start or is currently occurring in the drop target. /// Scroll = unchecked((int)0x80000000), /// - /// The data is copied, removed from the drag source, and scrolled in the - /// drop target. NOTE: Link is intentionally not present in All. + /// The data is copied, removed from the drag source, and scrolled in the + /// drop target. NOTE: Link is intentionally not present in All. /// All = Copy | Move | Scroll, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DragEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DragEventArgs.cs index 0bf5f90de12..a70a37b037c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DragEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DragEventArgs.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the , , - /// or event. + /// Provides data for the , , + /// or event. /// [ComVisible(true)] public class DragEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public DragEventArgs(IDataObject data, int keyState, int x, int y, DragDropEffects allowedEffect, DragDropEffects effect) { @@ -27,34 +27,34 @@ public DragEventArgs(IDataObject data, int keyState, int x, int y, DragDropEffec } /// - /// The that contains the data associated - /// with this event. + /// The that contains the data associated + /// with this event. /// public IDataObject Data { get; } /// - /// Gets the current state of the SHIFT, CTRL, and ALT keys. + /// Gets the current state of the SHIFT, CTRL, and ALT keys. /// public int KeyState { get; } /// - /// Gets the x-coordinate of the mouse pointer. + /// Gets the x-coordinate of the mouse pointer. /// public int X { get; } /// - /// Gets the y-coordinate of the mouse pointer. + /// Gets the y-coordinate of the mouse pointer. /// public int Y { get; } /// - /// Gets which drag-and-drop operations are allowed by the originator (or source) - /// of the drag event. + /// Gets which drag-and-drop operations are allowed by the originator (or source) + /// of the drag event. /// public DragDropEffects AllowedEffect { get; } /// - /// Gets or sets which drag-and-drop operations are allowed by the target of the drag event. + /// Gets or sets which drag-and-drop operations are allowed by the target of the drag event. /// public DragDropEffects Effect { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DragEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DragEventHandler.cs index 85e629ab271..f54fa81684a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DragEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DragEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , or - /// event of a . + /// event of a . /// public delegate void DragEventHandler(object sender, DragEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemEventArgs.cs index 868d3c67670..6981153976a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemEventArgs.cs @@ -7,26 +7,26 @@ namespace System.Windows.Forms { /// - /// This event is fired by owner draw Controls, such as ListBoxes and - /// ComboBoxes. It contains all the information needed for the user to - /// paint the given item, including the item index, the Rectangle in which - /// the drawing should be done, and the Graphics object with which the drawing - /// should be done. + /// This event is fired by owner draw Controls, such as ListBoxes and + /// ComboBoxes. It contains all the information needed for the user to + /// paint the given item, including the item index, the Rectangle in which + /// the drawing should be done, and the Graphics object with which the drawing + /// should be done. /// public class DrawItemEventArgs : EventArgs { /// - /// The backColor to paint each menu item with. + /// The backColor to paint each menu item with. /// private readonly Color _backColor; /// - /// The foreColor to paint each menu item with. + /// The foreColor to paint each menu item with. /// private readonly Color _foreColor; /// - /// Creates a new DrawItemEventArgs with the given parameters. + /// Creates a new DrawItemEventArgs with the given parameters. /// public DrawItemEventArgs(Graphics graphics, Font font, Rectangle rect, int index, DrawItemState state) @@ -41,7 +41,7 @@ public DrawItemEventArgs(Graphics graphics, Font font, Rectangle rect, } /// - /// Creates a new DrawItemEventArgs with the given parameters, including the foreColor and backColor of the control. + /// Creates a new DrawItemEventArgs with the given parameters, including the foreColor and backColor of the control. /// public DrawItemEventArgs(Graphics graphics, Font font, Rectangle rect, int index, DrawItemState state, Color foreColor, Color backColor) @@ -56,36 +56,36 @@ public DrawItemEventArgs(Graphics graphics, Font font, Rectangle rect, } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// A suggested font, usually the parent control's Font property. + /// A suggested font, usually the parent control's Font property. /// public Font Font { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Rectangle Bounds { get; } /// - /// The index of the item that should be painted. + /// The index of the item that should be painted. /// public int Index { get; } /// - /// Miscellaneous state information, such as whether the item is - /// "selected", "focused", or some other such information. ComboBoxes - /// have one special piece of information which indicates if the item - /// being painted is the editable portion of the ComboBox. + /// Miscellaneous state information, such as whether the item is + /// "selected", "focused", or some other such information. ComboBoxes + /// have one special piece of information which indicates if the item + /// being painted is the editable portion of the ComboBox. /// public DrawItemState State { get; } /// - /// A suggested color drawing: either SystemColors.WindowText or SystemColors.HighlightText, - /// depending on whether this item is selected. + /// A suggested color drawing: either SystemColors.WindowText or SystemColors.HighlightText, + /// depending on whether this item is selected. /// public Color ForeColor { @@ -114,7 +114,7 @@ public Color BackColor } /// - /// Draws the background of the given rectangle with the color returned from the BackColor property. + /// Draws the background of the given rectangle with the color returned from the BackColor property. /// public virtual void DrawBackground() { @@ -125,7 +125,7 @@ public virtual void DrawBackground() } /// - /// Draws a handy focus rect in the given rectangle. + /// Draws a handy focus rect in the given rectangle. /// public virtual void DrawFocusRectangle() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemState.cs index 1684266c240..5718e6c5f24 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawItemState.cs @@ -5,68 +5,68 @@ namespace System.Windows.Forms { /// - /// Specifies the state of an item that is being drawn. + /// Specifies the state of an item that is being drawn. /// [Flags] public enum DrawItemState { /// - /// The item is checked. Only menu controls use this value. + /// The item is checked. Only menu controls use this value. /// Checked = NativeMethods.ODS_CHECKED, /// - /// The item is the editing portion of a . + /// The item is the editing portion of a . /// ComboBoxEdit = NativeMethods.ODS_COMBOBOXEDIT, /// - /// The item is the default item of the control. + /// The item is the default item of the control. /// Default = NativeMethods.ODS_DEFAULT, /// - /// The item is disabled. + /// The item is disabled. /// Disabled = NativeMethods.ODS_DISABLED, /// - /// The item has focus. + /// The item has focus. /// Focus = NativeMethods.ODS_FOCUS, /// - /// The item is grayed. Only menu controls use this value. + /// The item is grayed. Only menu controls use this value. /// Grayed = NativeMethods.ODS_GRAYED, /// - /// The item is being hot-tracked. + /// The item is being hot-tracked. /// HotLight = NativeMethods.ODS_HOTLIGHT, /// - /// The item is inactive. + /// The item is inactive. /// Inactive = NativeMethods.ODS_INACTIVE, /// - /// The item displays without a keyboard accelarator. + /// The item displays without a keyboard accelarator. /// NoAccelerator = NativeMethods.ODS_NOACCEL, /// - /// The item displays without the visual cue that indicates it has the focus. + /// The item displays without the visual cue that indicates it has the focus. /// NoFocusRect = NativeMethods.ODS_NOFOCUSRECT, /// - /// The item is selected. + /// The item is selected. /// Selected = NativeMethods.ODS_SELECTED, /// - /// The item is in its default visual state. + /// The item is in its default visual state. /// None = 0, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventArgs.cs index da25fb61946..f94c2a87850 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventArgs.cs @@ -8,13 +8,13 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint ListView - /// column header (Details view only). + /// This class contains the information a user needs to paint ListView + /// column header (Details view only). /// public class DrawListViewColumnHeaderEventArgs : EventArgs { /// - /// Creates a new DrawListViewColumnHeaderEventArgs with the given parameters. + /// Creates a new DrawListViewColumnHeaderEventArgs with the given parameters. /// public DrawListViewColumnHeaderEventArgs(Graphics graphics, Rectangle bounds, int columnIndex, ColumnHeader header, ListViewItemStates state, @@ -31,52 +31,52 @@ public DrawListViewColumnHeaderEventArgs(Graphics graphics, Rectangle bounds, in } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Rectangle Bounds { get; } /// - /// The index of this column. + /// The index of this column. /// public int ColumnIndex { get; } /// - /// The header object. + /// The header object. /// public ColumnHeader Header { get; } /// - /// State information pertaining to the header. + /// State information pertaining to the header. /// public ListViewItemStates State { get; } /// - /// Color used to draw the header's text. + /// Color used to draw the header's text. /// public Color ForeColor { get; } /// - /// Color used to draw the header's background. + /// Color used to draw the header's background. /// public Color BackColor { get; } /// - /// Font used to render the header's text. + /// Font used to render the header's text. /// public Font Font { get; } /// - /// Causes the item do be drawn by the system instead of owner drawn. + /// Causes the item do be drawn by the system instead of owner drawn. /// public bool DrawDefault { get; set; } /// - /// Draws the header's background. + /// Draws the header's background. /// public void DrawBackground() { @@ -115,7 +115,7 @@ public void DrawBackground() } /// - /// Draws the header's text (overloaded) + /// Draws the header's text (overloaded) /// public void DrawText() { @@ -129,7 +129,7 @@ public void DrawText() } /// - /// Draws the header's text (overloaded) - takes a TextFormatFlags argument. + /// Draws the header's text (overloaded) - takes a TextFormatFlags argument. /// public void DrawText(TextFormatFlags flags) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventHandler.cs index 105e3ce109d..5d45a337c87 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewColumnHeaderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the ListView's DrawColumnHeader event. + /// Handler for the ListView's DrawColumnHeader event. /// public delegate void DrawListViewColumnHeaderEventHandler(object sender, DrawListViewColumnHeaderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventArgs.cs index 144718ecdbd..51303e5f6c4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint ListView items. + /// This class contains the information a user needs to paint ListView items. /// public class DrawListViewItemEventArgs : EventArgs { /// - /// Creates a new DrawListViewItemEventArgs with the given parameters. + /// Creates a new DrawListViewItemEventArgs with the given parameters. /// public DrawListViewItemEventArgs(Graphics graphics, ListViewItem item, Rectangle bounds, int itemIndex, ListViewItemStates state) { @@ -24,37 +24,37 @@ public DrawListViewItemEventArgs(Graphics graphics, ListViewItem item, Rectangle } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// The item to be painted. + /// The item to be painted. /// public ListViewItem Item { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Rectangle Bounds { get; } /// - /// The index of the item that should be painted. + /// The index of the item that should be painted. /// public int ItemIndex { get; } /// - /// Miscellaneous state information. + /// Miscellaneous state information. /// public ListViewItemStates State { get; } /// - /// Causes the item do be drawn by the system instead of owner drawn. + /// Causes the item do be drawn by the system instead of owner drawn. /// public bool DrawDefault { get; set; } /// - /// Draws the item's background. + /// Draws the item's background. /// public void DrawBackground() { @@ -65,8 +65,8 @@ public void DrawBackground() } /// - /// Draws a focus rectangle in the given bounds, if the item is focused. In Details View, if FullRowSelect is - /// true, the rectangle is drawn around the whole item, else around the first sub-item's text area. + /// Draws a focus rectangle in the given bounds, if the item is focused. In Details View, if FullRowSelect is + /// true, the rectangle is drawn around the whole item, else around the first sub-item's text area. /// public void DrawFocusRectangle() { @@ -77,12 +77,12 @@ public void DrawFocusRectangle() } /// - /// Draws the item's text (overloaded) - useful only when View != View.Details + /// Draws the item's text (overloaded) - useful only when View != View.Details /// public void DrawText() => DrawText(TextFormatFlags.Left); /// - /// Draws the item's text (overloaded) - useful only when View != View.Details - takes a TextFormatFlags argument. + /// Draws the item's text (overloaded) - useful only when View != View.Details - takes a TextFormatFlags argument. /// public void DrawText(TextFormatFlags flags) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventHandler.cs index 0d578b62adf..1f2b4075685 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewItemEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the ListView's DrawItem event. + /// Handler for the ListView's DrawItem event. /// public delegate void DrawListViewItemEventHandler(object sender, DrawListViewItemEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventArgs.cs index 7f42f91d797..6f2d9a5a0e1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint ListView sub-items (Details view only). + /// This class contains the information a user needs to paint ListView sub-items (Details view only). /// public class DrawListViewSubItemEventArgs : EventArgs { /// - /// Creates a new DrawListViewSubItemEventArgs with the given parameters. + /// Creates a new DrawListViewSubItemEventArgs with the given parameters. /// public DrawListViewSubItemEventArgs(Graphics graphics, Rectangle bounds, ListViewItem item, ListViewItem.ListViewSubItem subItem, int itemIndex, int columnIndex, @@ -45,52 +45,52 @@ public DrawListViewSubItemEventArgs(Graphics graphics, Rectangle bounds, ListVie } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Rectangle Bounds { get; } /// - /// The parent item. + /// The parent item. /// public ListViewItem Item { get; } /// - /// The parent item. + /// The parent item. /// public ListViewItem.ListViewSubItem SubItem { get; } /// - /// The index in the ListView of the parent item. + /// The index in the ListView of the parent item. /// public int ItemIndex { get; } /// - /// The column index of this sub-item. + /// The column index of this sub-item. /// public int ColumnIndex { get; } /// - /// The header of this sub-item's column + /// The header of this sub-item's column /// public ColumnHeader Header { get; } /// - /// Miscellaneous state information pertaining to the parent item. + /// Miscellaneous state information pertaining to the parent item. /// public ListViewItemStates ItemState { get; } /// - /// Causes the item do be drawn by the system instead of owner drawn. + /// Causes the item do be drawn by the system instead of owner drawn. /// public bool DrawDefault { get; set; } /// - /// Draws the sub-item's background. + /// Draws the sub-item's background. /// public void DrawBackground() { @@ -102,7 +102,7 @@ public void DrawBackground() } /// - /// Draws a focus rectangle in the given bounds, if the item has focus. + /// Draws a focus rectangle in the given bounds, if the item has focus. /// public void DrawFocusRectangle(Rectangle bounds) { @@ -118,7 +118,7 @@ public void DrawFocusRectangle(Rectangle bounds) } /// - /// Draws the sub-item's text (overloaded) + /// Draws the sub-item's text (overloaded) /// public void DrawText() { @@ -133,7 +133,7 @@ public void DrawText() } /// - /// Draws the sub-item's text (overloaded) - takes a TextFormatFlags argument. + /// Draws the sub-item's text (overloaded) - takes a TextFormatFlags argument. /// public void DrawText(TextFormatFlags flags) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventHandler.cs index 1694afc6127..1bffef7b210 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawListViewSubItemEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the ListView's DrawSubItem event. + /// Handler for the ListView's DrawSubItem event. /// public delegate void DrawListViewSubItemEventHandler(object sender, DrawListViewSubItemEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawMode.cs index 20b61bbb011..8b4a3630069 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawMode.cs @@ -5,25 +5,25 @@ namespace System.Windows.Forms { /// - /// Specifies responsibility for drawing a control or portion of a control. + /// Specifies responsibility for drawing a control or portion of a control. /// public enum DrawMode { /// - /// The operating system paints the items in the control, and the items - /// are each the same height. + /// The operating system paints the items in the control, and the items + /// are each the same height. /// Normal = 0, /// - /// The programmer explicitly paints the items in the control, and the - /// items are each the same height. + /// The programmer explicitly paints the items in the control, and the + /// items are each the same height. /// OwnerDrawFixed = 1, /// - /// The programmer explicitly paints the items in the control manually, - /// and they may be different heights. + /// The programmer explicitly paints the items in the control manually, + /// and they may be different heights. /// OwnerDrawVariable = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventArgs.cs index 5978195777e..7d14bd55dbb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint the ToolTip. + /// This class contains the information a user needs to paint the ToolTip. /// public class DrawToolTipEventArgs : EventArgs { @@ -15,7 +15,7 @@ public class DrawToolTipEventArgs : EventArgs private readonly Color _foreColor; /// - /// Creates a new DrawToolTipEventArgs with the given parameters. + /// Creates a new DrawToolTipEventArgs with the given parameters. /// public DrawToolTipEventArgs(Graphics graphics, IWin32Window associatedWindow, Control associatedControl, Rectangle bounds, string toolTipText, Color backColor, Color foreColor, Font font) @@ -31,17 +31,17 @@ public DrawToolTipEventArgs(Graphics graphics, IWin32Window associatedWindow, Co } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// The window for which the tooltip is being painted. + /// The window for which the tooltip is being painted. /// public IWin32Window AssociatedWindow { get; } /// - /// The control for which the tooltip is being painted. + /// The control for which the tooltip is being painted. /// public Control AssociatedControl { get; } @@ -51,17 +51,17 @@ public DrawToolTipEventArgs(Graphics graphics, IWin32Window associatedWindow, Co public Rectangle Bounds { get; } /// - /// The text that should be drawn. + /// The text that should be drawn. /// public string ToolTipText { get; } /// - /// The font used to draw tooltip text. + /// The font used to draw tooltip text. /// public Font Font { get; } /// - /// Draws the background of the ToolTip. + /// Draws the background of the ToolTip. /// public void DrawBackground() { @@ -72,7 +72,7 @@ public void DrawBackground() } /// - /// Draws the text (overloaded) + /// Draws the text (overloaded) /// public void DrawText() { @@ -81,7 +81,7 @@ public void DrawText() } /// - /// Draws the text (overloaded) - takes a TextFormatFlags argument. + /// Draws the text (overloaded) - takes a TextFormatFlags argument. /// public void DrawText(TextFormatFlags flags) { @@ -89,7 +89,7 @@ public void DrawText(TextFormatFlags flags) } /// - /// Draws a border for the ToolTip similar to the default border. + /// Draws a border for the ToolTip similar to the default border. /// public void DrawBorder() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventHandler.cs index ccabdf8ed01..e9c5772bd81 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawToolTipEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the Draw event of the ToolTip control. + /// Handler for the Draw event of the ToolTip control. /// public delegate void DrawToolTipEventHandler(object sender, DrawToolTipEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventArgs.cs index a472d9f8423..fcf642149bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint TreeView nodes. + /// This class contains the information a user needs to paint TreeView nodes. /// public class DrawTreeNodeEventArgs : EventArgs { /// - /// Creates a new DrawTreeNodeEventArgs with the given parameters. + /// Creates a new DrawTreeNodeEventArgs with the given parameters. /// public DrawTreeNodeEventArgs(Graphics graphics, TreeNode node, Rectangle bounds, TreeNodeStates state) { @@ -23,28 +23,28 @@ public DrawTreeNodeEventArgs(Graphics graphics, TreeNode node, Rectangle bounds, } /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// public Graphics Graphics { get; } /// - /// The node to be painted. + /// The node to be painted. /// public TreeNode Node { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Rectangle Bounds { get; } /// - /// Miscellaneous state information. + /// Miscellaneous state information. /// public TreeNodeStates State { get; } /// - /// Causes the item do be drawn by the system instead of owner drawn. - /// NOTE: In OwnerDrawText mode, setting this to true is same as calling DrawText. + /// Causes the item do be drawn by the system instead of owner drawn. + /// NOTE: In OwnerDrawText mode, setting this to true is same as calling DrawText. /// public bool DrawDefault { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventHandler.cs index b98a0d6b1cd..cd73db48d76 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/DrawTreeNodeEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the DrawTreeNode event of the TreeView control. + /// Handler for the DrawTreeNode event of the TreeView control. /// public delegate void DrawTreeNodeEventHandler(object sender, DrawTreeNodeEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorBlinkStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorBlinkStyle.cs index 104157252a2..a0f7f6390cd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorBlinkStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorBlinkStyle.cs @@ -5,27 +5,27 @@ namespace System.Windows.Forms { /// - /// Describes the times that the error icon supplied by an ErrorProvider - /// should blink to alert the user that an error has occurred. + /// Describes the times that the error icon supplied by an ErrorProvider + /// should blink to alert the user that an error has occurred. /// public enum ErrorBlinkStyle { /// - /// Blink only if the error icon is already displayed, but a new - /// error string is set for the control. If the icon did not blink - /// in this case, the user might not know that there is a new error. + /// Blink only if the error icon is already displayed, but a new + /// error string is set for the control. If the icon did not blink + /// in this case, the user might not know that there is a new error. /// BlinkIfDifferentError, /// - /// Blink the error icon when the error is first displayed, or when - /// a new error description string is set for the control and the - /// error icon is already displayed. + /// Blink the error icon when the error is first displayed, or when + /// a new error description string is set for the control and the + /// error icon is already displayed. /// AlwaysBlink, /// - /// Never blink the error icon. + /// Never blink the error icon. /// NeverBlink } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorIconAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorIconAlignment.cs index 9e8747dd719..a9984f24e7c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorIconAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorIconAlignment.cs @@ -5,44 +5,44 @@ namespace System.Windows.Forms { /// - /// Describes the set of locations that an error icon can appear in - /// relation to the control with the error. + /// Describes the set of locations that an error icon can appear in + /// relation to the control with the error. /// public enum ErrorIconAlignment { /// - /// The icon appears aligned with the top of the control, and to the - /// left of the control. + /// The icon appears aligned with the top of the control, and to the + /// left of the control. /// TopLeft, /// - /// The icon appears aligned with the top of the control, and to the - /// right of the control. + /// The icon appears aligned with the top of the control, and to the + /// right of the control. /// TopRight, /// - /// The icon appears aligned with the middle of the control, and the - /// left of the control. + /// The icon appears aligned with the middle of the control, and the + /// left of the control. /// MiddleLeft, /// - /// The icon appears aligned with the middle of the control, and the - /// right of the control. + /// The icon appears aligned with the middle of the control, and the + /// right of the control. /// MiddleRight, /// - /// The icon appears aligned with the bottom of the control, and the - /// left of the control. + /// The icon appears aligned with the bottom of the control, and the + /// left of the control. /// BottomLeft, /// - /// The icon appears aligned with the bottom of the control, and the - /// right of the control. + /// The icon appears aligned with the bottom of the control, and the + /// right of the control. /// BottomRight } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorProvider.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorProvider.cs index 58432a3b22a..3ee17f75d41 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ErrorProvider.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ErrorProvider.cs @@ -13,11 +13,11 @@ namespace System.Windows.Forms { /// - /// ErrorProvider presents a simple user interface for indicating to the - /// user that a control on a form has an error associated with it. If a - /// error description string is specified for the control, then an icon - /// will appear next to the control, and when the mouse hovers over the - /// icon, a tooltip will appear showing the error description string. + /// ErrorProvider presents a simple user interface for indicating to the + /// user that a control on a form has an error associated with it. If a + /// error description string is specified for the control, then an icon + /// will appear next to the control, and when the mouse hovers over the + /// icon, a tooltip will appear showing the error description string. /// [ProvideProperty("IconPadding", typeof(Control))] [ProvideProperty("IconAlignment", typeof(Control))] @@ -61,7 +61,7 @@ public class ErrorProvider : Component, IExtenderProvider, ISupportInitialize private bool _rightToLeft = false; /// - /// Default constructor. + /// Default constructor. /// public ErrorProvider() { @@ -114,7 +114,7 @@ public override ISite Site } /// - /// Returns or sets when the error icon flashes. + /// Returns or sets when the error icon flashes. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(DefaultBlinkStyle)] @@ -167,9 +167,9 @@ public ErrorBlinkStyle BlinkStyle } /// - /// Indicates what container control (usually the form) should be inspected for bindings. - /// A binding will reveal what control to place errors on for a error in the current row - /// in the DataSource/DataMember pair. + /// Indicates what container control (usually the form) should be inspected for bindings. + /// A binding will reveal what control to place errors on for a error in the current row + /// in the DataSource/DataMember pair. /// [DefaultValue(null)] [SRCategory(nameof(SR.CatData))] @@ -201,8 +201,8 @@ public ContainerControl ContainerControl } /// - /// This is used for international applications where the language is written from RightToLeft. - /// When this property is true, text will be from right to left. + /// This is used for international applications where the language is written from RightToLeft. + /// When this property is true, text will be from right to left. /// [SRCategory(nameof(SR.CatAppearance))] [Localizable(true)] @@ -232,7 +232,7 @@ public event EventHandler RightToLeftChanged } /// - /// User defined data associated with the control. + /// User defined data associated with the control. /// [SRCategory(nameof(SR.CatData))] [Localizable(false)] @@ -302,7 +302,7 @@ private void SetErrorManager(object newDataSource, string newDataMember, bool fo } /// - /// Indicates the source of data to bind errors against. + /// Indicates the source of data to bind errors against. /// [DefaultValue(null)] [SRCategory(nameof(SR.CatData))] @@ -334,7 +334,7 @@ public object DataSource private bool ShouldSerializeDataSource() => _dataSource != null; /// - /// Indicates the sub-list of data from the DataSource to bind errors against. + /// Indicates the sub-list of data from the DataSource to bind errors against. /// [DefaultValue(null)] [SRCategory(nameof(SR.CatData))] @@ -515,7 +515,7 @@ private void ErrorManager_CurrentChanged(object sender, EventArgs e) } /// - /// Returns or set the rate in milliseconds at which the error icon flashes. + /// Returns or set the rate in milliseconds at which the error icon flashes. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(DefaultBlinkRate)] @@ -541,7 +541,7 @@ public int BlinkRate } /// - /// Demand load and cache the default icon. + /// Demand load and cache the default icon. /// private static Icon DefaultIcon { @@ -560,9 +560,9 @@ private static Icon DefaultIcon } /// - /// Returns or sets the Icon that displayed next to a control when an error - /// description string has been set for the control. For best results, an - /// icon containing a 16 by 16 icon should be used. + /// Returns or sets the Icon that displayed next to a control when an error + /// description string has been set for the control. For best results, an + /// icon containing a 16 by 16 icon should be used. /// [Localizable(true)] [SRCategory(nameof(SR.CatAppearance))] @@ -587,12 +587,12 @@ public Icon Icon } /// - /// Create the icon region on demand. + /// Create the icon region on demand. /// internal IconRegion Region => _region ??= new IconRegion(Icon); /// - /// Begin bulk member initialization - deferring binding to data source until EndInit is reached + /// Begin bulk member initialization - deferring binding to data source until EndInit is reached /// void ISupportInitialize.BeginInit() { @@ -600,7 +600,7 @@ void ISupportInitialize.BeginInit() } /// - /// End bulk member initialization by binding to data source + /// End bulk member initialization by binding to data source /// private void EndInitCore() { @@ -614,9 +614,9 @@ private void EndInitCore() } /// - /// Check to see if DataSource has completed its initialization, before ending our initialization. - /// If DataSource is still initializing, hook its Initialized event and wait for it to signal completion. - /// If DataSource is already initialized, just go ahead and complete our initialization now. + /// Check to see if DataSource has completed its initialization, before ending our initialization. + /// If DataSource is still initializing, hook its Initialized event and wait for it to signal completion. + /// If DataSource is already initialized, just go ahead and complete our initialization now. /// void ISupportInitialize.EndInit() { @@ -631,9 +631,9 @@ void ISupportInitialize.EndInit() } /// - /// Respond to late completion of the DataSource's initialization, by completing our own initialization. - /// This situation can arise if the call to the DataSource's EndInit() method comes after the call to the - /// BindingSource's EndInit() method (since code-generated ordering of these calls is non-deterministic). + /// Respond to late completion of the DataSource's initialization, by completing our own initialization. + /// This situation can arise if the call to the DataSource's EndInit() method comes after the call to the + /// BindingSource's EndInit() method (since code-generated ordering of these calls is non-deterministic). /// private void DataSource_Initialized(object sender, EventArgs e) { @@ -651,7 +651,7 @@ private void DataSource_Initialized(object sender, EventArgs e) } /// - /// Clears all errors being tracked by this error provider, ie. undoes all previous calls to SetError. + /// Clears all errors being tracked by this error provider, ie. undoes all previous calls to SetError. /// public void Clear() { @@ -671,7 +671,7 @@ public void Clear() } /// - /// Returns whether a control can be extended. + /// Returns whether a control can be extended. /// public bool CanExtend(object extendee) { @@ -679,8 +679,8 @@ public bool CanExtend(object extendee) } /// - /// Release any resources that this component is using. After calling Dispose, - /// the component should no longer be used. + /// Release any resources that this component is using. After calling Dispose, + /// the component should no longer be used. /// protected override void Dispose(bool disposing) { @@ -694,7 +694,7 @@ protected override void Dispose(bool disposing) } /// - /// Helper to dispose the cached icon region. + /// Helper to dispose the cached icon region. /// void DisposeRegion() { @@ -706,7 +706,7 @@ void DisposeRegion() } /// - /// Helper to make sure we have allocated a control item for this control. + /// Helper to make sure we have allocated a control item for this control. /// private ControlItem EnsureControlItem(Control control) { @@ -725,7 +725,7 @@ private ControlItem EnsureControlItem(Control control) } /// - /// Helper to make sure we have allocated an error window for this control. + /// Helper to make sure we have allocated an error window for this control. /// internal ErrorWindow EnsureErrorWindow(Control parent) { @@ -740,7 +740,7 @@ internal ErrorWindow EnsureErrorWindow(Control parent) } /// - /// Returns the current error description string for the specified control. + /// Returns the current error description string for the specified control. /// [DefaultValue("")] [Localizable(true)] @@ -749,7 +749,7 @@ internal ErrorWindow EnsureErrorWindow(Control parent) public string GetError(Control control) => EnsureControlItem(control).Error; /// - /// Returns where the error icon should be placed relative to the control. + /// Returns where the error icon should be placed relative to the control. /// [DefaultValue(DefaultIconAlignment)] [Localizable(true)] @@ -758,7 +758,7 @@ internal ErrorWindow EnsureErrorWindow(Control parent) public ErrorIconAlignment GetIconAlignment(Control control) => EnsureControlItem(control).IconAlignment; /// - /// Returns the amount of extra space to leave next to the error icon. + /// Returns the amount of extra space to leave next to the error icon. /// [DefaultValue(0)] [Localizable(true)] @@ -780,7 +780,7 @@ protected virtual void OnRightToLeftChanged(EventArgs e) } /// - /// Sets the error description string for the specified control. + /// Sets the error description string for the specified control. /// public void SetError(Control control, string value) { @@ -788,7 +788,7 @@ public void SetError(Control control, string value) } /// - /// Sets where the error icon should be placed relative to the control. + /// Sets where the error icon should be placed relative to the control. /// public void SetIconAlignment(Control control, ErrorIconAlignment value) { @@ -796,7 +796,7 @@ public void SetIconAlignment(Control control, ErrorIconAlignment value) } /// - /// Sets the amount of extra space to leave next to the error icon. + /// Sets the amount of extra space to leave next to the error icon. /// public void SetIconPadding(Control control, int padding) { @@ -806,12 +806,12 @@ public void SetIconPadding(Control control, int padding) private bool ShouldSerializeIcon() => Icon != DefaultIcon; /// - /// There is one ErrorWindow for each control parent. It is parented to the - /// control parent. The window's region is made up of the regions from icons - /// of all child icons. The window's size is the enclosing rectangle for all - /// the regions. A tooltip window is created as a child of this window. The - /// rectangle associated with each error icon being displayed is added as a - /// tool to the tooltip window. + /// There is one ErrorWindow for each control parent. It is parented to the + /// control parent. The window's region is made up of the regions from icons + /// of all child icons. The window's size is the enclosing rectangle for all + /// the regions. A tooltip window is created as a child of this window. The + /// rectangle associated with each error icon being displayed is added as a + /// tool to the tooltip window. /// internal class ErrorWindow : NativeWindow { @@ -828,7 +828,7 @@ internal class ErrorWindow : NativeWindow private DeviceContextMapMode _mirrordcMode = DeviceContextMapMode.Text; /// - /// Construct an error window for this provider and control parent. + /// Construct an error window for this provider and control parent. /// public ErrorWindow(ErrorProvider provider, Control parent) { @@ -837,7 +837,7 @@ public ErrorWindow(ErrorProvider provider, Control parent) } /// - /// This is called when a control would like to show an error icon. + /// This is called when a control would like to show an error icon. /// public void Add(ControlItem item) { @@ -859,12 +859,12 @@ public void Add(ControlItem item) } /// - /// Called to get rid of any resources the Object may have. + /// Called to get rid of any resources the Object may have. /// public void Dispose() => EnsureDestroyed(); /// - /// Make sure the error window is created, and the tooltip window is created. + /// Make sure the error window is created, and the tooltip window is created. /// bool EnsureCreated() { @@ -912,7 +912,7 @@ bool EnsureCreated() } /// - /// Destroy the timer, toolwindow, and the error window itself. + /// Destroy the timer, toolwindow, and the error window itself. /// private void EnsureDestroyed() { @@ -948,12 +948,12 @@ private void EnsureDestroyed() } /// - /// Since we added mirroring to certain controls, we need to make sure the - /// error icons show up in the correct place. We cannot mirror the errorwindow - /// in EnsureCreated (although that would have been really easy), since we use - /// GDI+ for some of this code, and as we all know, GDI+ does not handle mirroring - /// at all. - /// To work around that we create our own mirrored dc when we need to. + /// Since we added mirroring to certain controls, we need to make sure the + /// error icons show up in the correct place. We cannot mirror the errorwindow + /// in EnsureCreated (although that would have been really easy), since we use + /// GDI+ for some of this code, and as we all know, GDI+ does not handle mirroring + /// at all. + /// To work around that we create our own mirrored dc when we need to. /// private void CreateMirrorDC(IntPtr hdc, int originOffset) { @@ -990,8 +990,8 @@ private void RestoreMirrorDC() } /// - /// This is called when the error window needs to paint. We paint each icon at its - /// correct location. + /// This is called when the error window needs to paint. We paint each icon at its + /// correct location. /// private void OnPaint(ref Message m) { @@ -1027,7 +1027,7 @@ protected override void OnThreadException(Exception e) } /// - /// This is called when an error icon is flashing, and the view needs to be updatd. + /// This is called when an error icon is flashing, and the view needs to be updatd. /// private void OnTimer(object sender, EventArgs e) { @@ -1067,7 +1067,7 @@ private void OnToolTipVisibilityChanging(IntPtr id, bool toolTipShown) } /// - /// This is called when a control no longer needs to display an error icon. + /// This is called when a control no longer needs to display an error icon. /// public void Remove(ControlItem item) { @@ -1093,8 +1093,8 @@ public void Remove(ControlItem item) } /// - /// Start the blinking process. The timer will fire until there are no more - /// icons that need to blink. + /// Start the blinking process. The timer will fire until there are no more + /// icons that need to blink. /// public void StartBlinking() { @@ -1116,9 +1116,9 @@ public void StopBlinking() } /// - /// Move and size the error window, compute and set the window region, set the tooltip - /// rectangles and descriptions. This basically brings the error window up to date with - /// the internal data structures. + /// Move and size the error window, compute and set the window region, set the tooltip + /// rectangles and descriptions. This basically brings the error window up to date with + /// the internal data structures. /// public void Update(bool timerCaused) { @@ -1250,7 +1250,7 @@ public void Update(bool timerCaused) } /// - /// Called when the error window gets a windows message. + /// Called when the error window gets a windows message. /// protected override void WndProc(ref Message m) { @@ -1276,8 +1276,8 @@ protected override void WndProc(ref Message m) } /// - /// There is one ControlItem for each control that the ErrorProvider is tracking state for. - /// It contains the values of all the extender properties. + /// There is one ControlItem for each control that the ErrorProvider is tracking state for. + /// It contains the values of all the extender properties. /// internal class ControlItem { @@ -1290,8 +1290,8 @@ internal class ControlItem private const int _startingBlinkPhase = 10; // We want to blink 5 times /// - /// Construct the item with its associated control, provider, and a unique ID. The ID is - /// used for the tooltip ID. + /// Construct the item with its associated control, provider, and a unique ID. The ID is + /// used for the tooltip ID. /// public ControlItem(ErrorProvider provider, Control control, IntPtr id) { @@ -1324,22 +1324,22 @@ public void Dispose() } /// - /// Returns the unique ID for this control. The ID used as the tooltip ID. + /// Returns the unique ID for this control. The ID used as the tooltip ID. /// public IntPtr Id { get; } /// - /// Returns or set the phase of blinking that this control is currently - /// in. If zero, the control is not blinking. If odd, then the control - /// is blinking, but invisible. If even, the control is blinking and - /// currently visible. Each time the blink timer fires, this value is - /// reduced by one (until zero), thus causing the error icon to appear - /// or disappear. + /// Returns or set the phase of blinking that this control is currently + /// in. If zero, the control is not blinking. If odd, then the control + /// is blinking, but invisible. If even, the control is blinking and + /// currently visible. Each time the blink timer fires, this value is + /// reduced by one (until zero), thus causing the error icon to appear + /// or disappear. /// public int BlinkPhase { get; set; } /// - /// Returns or sets the icon padding for the control. + /// Returns or sets the icon padding for the control. /// public int IconPadding { @@ -1357,7 +1357,7 @@ public int IconPadding } /// - /// Returns or sets the error description string for the control. + /// Returns or sets the error description string for the control. /// public string Error { @@ -1404,7 +1404,7 @@ public string Error } /// - /// Returns or sets the location of the error icon for the control. + /// Returns or sets the location of the error icon for the control. /// public ErrorIconAlignment IconAlignment { @@ -1427,7 +1427,7 @@ public ErrorIconAlignment IconAlignment } /// - /// Returns true if the tooltip for this control item is currently shown. + /// Returns true if the tooltip for this control item is currently shown. /// public bool ToolTipShown { get; set; } @@ -1461,8 +1461,8 @@ internal ErrorIconAlignment RTLTranslateIconAlignment(ErrorIconAlignment align) } /// - /// Returns the location of the icon in the same coordinate system as the control being - /// extended. The size passed in is the size of the icon. + /// Returns the location of the icon in the same coordinate system as the control being + /// extended. The size passed in is the size of the icon. /// internal Rectangle GetIconBounds(Size size) { @@ -1503,14 +1503,14 @@ internal Rectangle GetIconBounds(Size size) } /// - /// If this control's error icon has been added to the error window, then update the - /// window state because some property has changed. + /// If this control's error icon has been added to the error window, then update the + /// window state because some property has changed. /// private void UpdateWindow() => _window?.Update(timerCaused: false); /// - /// If this control's error icon has been added to the error window, then start blinking - /// the error window. + /// If this control's error icon has been added to the error window, then start blinking + /// the error window. /// private void StartBlinking() { @@ -1522,7 +1522,7 @@ private void StartBlinking() } /// - /// Add this control's error icon to the error window. + /// Add this control's error icon to the error window. /// private void AddToWindow() { @@ -1543,7 +1543,7 @@ private void AddToWindow() } /// - /// Remove this control's error icon from the error window. + /// Remove this control's error icon from the error window. /// private void RemoveFromWindow() { @@ -1555,7 +1555,7 @@ private void RemoveFromWindow() } /// - /// This is called when a property on the control is changed. + /// This is called when a property on the control is changed. /// private void OnBoundsChanged(object sender, EventArgs e) => UpdateWindow(); @@ -1567,18 +1567,18 @@ void OnParentVisibleChanged(object sender, EventArgs e) } /// - /// This is called when the control's handle is created. + /// This is called when the control's handle is created. /// private void OnCreateHandle(object sender, EventArgs e) => AddToWindow(); /// - /// This is called when the control's handle is destroyed. + /// This is called when the control's handle is destroyed. /// private void OnDestroyHandle(object sender, EventArgs e) => RemoveFromWindow(); } /// - /// This represents the HRGN of icon. The region is calculate from the icon's mask. + /// This represents the HRGN of icon. The region is calculate from the icon's mask. /// internal class IconRegion { @@ -1586,7 +1586,7 @@ internal class IconRegion private readonly Icon icon; /// - /// Constructor that takes an Icon and extracts its 16x16 version. + /// Constructor that takes an Icon and extracts its 16x16 version. /// public IconRegion(Icon icon) { @@ -1594,12 +1594,12 @@ public IconRegion(Icon icon) } /// - /// Returns the handle of the icon. + /// Returns the handle of the icon. /// public IntPtr IconHandle => icon.Handle; /// - /// Returns the handle of the region. + /// Returns the handle of the region. /// public Region Region { @@ -1654,12 +1654,12 @@ public Region Region } /// - /// Return the size of the icon. + /// Return the size of the icon. /// public Size Size => icon.Size; /// - /// Release any resources held by this Object. + /// Release any resources held by this Object. /// public void Dispose() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FeatureSupport.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FeatureSupport.cs index d4d6bca2289..7bc906e2625 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FeatureSupport.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FeatureSupport.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Provides methods for retrieving feature information from the - /// current system. + /// Provides methods for retrieving feature information from the + /// current system. /// public abstract class FeatureSupport : IFeatureSupport { /// - /// Determines whether any version of the specified feature is installed in the system. - /// This method is . + /// Determines whether any version of the specified feature is installed in the system. + /// This method is . /// public static bool IsPresent(string featureClassName, string featureConstName) { @@ -20,8 +20,8 @@ public static bool IsPresent(string featureClassName, string featureConstName) } /// - /// Determines whether the specified or newer version of the specified feature is - /// installed in the system. This method is . + /// Determines whether the specified or newer version of the specified feature is + /// installed in the system. This method is . /// public static bool IsPresent(string featureClassName, string featureConstName, Version minimumVersion) { @@ -45,7 +45,7 @@ public static bool IsPresent(string featureClassName, string featureConstName, V } /// - /// Gets the version of the specified feature that is available on the system. + /// Gets the version of the specified feature that is available on the system. /// public static Version GetVersionPresent(string featureClassName, string featureConstName) { @@ -69,13 +69,13 @@ public static Version GetVersionPresent(string featureClassName, string featureC } /// - /// Determines whether any version of the specified feature is installed in the system. + /// Determines whether any version of the specified feature is installed in the system. /// public virtual bool IsPresent(object feature) => IsPresent(feature, new Version(0, 0, 0, 0)); /// - /// Determines whether the specified or newer version of the specified feature is - /// installed in the system. + /// Determines whether the specified or newer version of the specified feature is + /// installed in the system. /// public virtual bool IsPresent(object feature, Version minimumVersion) { @@ -89,8 +89,8 @@ public virtual bool IsPresent(object feature, Version minimumVersion) } /// - /// When overridden in a derived class, gets the version of the specified feature that - /// is available on the system. + /// When overridden in a derived class, gets the version of the specified feature that + /// is available on the system. /// public abstract Version GetVersionPresent(object feature); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog.cs index f09532155cc..b622a6ac485 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// Displays a dialog window from which the user can select a file. + /// Displays a dialog window from which the user can select a file. /// [DefaultEvent(nameof(FileOk))] [DefaultProperty(nameof(FileName))] @@ -37,8 +37,8 @@ public abstract partial class FileDialog : CommonDialog private IntPtr _dialogHWnd; /// - /// In an inherited class, initializes a new instance of the - /// class. + /// In an inherited class, initializes a new instance of the + /// class. /// internal FileDialog() { @@ -46,8 +46,8 @@ internal FileDialog() } /// - /// Gets or sets a value indicating whether the dialog box automatically adds an - /// extension to a file name if the user omits the extension. + /// Gets or sets a value indicating whether the dialog box automatically adds an + /// extension to a file name if the user omits the extension. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -59,8 +59,8 @@ public bool AddExtension } /// - /// Gets or sets a value indicating whether the dialog box displays a warning - /// if the user specifies a file name that does not exist. + /// Gets or sets a value indicating whether the dialog box displays a warning + /// if the user specifies a file name that does not exist. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -72,8 +72,8 @@ public virtual bool CheckFileExists } /// - /// Gets or sets a value indicating whether the dialog box displays a warning if - /// the user specifies a path that does not exist. + /// Gets or sets a value indicating whether the dialog box displays a warning if + /// the user specifies a path that does not exist. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -85,7 +85,7 @@ public bool CheckPathExists } /// - /// Gets or sets the default file extension. + /// Gets or sets the default file extension. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue("")] @@ -112,9 +112,9 @@ public string DefaultExt } /// - /// Gets or sets a value indicating whether the dialog box returns the location - /// of the file referenced by the shortcut or whether it returns the location - /// of the shortcut (.lnk). + /// Gets or sets a value indicating whether the dialog box returns the location + /// of the file referenced by the shortcut or whether it returns the location + /// of the shortcut (.lnk). /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -128,7 +128,7 @@ public bool DereferenceLinks private protected string DialogCaption => Interop.User32.GetWindowText(new HandleRef(this, _dialogHWnd)); /// - /// Gets or sets a string containing the file name selected in the file dialog box. + /// Gets or sets a string containing the file name selected in the file dialog box. /// [SRCategory(nameof(SR.CatData))] [DefaultValue("")] @@ -148,7 +148,7 @@ public string FileName } /// - /// Gets the file names of all selected files in the dialog box. + /// Gets the file names of all selected files in the dialog box. /// [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -159,8 +159,8 @@ public string[] FileNames } /// - /// Gets or sets the current file name filter string, which determines the choices - /// that appear in the "Save as file type" or "Files of type" box in the dialog box. + /// Gets or sets the current file name filter string, which determines the choices + /// that appear in the "Save as file type" or "Files of type" box in the dialog box. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue("")] @@ -192,9 +192,9 @@ public string Filter } /// - /// Extracts the file extensions specified by the current file filter into an - /// array of strings. None of the extensions contain .'s, and the default - /// extension is first. + /// Extracts the file extensions specified by the current file filter into an + /// array of strings. None of the extensions contain .'s, and the default + /// extension is first. /// private string[] FilterExtensions { @@ -240,7 +240,7 @@ private string[] FilterExtensions } /// - /// Gets or sets the index of the filter currently selected in the file dialog box. + /// Gets or sets the index of the filter currently selected in the file dialog box. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(1)] @@ -248,7 +248,7 @@ private string[] FilterExtensions public int FilterIndex { get; set; } /// - /// Gets or sets the initial directory displayed by the file dialog box. + /// Gets or sets the initial directory displayed by the file dialog box. /// [SRCategory(nameof(SR.CatData))] [DefaultValue("")] @@ -260,12 +260,12 @@ public string InitialDirectory } /// - /// Gets the Win32 instance handle for the application. + /// Gets the Win32 instance handle for the application. /// protected virtual IntPtr Instance => Interop.Kernel32.GetModuleHandleW(null); /// - /// Gets the Win32 common Open File Dialog OFN_* option flags. + /// Gets the Win32 common Open File Dialog OFN_* option flags. /// protected int Options { @@ -279,8 +279,8 @@ protected int Options } /// - /// Gets or sets a value indicating whether the dialog box restores the current - /// directory before closing. + /// Gets or sets a value indicating whether the dialog box restores the current + /// directory before closing. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -292,8 +292,8 @@ public bool RestoreDirectory } /// - /// Gets or sets a value indicating whether whether the Help button is displayed - /// in the file dialog. + /// Gets or sets a value indicating whether whether the Help button is displayed + /// in the file dialog. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -305,7 +305,7 @@ public bool ShowHelp } /// - /// Gets or sets whether def or abc.def is the extension of the file filename.abc.def + /// Gets or sets whether def or abc.def is the extension of the file filename.abc.def /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -313,7 +313,7 @@ public bool ShowHelp public bool SupportMultiDottedExtensions { get; set; } /// - /// Gets or sets the file dialog box title. + /// Gets or sets the file dialog box title. /// [SRCategory(nameof(SR.CatAppearance))] [DefaultValue("")] @@ -326,8 +326,8 @@ public string Title } /// - /// Gets or sets a value indicating whether the dialog box accepts only valid - /// Win32 file names. + /// Gets or sets a value indicating whether the dialog box accepts only valid + /// Win32 file names. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -339,10 +339,10 @@ public bool ValidateNames } /// - /// Occurs when the user clicks on the Open or Save button on a file dialog - /// box. + /// Occurs when the user clicks on the Open or Save button on a file dialog + /// box. /// - /// For information about handling events, see . + /// For information about handling events, see . /// /// [SRDescription(nameof(SR.FDfileOkDescr))] @@ -353,7 +353,7 @@ public event CancelEventHandler FileOk } /// - /// Processes the CDN_FILEOK notification. + /// Processes the CDN_FILEOK notification. /// private bool DoFileOk(IntPtr lpOFN) { @@ -430,7 +430,7 @@ private protected static bool FileExists(string fileName) } /// - /// Extracts the filename(s) returned by the file dialog. + /// Extracts the filename(s) returned by the file dialog. /// private string[] GetMultiselectFiles(UnsafeNativeMethods.CharBuffer charBuffer) { @@ -464,13 +464,13 @@ private string[] GetMultiselectFiles(UnsafeNativeMethods.CharBuffer charBuffer) } /// - /// Returns the state of the given option flag. + /// Returns the state of the given option flag. /// private protected bool GetOption(int option) => (_options & option) != 0; /// - /// Defines the common dialog box hook procedure that is overridden to add - /// specific functionality to the file dialog box. + /// Defines the common dialog box hook procedure that is overridden to add + /// specific functionality to the file dialog box. /// protected override IntPtr HookProc(IntPtr hWnd, int msg, IntPtr wparam, IntPtr lparam) { @@ -561,8 +561,8 @@ protected override IntPtr HookProc(IntPtr hWnd, int msg, IntPtr wparam, IntPtr l } /// - /// Converts the given filter string to the format required in an OPENFILENAME_I - /// structure. + /// Converts the given filter string to the format required in an OPENFILENAME_I + /// structure. /// private static string MakeFilterString(string s, bool dereferenceLinks) { @@ -594,7 +594,7 @@ private static string MakeFilterString(string s, bool dereferenceLinks) } /// - /// Raises the event. + /// Raises the event. /// protected void OnFileOk(CancelEventArgs e) { @@ -603,9 +603,9 @@ protected void OnFileOk(CancelEventArgs e) } /// - /// Processes the filenames entered in the dialog according to the settings - /// of the "addExtension", "checkFileExists", "createPrompt", and - /// "overwritePrompt" properties. + /// Processes the filenames entered in the dialog according to the settings + /// of the "addExtension", "checkFileExists", "createPrompt", and + /// "overwritePrompt" properties. /// private bool ProcessFileNames() { @@ -656,9 +656,9 @@ private bool ProcessFileNames() } /// - /// Prompts the user with a with the - /// given parameters. It also ensures that the focus is set back on the window that - /// had the focus to begin with (before we displayed the MessageBox). + /// Prompts the user with a with the + /// given parameters. It also ensures that the focus is set back on the window that + /// had the focus to begin with (before we displayed the MessageBox). /// private protected bool MessageBoxWithFocusRestore(string message, string caption, MessageBoxButtons buttons, MessageBoxIcon icon) @@ -676,8 +676,8 @@ private protected bool MessageBoxWithFocusRestore(string message, string caption } /// - /// Prompts the user with a when a - /// file does not exist. + /// Prompts the user with a when a + /// file does not exist. /// private void PromptFileNotFound(string fileName) { @@ -705,7 +705,7 @@ private protected virtual bool PromptUserIfAppropriate(string fileName) } /// - /// Resets all properties to their default values. + /// Resets all properties to their default values. /// public override void Reset() { @@ -722,7 +722,7 @@ public override void Reset() } /// - /// Implements running of a file dialog. + /// Implements running of a file dialog. /// protected override bool RunDialog(IntPtr hWndOwner) { @@ -782,12 +782,12 @@ private bool RunDialogOld(IntPtr hWndOwner) } /// - /// Implements the actual call to GetOPENFILENAME_I or GetSaveFileName. + /// Implements the actual call to GetOPENFILENAME_I or GetSaveFileName. /// private protected abstract bool RunFileDialog(NativeMethods.OPENFILENAME_I ofn); /// - /// Sets the given option to the given boolean value. + /// Sets the given option to the given boolean value. /// private protected void SetOption(int option, bool value) { @@ -802,7 +802,7 @@ private protected void SetOption(int option, bool value) } /// - /// Provides a string version of this Object. + /// Provides a string version of this Object. /// public override string ToString() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialogCustomPlace.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialogCustomPlace.cs index 74b561efdcd..2c36a3251eb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialogCustomPlace.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialogCustomPlace.cs @@ -5,11 +5,11 @@ namespace System.Windows.Forms { /// - /// Sample Guids - /// ComputerFolder: "0AC0837C-BBF8-452A-850D-79D08E667CA7" - /// Favorites: "1777F761-68AD-4D8A-87BD-30B759FA33DD" - /// Documents: "FDD39AD0-238F-46AF-ADB4-6C85480369C7" - /// Profile: "5E6C858F-0E22-4760-9AFE-EA3317B67173" + /// Sample Guids + /// ComputerFolder: "0AC0837C-BBF8-452A-850D-79D08E667CA7" + /// Favorites: "1777F761-68AD-4D8A-87BD-30B759FA33DD" + /// Documents: "FDD39AD0-238F-46AF-ADB4-6C85480369C7" + /// Profile: "5E6C858F-0E22-4760-9AFE-EA3317B67173" /// public class FileDialogCustomPlace { @@ -52,9 +52,9 @@ public override string ToString() } /// - /// This can throw in a multitude of ways if the path or Guid doesn't correspond - /// to an actual filesystem directory. - /// The caller is responsible for handling these situations. + /// This can throw in a multitude of ways if the path or Guid doesn't correspond + /// to an actual filesystem directory. + /// The caller is responsible for handling these situations. /// internal FileDialogNative.IShellItem GetNativePath() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog_Vista.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog_Vista.cs index 842c5e4396b..45d9682b630 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog_Vista.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FileDialog_Vista.cs @@ -287,7 +287,7 @@ private protected static string GetFilePathFromShellItem(FileDialogNative.IShell public FileDialogCustomPlacesCollection CustomPlaces => _customPlaces; /// - /// Gets or sets whether the dialog will be automatically upgraded to enable new features. + /// Gets or sets whether the dialog will be automatically upgraded to enable new features. /// [DefaultValue(true)] public bool AutoUpgradeEnabled { get; set; } = true; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FixedPanel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FixedPanel.cs index 2ad897f559e..8d5eb27668f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FixedPanel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FixedPanel.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Specifies the Fixed Panel in the SplitContainer Control. + /// Specifies the Fixed Panel in the SplitContainer Control. /// public enum FixedPanel { /// - /// No panel is fixed. Resize causes the Resize of both the panels. + /// No panel is fixed. Resize causes the Resize of both the panels. /// None = 0, /// - /// Panel1 is Fixed. The resize will increase the size of second panel. + /// Panel1 is Fixed. The resize will increase the size of second panel. /// Panel1 = 1, /// - /// Panel2 is Fixed. The resize will increase the size of first panel. + /// Panel2 is Fixed. The resize will increase the size of first panel. /// Panel2 = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FlatStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FlatStyle.cs index 94cbe261b70..e638898b234 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FlatStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FlatStyle.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - /// Specifies the style of control to display. + /// Specifies the style of control to display. /// public enum FlatStyle { /// - /// The control appears flat. + /// The control appears flat. /// Flat, /// - /// A control appears flat until the mouse pointer moves over it, at - /// which point it appears three-dimensional. + /// A control appears flat until the mouse pointer moves over it, at + /// which point it appears three-dimensional. /// Popup, /// - /// The control appears three-dimensional. + /// The control appears three-dimensional. /// Standard, /// - /// The control appears three-dimensional. + /// The control appears three-dimensional. /// System, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FolderBrowserDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FolderBrowserDialog.cs index 4366d0401ce..bb7af274384 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FolderBrowserDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FolderBrowserDialog.cs @@ -12,8 +12,8 @@ namespace System.Windows.Forms { /// - /// Represents a common dialog box that allows the user to specify options for - /// selecting a folder. This class cannot be inherited. + /// Represents a common dialog box that allows the user to specify options for + /// selecting a folder. This class cannot be inherited. /// [DefaultEvent(nameof(HelpRequest))] [DefaultProperty(nameof(SelectedPath))] @@ -31,7 +31,7 @@ public sealed class FolderBrowserDialog : CommonDialog private string _selectedPath; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public FolderBrowserDialog() { @@ -39,7 +39,7 @@ public FolderBrowserDialog() } /// - /// Gets or Sets whether the dialog will be automatically upgraded to enable new features. + /// Gets or Sets whether the dialog will be automatically upgraded to enable new features. /// [DefaultValue(true)] public bool AutoUpgradeEnabled { get; set; } = true; @@ -53,8 +53,8 @@ public FolderBrowserDialog() } /// - /// Determines if the 'New Folder' button should be exposed. - /// This property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown. + /// Determines if the 'New Folder' button should be exposed. + /// This property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown. /// [Browsable(true)] [DefaultValue(true)] @@ -64,8 +64,8 @@ public FolderBrowserDialog() public bool ShowNewFolderButton { get; set; } /// - /// Gets the directory path of the folder the user picked. - /// Sets the directory path of the initial folder shown in the dialog box. + /// Gets the directory path of the folder the user picked. + /// Sets the directory path of the initial folder shown in the dialog box. /// [Browsable(true)] [DefaultValue("")] @@ -80,7 +80,7 @@ public string SelectedPath } /// - /// Gets/sets the root node of the directory tree. + /// Gets/sets the root node of the directory tree. /// [Browsable(true)] [DefaultValue(Environment.SpecialFolder.Desktop)] @@ -103,8 +103,8 @@ public Environment.SpecialFolder RootFolder } /// - /// Gets or sets a description to show above the folders. Here you can provide - /// instructions for selecting a folder. + /// Gets or sets a description to show above the folders. Here you can provide + /// instructions for selecting a folder. /// [Browsable(true)] [DefaultValue("")] @@ -118,11 +118,11 @@ public string Description } /// - /// Gets or sets a value that indicates whether to use the value of the property - /// as the dialog title for Vista style dialogs. This property has no effect on old style dialogs. + /// Gets or sets a value that indicates whether to use the value of the property + /// as the dialog title for Vista style dialogs. This property has no effect on old style dialogs. /// /// to indicate that the value of the property is used as dialog title; - /// to indicate the value is added as additional text to the dialog. The default is . + /// to indicate the value is added as additional text to the dialog. The default is . [Browsable(true)] [DefaultValue(false)] [Localizable(true)] @@ -136,7 +136,7 @@ private bool UseVistaDialogInternal } /// - /// Resets all properties to their default values. + /// Resets all properties to their default values. /// public override void Reset() { @@ -147,7 +147,7 @@ public override void Reset() } /// - /// Implements running of a folder browser dialog. + /// Implements running of a folder browser dialog. /// protected override bool RunDialog(IntPtr hWndOwner) { @@ -295,8 +295,8 @@ private unsafe bool RunDialogOld(IntPtr hWndOwner) } /// - /// Callback function used to enable/disable the OK button, - /// and select the initial folder. + /// Callback function used to enable/disable the OK button, + /// and select the initial folder. /// private int FolderBrowserDialog_BrowseCallbackProc(IntPtr hwnd, int msg, IntPtr lParam, IntPtr lpData) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Form.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Form.cs index c694c0967ef..6681cd14c72 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Form.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Form.cs @@ -170,7 +170,7 @@ public class Form : ContainerControl private VisualStyleRenderer sizeGripRenderer; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Form() : base() { @@ -251,7 +251,7 @@ public Form() : base() } /// - /// Indicates the control on the form that is clicked when + /// Indicates the control on the form that is clicked when /// the user presses the ENTER key. /// [ @@ -283,7 +283,7 @@ public IButtonControl AcceptButton } /// - /// Retrieves true if this form is currently active. + /// Retrieves true if this form is currently active. /// internal bool Active { @@ -759,7 +759,7 @@ private bool CalledOnLoad } /// - /// Gets or sets the border style of the form. + /// Gets or sets the border style of the form. /// [SRCategory(nameof(SR.CatAppearance))] [DefaultValue(FormBorderStyle.Sizable)] @@ -862,8 +862,8 @@ public IButtonControl CancelButton } /// - /// Gets or sets a value indicating whether a control box is displayed in the - /// caption bar of the form. + /// Gets or sets a value indicating whether a control box is displayed in the + /// caption bar of the form. /// [SRCategory(nameof(SR.CatWindowStyle))] [DefaultValue(true)] @@ -1176,7 +1176,7 @@ public event CancelEventHandler HelpButtonClicked } /// - /// Gets or sets the icon for the form. + /// Gets or sets the icon for the form. /// [AmbientValue(null)] [Localizable(true)] @@ -1326,8 +1326,8 @@ public bool IsMdiContainer } /// - /// Determines if this form should display a warning banner when the form is - /// displayed in an unsecure mode. + /// Determines if this form should display a warning banner when the form is + /// displayed in an unsecure mode. /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Advanced)] @@ -1571,7 +1571,7 @@ public MainMenu Menu } /// - /// Gets the minimum size the form can be resized to. + /// Gets the minimum size the form can be resized to. /// [SRCategory(nameof(SR.CatLayout))] [Localizable(true)] @@ -1929,8 +1929,8 @@ public bool Modal } /// - /// Determines the opacity of the form. This can only be set on top level controls. - /// Opacity requires Windows 2000 or later, and is ignored on earlier operating systems. + /// Determines the opacity of the form. This can only be set on top level controls. + /// Opacity requires Windows 2000 or later, and is ignored on earlier operating systems. /// [SRCategory(nameof(SR.CatWindowStyle))] [TypeConverter(typeof(OpacityConverter))] @@ -2002,7 +2002,7 @@ private byte OpacityAsByte } /// - /// Gets an array of objects that represent all forms that are owned by this form. + /// Gets an array of objects that represent all forms that are owned by this form. /// [ SRCategory(nameof(SR.CatWindowStyle)), @@ -2159,7 +2159,7 @@ internal override Control ParentInternal } /// - /// If ShowInTaskbar is true then the form will be displayed in the Windows Taskbar. + /// If ShowInTaskbar is true then the form will be displayed in the Windows Taskbar. /// [DefaultValue(true)] [SRCategory(nameof(SR.CatWindowStyle))] @@ -2181,10 +2181,10 @@ public bool ShowInTaskbar } /// - /// Gets or sets a value indicating whether an icon is displayed in the - /// caption bar of the form. - /// If ControlBox == false, then the icon won't be shown no matter what - /// the value of ShowIcon is + /// Gets or sets a value indicating whether an icon is displayed in the + /// caption bar of the form. + /// If ControlBox == false, then the icon won't be shown no matter what + /// the value of ShowIcon is /// [DefaultValue(true)] [SRCategory(nameof(SR.CatWindowStyle))] @@ -2437,8 +2437,8 @@ public bool TopLevel } /// - /// Gets or sets a value indicating whether the form should be displayed as the - /// top-most form of the application. + /// Gets or sets a value indicating whether the form should be displayed as the + /// top-most form of the application. /// [DefaultValue(false)] [SRCategory(nameof(SR.CatWindowStyle))] @@ -2630,7 +2630,7 @@ protected override void SetVisibleCore(bool value) } /// - /// Gets or sets the form's window state. + /// Gets or sets the form's window state. /// [SRCategory(nameof(SR.CatLayout))] [DefaultValue(FormWindowState.Normal)] @@ -2681,7 +2681,7 @@ public FormWindowState WindowState } /// - /// Gets or sets the text to display in the caption bar of the form. + /// Gets or sets the text to display in the caption bar of the form. /// internal override string WindowText { @@ -3691,7 +3691,7 @@ protected override void Dispose(bool disposing) } /// - /// Adjusts the window style of the CreateParams to reflect the bordericons. + /// Adjusts the window style of the CreateParams to reflect the bordericons. /// private void FillInCreateParamsBorderIcons(CreateParams cp) { @@ -3745,7 +3745,7 @@ private void FillInCreateParamsBorderIcons(CreateParams cp) } /// - /// Adjusts the window style of the CreateParams to reflect the borderstyle. + /// Adjusts the window style of the CreateParams to reflect the borderstyle. /// private void FillInCreateParamsBorderStyles(CreateParams cp) { @@ -3779,7 +3779,7 @@ private void FillInCreateParamsBorderStyles(CreateParams cp) } /// - /// Adjusts the CreateParams to reflect the window bounds and start position. + /// Adjusts the CreateParams to reflect the window bounds and start position. /// private void FillInCreateParamsStartPosition(CreateParams cp) { @@ -3851,7 +3851,7 @@ private void FillInCreateParamsStartPosition(CreateParams cp) } /// - /// Adjusts the Createparams to reflect the window state. + /// Adjusts the Createparams to reflect the window state. /// private void FillInCreateParamsWindowState(CreateParams cp) { @@ -3867,7 +3867,7 @@ private void FillInCreateParamsWindowState(CreateParams cp) } /// - /// Attempts to set focus to this Form. + /// Attempts to set focus to this Form. /// private protected override bool FocusInternal() { @@ -4243,8 +4243,8 @@ protected virtual void OnActivated(EventArgs e) } /// - /// Override of AutoScaleModeChange method from ContainerControl. We use this to keep our - /// own AutoScale property in sync. + /// Override of AutoScaleModeChange method from ContainerControl. We use this to keep our + /// own AutoScale property in sync. /// private protected override void OnAutoScaleModeChanged() { @@ -4336,7 +4336,7 @@ protected override void OnCreateControl() } /// - /// Raises the Deactivate event. + /// Raises the Deactivate event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDeactivate(EventArgs e) @@ -4345,7 +4345,7 @@ protected virtual void OnDeactivate(EventArgs e) } /// - /// Raises the EnabledChanged event. + /// Raises the EnabledChanged event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnEnabledChanged(EventArgs e) @@ -4403,9 +4403,9 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Inheriting classes should override this method to find out when the - /// handle is about to be destroyed. - /// Call base.OnHandleDestroyed last. + /// Inheriting classes should override this method to find out when the + /// handle is about to be destroyed. + /// Call base.OnHandleDestroyed last. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnHandleDestroyed(EventArgs e) @@ -4480,7 +4480,6 @@ protected virtual void OnLoad(EventArgs e) /* /// - */ // Also, at this time we can now locate the form the the correct @@ -4558,8 +4557,8 @@ protected virtual void OnMinimumSizeChanged(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnInputLanguageChanged(InputLanguageChangedEventArgs e) @@ -4568,8 +4567,8 @@ protected virtual void OnInputLanguageChanged(InputLanguageChangedEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnInputLanguageChanging(InputLanguageChangingEventArgs e) @@ -4611,7 +4610,7 @@ protected override void OnVisibleChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMdiChildActivate(EventArgs e) @@ -4622,7 +4621,7 @@ protected virtual void OnMdiChildActivate(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMenuStart(EventArgs e) @@ -4632,7 +4631,7 @@ protected virtual void OnMenuStart(EventArgs e) } /// - /// Raises the MenuComplete event. + /// Raises the MenuComplete event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnMenuComplete(EventArgs e) @@ -4902,7 +4901,7 @@ protected override bool ProcessCmdKey(ref Message msg, Keys keyData) /// /// Processes a dialog key. Overrides Control.processDialogKey(). This /// method implements handling of the RETURN, and ESCAPE keys in dialogs. - /// The method performs no processing on keys that include the ALT or + /// The method performs no processing on keys that include the ALT or /// CONTROL modifiers. /// protected override bool ProcessDialogKey(Keys keyData) @@ -5314,7 +5313,7 @@ private void ResumeUpdateMenuHandles() } /// - /// Selects this form, and optionally selects the next/previous control. + /// Selects this form, and optionally selects the next/previous control. /// protected override void Select(bool directed, bool forward) { @@ -5823,7 +5822,7 @@ public DialogResult ShowDialog(IWin32Window owner) } /// - /// Indicates whether the property should be + /// Indicates whether the property should be /// persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] @@ -5838,7 +5837,7 @@ private bool ShouldSerializeClientSize() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// private bool ShouldSerializeIcon() { @@ -5855,7 +5854,7 @@ private bool ShouldSerializeLocation() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal override bool ShouldSerializeSize() @@ -5864,7 +5863,7 @@ internal override bool ShouldSerializeSize() } /// - /// Indicates whether the property should be + /// Indicates whether the property should be /// persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] @@ -6376,8 +6375,8 @@ internal void UpdateMdiWindowListStrip() } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnResizeBegin(EventArgs e) @@ -6389,8 +6388,8 @@ protected virtual void OnResizeBegin(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnResizeEnd(EventArgs e) @@ -6409,7 +6408,7 @@ protected override void OnStyleChanged(EventArgs e) } /// - /// Updates the window icon. + /// Updates the window icon. /// private void UpdateWindowIcon(bool redrawFrame) { @@ -6810,7 +6809,7 @@ private void WmExitMenuLoop(ref Message m) } /// - /// WM_GETMINMAXINFO handler + /// WM_GETMINMAXINFO handler /// private void WmGetMinMaxInfo(ref Message m) { @@ -7299,7 +7298,7 @@ protected override void WndProc(ref Message m) /*C#r:protected*/ /// - /// Initializes a new instance of the ControlCollection class. + /// Initializes a new instance of the ControlCollection class. /// public ControlCollection(Form owner) : base(owner) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormBorderStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormBorderStyle.cs index da7274a2f85..106a36fe13b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormBorderStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormBorderStyle.cs @@ -7,43 +7,43 @@ namespace System.Windows.Forms { /// - /// Specifies the border styles for a form. + /// Specifies the border styles for a form. /// [ComVisible(true)] public enum FormBorderStyle { /// - /// No border. + /// No border. /// None = 0, /// - /// A fixed, single line border. + /// A fixed, single line border. /// FixedSingle = 1, /// - /// A fixed, three-dimensional border. + /// A fixed, three-dimensional border. /// Fixed3D = 2, /// - /// A thick, fixed dialog-style border. + /// A thick, fixed dialog-style border. /// FixedDialog = 3, /// - /// A resizable border. + /// A resizable border. /// Sizable = 4, /// - /// A tool window border that is not resizable. + /// A tool window border that is not resizable. /// FixedToolWindow = 5, /// - /// A resizable tool window border. + /// A resizable tool window border. /// SizableToolWindow = 6, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventArgs.cs index 22595f38c44..de9a70e66d5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class FormClosedEventArgs : EventArgs { @@ -15,7 +15,7 @@ public FormClosedEventArgs(CloseReason closeReason) } /// - /// Provides the reason for the Form Close. + /// Provides the reason for the Form Close. /// public CloseReason CloseReason { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventHandler.cs index 4f72df6a70f..bd10506962e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle Form closed event. + /// Represents a method that will handle Form closed event. /// public delegate void FormClosedEventHandler(object sender, FormClosedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventArgs.cs index 643e9f72947..421d39caaee 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class FormClosingEventArgs : CancelEventArgs { @@ -17,7 +17,7 @@ public FormClosingEventArgs(CloseReason closeReason, bool cancel) : base(cancel) } /// - /// Provides the reason for the Form close. + /// Provides the reason for the Form close. /// public CloseReason CloseReason { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventHandler.cs index 8acd76873cb..e717a14233c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormClosingEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle Form Closing event. + /// Represents a method that will handle Form Closing event. /// public delegate void FormClosingEventHandler(object sender, FormClosingEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormStartPosition.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormStartPosition.cs index 89f19b3ebc1..f62d6749b1c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormStartPosition.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormStartPosition.cs @@ -7,36 +7,36 @@ namespace System.Windows.Forms { /// - /// Specifies the initial position of a form. + /// Specifies the initial position of a form. /// [ComVisible(true)] public enum FormStartPosition { /// - /// The location and size of the form will determine its starting position. + /// The location and size of the form will determine its starting position. /// Manual = 0, /// - /// The form is centered on the current display, and has the dimensions - /// specified in the form's size. + /// The form is centered on the current display, and has the dimensions + /// specified in the form's size. /// CenterScreen = 1, /// - /// The form is positioned at the Windows default location and has the - /// dimensions specified in the form's size. + /// The form is positioned at the Windows default location and has the + /// dimensions specified in the form's size. /// WindowsDefaultLocation = 2, /// - /// The form is positioned at the Windows default location and has the - /// bounds determined by Windows default. + /// The form is positioned at the Windows default location and has the + /// bounds determined by Windows default. /// WindowsDefaultBounds = 3, /// - /// The form is centered within the bounds of its parent form. + /// The form is centered within the bounds of its parent form. /// CenterParent = 4 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FormWindowState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FormWindowState.cs index f1f7602b3bc..08a24ed8492 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FormWindowState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FormWindowState.cs @@ -7,23 +7,23 @@ namespace System.Windows.Forms { /// - /// Specifies how a form window is displayed. + /// Specifies how a form window is displayed. /// [ComVisible(true)] public enum FormWindowState { /// - /// A default sized window. + /// A default sized window. /// Normal = 0, /// - /// A minimized window. + /// A minimized window. /// Minimized = 1, /// - /// A maximized window. + /// A maximized window. /// Maximized = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Formatter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Formatter.cs index a5de118af6e..e7749be13ff 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Formatter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Formatter.cs @@ -18,13 +18,13 @@ internal class Formatter /// /// - /// Converts a binary value into a format suitable for display to the end user. - /// Used when pushing a value from a back-end data source into a data-bound property on a control. + /// Converts a binary value into a format suitable for display to the end user. + /// Used when pushing a value from a back-end data source into a data-bound property on a control. /// - /// The real conversion work happens inside FormatObjectInternal(). Before calling FormatObjectInternal(), - /// we check for any use of nullable types or values (eg. Nullable) and 'unwrap' them to get at the real - /// types and values, which are then used in the actual conversion. If the caller is expecting a nullable - /// value back, we must also re-wrap the final result inside a nullable value before returning. + /// The real conversion work happens inside FormatObjectInternal(). Before calling FormatObjectInternal(), + /// we check for any use of nullable types or values (eg. Nullable) and 'unwrap' them to get at the real + /// types and values, which are then used in the actual conversion. If the caller is expecting a nullable + /// value back, we must also re-wrap the final result inside a nullable value before returning. /// public static object FormatObject(object value, Type targetType, @@ -74,12 +74,12 @@ public static object FormatObject(object value, /// /// - /// Converts a value into a format suitable for display to the end user. + /// Converts a value into a format suitable for display to the end user. /// - /// - Converts DBNull or null into a suitable formatted representation of 'null' - /// - Performs some special-case conversions (eg. Boolean to CheckState) - /// - Uses TypeConverters or IConvertible where appropriate - /// - Throws a FormatException is no suitable conversion can be found + /// - Converts DBNull or null into a suitable formatted representation of 'null' + /// - Performs some special-case conversions (eg. Boolean to CheckState) + /// - Uses TypeConverters or IConvertible where appropriate + /// - Throws a FormatException is no suitable conversion can be found /// private static object FormatObjectInternal(object value, Type targetType, @@ -209,13 +209,13 @@ private static object FormatObjectInternal(object value, /// /// - /// Converts a value entered by the end user (through UI) into the corresponding binary value. - /// Used when pulling input from a data-bound property on a control to store in a back-end data source. + /// Converts a value entered by the end user (through UI) into the corresponding binary value. + /// Used when pulling input from a data-bound property on a control to store in a back-end data source. /// - /// The real conversion work happens inside ParseObjectInternal(). Before calling ParseObjectInternal(), - /// we check for any use of nullable types or values (eg. Nullable) and 'unwrap' them to get at the real - /// types and values, which are then used in the actual conversion. If the caller is expecting a nullable - /// value back, we must also re-wrap the final result inside a nullable value before returning. + /// The real conversion work happens inside ParseObjectInternal(). Before calling ParseObjectInternal(), + /// we check for any use of nullable types or values (eg. Nullable) and 'unwrap' them to get at the real + /// types and values, which are then used in the actual conversion. If the caller is expecting a nullable + /// value back, we must also re-wrap the final result inside a nullable value before returning. /// public static object ParseObject(object value, Type targetType, @@ -260,12 +260,12 @@ public static object ParseObject(object value, /// /// - /// Converts a value entered by the end user (through UI) into the corresponding binary value. + /// Converts a value entered by the end user (through UI) into the corresponding binary value. /// - /// - Converts formatted representations of 'null' into DBNull - /// - Performs some special-case conversions (eg. CheckState to Boolean) - /// - Uses TypeConverters or IConvertible where appropriate - /// - Throws a FormatException is no suitable conversion can be found + /// - Converts formatted representations of 'null' into DBNull + /// - Performs some special-case conversions (eg. CheckState to Boolean) + /// - Uses TypeConverters or IConvertible where appropriate + /// - Throws a FormatException is no suitable conversion can be found /// private static object ParseObjectInternal(object value, Type targetType, @@ -374,7 +374,7 @@ private static object ParseObjectInternal(object value, } /// - /// Converts a value to the specified type using Convert.ChangeType() + /// Converts a value to the specified type using Convert.ChangeType() /// private static object ChangeType(object value, Type type, IFormatProvider formatInfo) { @@ -394,7 +394,7 @@ private static object ChangeType(object value, Type type, IFormatProvider format } /// - /// Indicates whether the specified value matches the display-formatted representation of 'null data' for a given binding. + /// Indicates whether the specified value matches the display-formatted representation of 'null data' for a given binding. /// private static bool EqualsFormattedNullValue(object value, object formattedNullValue, IFormatProvider formatInfo) { @@ -416,7 +416,7 @@ private static bool EqualsFormattedNullValue(object value, object formattedNullV } /// - /// Returns the FormatException message used when formatting/parsing fails to find any suitable conversion + /// Returns the FormatException message used when formatting/parsing fails to find any suitable conversion /// private static string GetCantConvertMessage(object value, Type targetType) { @@ -425,7 +425,7 @@ private static string GetCantConvertMessage(object value, Type targetType) } /// - /// Determines the correct culture to use during formatting and parsing + /// Determines the correct culture to use during formatting and parsing /// private static CultureInfo GetFormatterCulture(IFormatProvider formatInfo) { @@ -440,7 +440,7 @@ private static CultureInfo GetFormatterCulture(IFormatProvider formatInfo) } /// - /// Converts a value to the specified type using best Parse() method on that type + /// Converts a value to the specified type using best Parse() method on that type /// public static object InvokeStringParseMethod(object value, Type targetType, IFormatProvider formatInfo) { @@ -487,7 +487,7 @@ public static object InvokeStringParseMethod(object value, Type targetType, IFor } /// - /// Indicates whether a given value represents 'null' for data source fields of the same type. + /// Indicates whether a given value represents 'null' for data source fields of the same type. /// public static bool IsNullData(object value, object dataSourceNullValue) { @@ -497,7 +497,7 @@ public static bool IsNullData(object value, object dataSourceNullValue) } /// - /// Returns the default representation of 'null' for a given data source field type. + /// Returns the default representation of 'null' for a given data source field type. /// public static object NullData(Type type, object dataSourceNullValue) { @@ -526,7 +526,7 @@ public static object NullData(Type type, object dataSourceNullValue) } /// - /// Extract the inner type from a nullable type + /// Extract the inner type from a nullable type /// private static Type NullableUnwrap(Type type) { @@ -540,7 +540,7 @@ private static Type NullableUnwrap(Type type) } /// - /// Extract the inner type converter from a nullable type converter + /// Extract the inner type converter from a nullable type converter /// private static TypeConverter NullableUnwrap(TypeConverter typeConverter) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/FrameStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/FrameStyle.cs index 5c6b48beaab..7b79eb83d76 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/FrameStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/FrameStyle.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Specifies the frame style of the selected control. + /// Specifies the frame style of the selected control. /// public enum FrameStyle { /// - /// A thin, dashed border. + /// A thin, dashed border. /// Dashed, /// - /// A thick, solid border. + /// A thick, solid border. /// Thick, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GDI/TextRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GDI/TextRenderer.cs index ef37f84d96d..cf5efa7d53b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GDI/TextRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GDI/TextRenderer.cs @@ -210,7 +210,7 @@ private static Interop.User32.TextFormatFlags GetTextFormatFlags(TextFormatFlags return windowsGraphicsSupportedFlags; } - /// MeasureText wrappers. + /// MeasureText wrappers. public static Size MeasureText(string text, Font font) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventArgs.cs index eb9a2463736..c97c9224c36 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class GiveFeedbackEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public GiveFeedbackEventArgs(DragDropEffects effect, bool useDefaultCursors) { @@ -22,12 +22,12 @@ public GiveFeedbackEventArgs(DragDropEffects effect, bool useDefaultCursors) } /// - /// Gets the type of drag-and-drop operation. + /// Gets the type of drag-and-drop operation. /// public DragDropEffects Effect { get; } /// - /// Gets or sets a value indicating whether a default pointer is used. + /// Gets or sets a value indicating whether a default pointer is used. /// public bool UseDefaultCursors { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventHandler.cs index 7f9494e64b1..5f2dd75f59c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GiveFeedbackEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that handles the - /// event of a . + /// Represents the method that handles the + /// event of a . /// public delegate void GiveFeedbackEventHandler(object sender, GiveFeedbackEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GridItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GridItem.cs index 8d99163e915..c568812a3b1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GridItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GridItem.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// Representaion of one row item in the PropertyGrid. These items represent the - /// hierarchy of the grid's "tree-like" view and can be used to get information about - /// the grid's state and contents. - /// These objects should not be cached because they represent a snapshot of the - /// PropertyGrid's state and may be disposed by grid activity. The PropertyGrid often - /// recretates these objects internally even if it doesn't appear to change to the user. + /// Representaion of one row item in the PropertyGrid. These items represent the + /// hierarchy of the grid's "tree-like" view and can be used to get information about + /// the grid's state and contents. + /// These objects should not be cached because they represent a snapshot of the + /// PropertyGrid's state and may be disposed by grid activity. The PropertyGrid often + /// recretates these objects internally even if it doesn't appear to change to the user. /// public abstract class GridItem { @@ -25,50 +25,50 @@ public abstract class GridItem public object Tag { get; set; } /// - /// Retrieves the child GridItems, if any, of this GridItem + /// Retrieves the child GridItems, if any, of this GridItem /// public abstract GridItemCollection GridItems { get; } /// - /// Retrieves type of this GridItem, as a value from System.Windows.Forms.GridItemType + /// Retrieves type of this GridItem, as a value from System.Windows.Forms.GridItemType /// public abstract GridItemType GridItemType { get; } /// - /// Retrieves the text label of this GridItem. This may be different from the actual - /// PropertyName. For GridItemType.Property GridItems, retrieve the PropertyDescriptor - /// and check its Name property. + /// Retrieves the text label of this GridItem. This may be different from the actual + /// PropertyName. For GridItemType.Property GridItems, retrieve the PropertyDescriptor + /// and check its Name property. /// public abstract string Label { get; } /// - /// Retrieves parent GridItem of this GridItem, if any. + /// Retrieves parent GridItem of this GridItem, if any. /// public abstract GridItem Parent { get; } /// - /// If this item is a GridItemType.Property GridItem, this retreives the - /// System.ComponentModel.PropertyDescriptor that is associated with this GridItem. - /// This can be used to retrieve infomration such as property Type, Name, or - /// TypeConverter. + /// If this item is a GridItemType.Property GridItem, this retreives the + /// System.ComponentModel.PropertyDescriptor that is associated with this GridItem. + /// This can be used to retrieve infomration such as property Type, Name, or + /// TypeConverter. /// public abstract PropertyDescriptor PropertyDescriptor { get; } /// - /// Retrieves the current Value of this grid Item. This may be null. + /// Retrieves the current Value of this grid Item. This may be null. /// /// - /// We don't do set because of the value class semantics, etc. + /// We don't do set because of the value class semantics, etc. /// public abstract object Value { get; } /// - /// Retreives whether the given property is expandable. + /// Retreives whether the given property is expandable. /// public virtual bool Expandable => false; /// - /// Retreives or sets whether the GridItem is in an expanded state. + /// Retreives or sets whether the GridItem is in an expanded state. /// public virtual bool Expanded { @@ -77,7 +77,7 @@ public virtual bool Expanded } /// - /// Attempts to select this GridItem in the PropertyGrid. + /// Attempts to select this GridItem in the PropertyGrid. /// public abstract bool Select(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GridItemCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GridItemCollection.cs index 1eecacff45f..2911ea74d3f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GridItemCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GridItemCollection.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// A read-only collection of GridItem objects + /// A read-only collection of GridItem objects /// public class GridItemCollection : ICollection { @@ -21,7 +21,7 @@ internal GridItemCollection(GridItem[] entries) } /// - /// Retrieves the number of member attributes. + /// Retrieves the number of member attributes. /// public int Count => _entries.Length; @@ -30,7 +30,7 @@ internal GridItemCollection(GridItem[] entries) bool ICollection.IsSynchronized => false; /// - /// Retrieves the member attribute with the specified index. + /// Retrieves the member attribute with the specified index. /// public GridItem this[int index] => _entries[index]; @@ -59,7 +59,7 @@ void ICollection.CopyTo(Array dest, int index) } /// - /// Creates and retrieves a new enumerator for this collection. + /// Creates and retrieves a new enumerator for this collection. /// public IEnumerator GetEnumerator() => _entries.GetEnumerator(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GridTablesFactory.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GridTablesFactory.cs index cbcc8ee35ce..ebc0b939a0d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GridTablesFactory.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GridTablesFactory.cs @@ -7,8 +7,8 @@ namespace System.Windows.Forms public static class GridTablesFactory { /// - /// Takes a DataView and creates an intelligent mapping of DataView storage - /// types into available DataColumn types. + /// Takes a DataView and creates an intelligent mapping of DataView storage + /// types into available DataColumn types. /// public static DataGridTableStyle[] CreateGridTables(DataGridTableStyle gridTable, object dataSource, string dataMember, BindingContext bindingManager) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/GroupBoxRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/GroupBoxRenderer.cs index cd83cf371ac..3df01d56eb6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/GroupBoxRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/GroupBoxRenderer.cs @@ -27,7 +27,7 @@ private GroupBoxRenderer() /// /// If this property is true, then the renderer will use the setting from Application.RenderWithVisualStyles to - /// determine how to render. + /// determine how to render. /// If this property is false, the renderer will always render with visualstyles. /// public static bool RenderMatchingApplicationState diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HScrollBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HScrollBar.cs index 3fa63349d4e..7b38f0a24c0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HScrollBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HScrollBar.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Represents a standard Windows horizontal scroll bar. + /// Represents a standard Windows horizontal scroll bar. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HScrollProperties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HScrollProperties.cs index 5a6efaf24df..96a4f34f407 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HScrollProperties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HScrollProperties.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Basic Properties for HScroll. + /// Basic Properties for HScroll. /// public class HScrollProperties : ScrollProperties { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HandledMouseEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HandledMouseEventArgs.cs index 74f2dae65e5..22b95a1d94e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HandledMouseEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HandledMouseEventArgs.cs @@ -16,7 +16,7 @@ public HandledMouseEventArgs(MouseButtons button, int clicks, int x, int y, int } /// - /// Gets or sets a value indicating whether the event is handled. + /// Gets or sets a value indicating whether the event is handled. /// public bool Handled { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventArgs.cs index 6916bc88ea6..f38d1900037 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventArgs.cs @@ -8,13 +8,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the Control.HelpRequest event. + /// Provides data for the Control.HelpRequest event. /// [ComVisible(true)] public class HelpEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public HelpEventArgs(Point mousePos) { @@ -22,12 +22,12 @@ public HelpEventArgs(Point mousePos) } /// - /// Gets the screen coordinates of the mouse pointer. + /// Gets the screen coordinates of the mouse pointer. /// public Point MousePos { get; } /// - /// Gets or sets a value indicating whether the Help event was handled. + /// Gets or sets a value indicating whether the Help event was handled. /// public bool Handled { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventHandler.cs index 579f6a35342..7e8e9a604bf 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HelpEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the Help event of a Control. + /// Represents the method that will handle the Help event of a Control. /// public delegate void HelpEventHandler(object sender, HelpEventArgs hlpevent); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HelpNavigator.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HelpNavigator.cs index 18d4e863e2c..b3292eba6e2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HelpNavigator.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HelpNavigator.cs @@ -5,45 +5,45 @@ namespace System.Windows.Forms { /// - /// Represents the HTML 1.0 Help engine. + /// Represents the HTML 1.0 Help engine. /// public enum HelpNavigator { /// - /// Displays the topic referenced by the topic referenced by the specified - /// Url. This field is constant. + /// Displays the topic referenced by the topic referenced by the specified + /// Url. This field is constant. /// Topic = unchecked((int)0x80000001), /// - /// Displays the contents of the HTML 1.0 Help file. This field is constant. + /// Displays the contents of the HTML 1.0 Help file. This field is constant. /// TableOfContents = unchecked((int)0x80000002), /// - /// Displays the index of a specified Url. This field is constant. + /// Displays the index of a specified Url. This field is constant. /// Index = unchecked((int)0x80000003), /// - /// Displays the search page of a specified Url. This field is constant. + /// Displays the search page of a specified Url. This field is constant. /// Find = unchecked((int)0x80000004), /// - /// Displays the topic referenced by the topic referenced by the specified - /// Url. This field is constant. + /// Displays the topic referenced by the topic referenced by the specified + /// Url. This field is constant. /// AssociateIndex = unchecked((int)0x80000005), /// - /// Displays the topic referenced by the topic referenced by the specified - /// Url. This field is constant. + /// Displays the topic referenced by the topic referenced by the specified + /// Url. This field is constant. /// KeywordIndex = unchecked((int)0x80000006), /// - /// Displays the topic referenced by the topic ID This field is constant. + /// Displays the topic referenced by the topic ID This field is constant. /// TopicId = unchecked((int)0x80000007) } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HelpProvider.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HelpProvider.cs index add77d8b63c..da8cc3e4594 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HelpProvider.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HelpProvider.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms { /// - /// Provides pop-up or online Help for controls. + /// Provides pop-up or online Help for controls. /// [ProvideProperty("HelpString", typeof(Control))] [ProvideProperty("HelpKeyword", typeof(Control))] @@ -27,14 +27,14 @@ public class HelpProvider : Component, IExtenderProvider private readonly Hashtable _navigators = new Hashtable(); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public HelpProvider() { } /// - /// Gets or sets a string indicating the name of the Help file associated with this + /// Gets or sets a string indicating the name of the Help file associated with this /// object. /// [Localizable(true)] @@ -52,13 +52,13 @@ public HelpProvider() public object Tag { get; set; } /// - /// Determines if the help provider can offer it's extender properties to the specified target - /// object. + /// Determines if the help provider can offer it's extender properties to the specified target + /// object. /// public virtual bool CanExtend(object target) => target is Control; /// - /// Retrieves the Help Keyword displayed when the user invokes Help for the specified control. + /// Retrieves the Help Keyword displayed when the user invokes Help for the specified control. /// [DefaultValue(null)] [Localizable(true)] @@ -74,7 +74,7 @@ public virtual string GetHelpKeyword(Control ctl) } /// - /// Retrieves the contents of the pop-up help window for the specified control. + /// Retrieves the contents of the pop-up help window for the specified control. /// [DefaultValue(HelpNavigator.AssociateIndex)] [Localizable(true)] @@ -91,7 +91,7 @@ public virtual HelpNavigator GetHelpNavigator(Control ctl) } /// - /// Retrieves the contents of the pop-up help window for the specified control. + /// Retrieves the contents of the pop-up help window for the specified control. /// [DefaultValue(null)] [Localizable(true)] @@ -107,7 +107,7 @@ public virtual string GetHelpString(Control ctl) } /// - /// Retrieves a value indicating whether Help displays for the specified control. + /// Retrieves a value indicating whether Help displays for the specified control. /// [Localizable(true)] [SRDescription(nameof(SR.HelpProviderShowHelpDescr))] @@ -123,7 +123,7 @@ public virtual bool GetShowHelp(Control ctl) } /// - /// Handles the help event for any bound controls. + /// Handles the help event for any bound controls. /// private void OnControlHelp(object sender, HelpEventArgs hevent) { @@ -172,7 +172,7 @@ private void OnControlHelp(object sender, HelpEventArgs hevent) } /// - /// Handles the help event for any bound controls. + /// Handles the help event for any bound controls. /// private void OnQueryAccessibilityHelp(object sender, QueryAccessibilityHelpEventArgs e) { @@ -183,7 +183,7 @@ private void OnQueryAccessibilityHelp(object sender, QueryAccessibilityHelpEvent } /// - /// Specifies a Help string associated with a control. + /// Specifies a Help string associated with a control. /// public virtual void SetHelpString(Control ctl, string helpString) { @@ -202,7 +202,7 @@ public virtual void SetHelpString(Control ctl, string helpString) } /// - /// Specifies the Help keyword to display when the user invokes Help for a control. + /// Specifies the Help keyword to display when the user invokes Help for a control. /// public virtual void SetHelpKeyword(Control ctl, string keyword) { @@ -221,7 +221,7 @@ public virtual void SetHelpKeyword(Control ctl, string keyword) } /// - /// Specifies the Help keyword to display when the user invokes Help for a control. + /// Specifies the Help keyword to display when the user invokes Help for a control. /// public virtual void SetHelpNavigator(Control ctl, HelpNavigator navigator) { @@ -240,7 +240,7 @@ public virtual void SetHelpNavigator(Control ctl, HelpNavigator navigator) } /// - /// Specifies whether Help is displayed for a given control. + /// Specifies whether Help is displayed for a given control. /// public virtual void SetShowHelp(Control ctl, bool value) { @@ -254,7 +254,7 @@ public virtual void SetShowHelp(Control ctl, bool value) } /// - /// Used by the designer + /// Used by the designer /// internal bool ShouldSerializeShowHelp(Control ctl) { @@ -267,7 +267,7 @@ internal bool ShouldSerializeShowHelp(Control ctl) } /// - /// Used by the designer + /// Used by the designer /// public virtual void ResetShowHelp(Control ctl) { @@ -280,7 +280,7 @@ public virtual void ResetShowHelp(Control ctl) } /// - /// Binds/unbinds event handlers to ctl + /// Binds/unbinds event handlers to ctl /// private void UpdateEventBinding(Control ctl) { @@ -299,7 +299,7 @@ private void UpdateEventBinding(Control ctl) } /// - /// Returns a string representation for this control. + /// Returns a string representation for this control. /// public override string ToString() => base.ToString() + ", HelpNamespace: " + HelpNamespace; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HighDpiMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HighDpiMode.cs index 669a7d18437..5bc400d2b0b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HighDpiMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HighDpiMode.cs @@ -6,32 +6,32 @@ namespace System.Windows.Forms { /// - /// Specifies the HighDpi mode. + /// Specifies the HighDpi mode. /// public enum HighDpiMode { /// - /// The window does not scale for DPI changes and always assumes a scale factor of 100%. + /// The window does not scale for DPI changes and always assumes a scale factor of 100%. /// DpiUnaware, /// - /// The window will query for the DPI of the primary monitor once and use this for the process on all monitors. + /// The window will query for the DPI of the primary monitor once and use this for the process on all monitors. /// SystemAware, /// - /// The Window checks for DPI when it's created and adjusts scale factor when the DPI changes. + /// The Window checks for DPI when it's created and adjusts scale factor when the DPI changes. /// PerMonitor, /// - /// Similar to PerMonitor, but enables Child window DPI change notification, improved scaling of comctl32 controls and dialog scaling. + /// Similar to PerMonitor, but enables Child window DPI change notification, improved scaling of comctl32 controls and dialog scaling. /// PerMonitorV2, /// - /// Similar to DpiUnaware, but improves the quality of GDI/GDI+ based content. + /// Similar to DpiUnaware, but improves the quality of GDI/GDI+ based content. /// DpiUnawareGdiScaled } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HorizontalAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HorizontalAlignment.cs index c78ba0851e0..7df25198964 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HorizontalAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HorizontalAlignment.cs @@ -7,24 +7,24 @@ namespace System.Windows.Forms { /// - /// Specifies how an object or text in a control is horizontally aligned - /// relative to an element of the control. + /// Specifies how an object or text in a control is horizontally aligned + /// relative to an element of the control. /// [ComVisible(true)] public enum HorizontalAlignment { /// - /// The object or text is aligned on the left of the control element. + /// The object or text is aligned on the left of the control element. /// Left = 0, /// - /// The object or text is aligned on the right of the control element. + /// The object or text is aligned on the right of the control element. /// Right = 1, /// - /// The object or text is aligned in the center of the control element. + /// The object or text is aligned in the center of the control element. /// Center = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlDocument.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlDocument.cs index eb47755e7ff..f4dbf20b935 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlDocument.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlDocument.cs @@ -633,7 +633,7 @@ private Color ColorFromObject(object oColor) } /// - /// HtmlDocumentShim - this is the glue between the DOM eventing mechanisms + /// HtmlDocumentShim - this is the glue between the DOM eventing mechanisms /// and our CLR callbacks. /// /// There are two kinds of events: HTMLWindowEvents2 and IHtmlWindow3.AttachHandler style @@ -680,7 +680,7 @@ internal HtmlDocument Document get { return htmlDocument; } } - /// Support IHtmlDocument3.AttachHandler + /// Support IHtmlDocument3.AttachHandler public override void AttachEventHandler(string eventName, EventHandler eventHandler) { @@ -693,7 +693,7 @@ public override void AttachEventHandler(string eventName, EventHandler eventHand Debug.Assert(success, "failed to add event"); } - /// Support IHtmlDocument3.DetachHandler + /// Support IHtmlDocument3.DetachHandler public override void DetachEventHandler(string eventName, EventHandler eventHandler) { HtmlToClrEventProxy proxy = RemoveEventProxy(eventHandler); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElement.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElement.cs index 17cf28fa404..eb256044a4a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElement.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElement.cs @@ -1009,7 +1009,7 @@ public void onstart(IHTMLEventObj evtObj) { } } /// - /// HtmlElementShim - this is the glue between the DOM eventing mechanisms + /// HtmlElementShim - this is the glue between the DOM eventing mechanisms /// and our CLR callbacks. /// /// HTMLElementEvents2: we create an IConnectionPoint (via ConnectionPointCookie) between us and MSHTML and it calls back @@ -1078,7 +1078,7 @@ public override IHTMLWindow2 AssociatedWindow get { return associatedWindow; } } - /// Support IHTMLElement2.AttachEventHandler + /// Support IHTMLElement2.AttachEventHandler public override void AttachEventHandler(string eventName, EventHandler eventHandler) { @@ -1109,7 +1109,7 @@ public override void ConnectToEvents() } } - /// Support IHTMLElement2.DetachHandler + /// Support IHTMLElement2.DetachHandler public override void DetachEventHandler(string eventName, EventHandler eventHandler) { HtmlToClrEventProxy proxy = RemoveEventProxy(eventHandler); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventArgs.cs index 948599cec88..cecced6162c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// EventArgs for onerror event of HtmlElement + /// EventArgs for onerror event of HtmlElement /// public sealed class HtmlElementErrorEventArgs : EventArgs { @@ -20,23 +20,23 @@ internal HtmlElementErrorEventArgs(string description, string urlString, int lin } /// - /// Description of error + /// Description of error /// public string Description { get; } /// - /// Gets or sets a value indicating whether the - /// event was handled. + /// Gets or sets a value indicating whether the + /// event was handled. /// public bool Handled { get; set; } /// - /// Line number where error occurred + /// Line number where error occurred /// public int LineNumber { get; } /// - /// Url where error occurred + /// Url where error occurred /// public Uri Url => _url ?? (_url = new Uri(_urlString)); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventHandler.cs index 0c72fabe0ef..9a5442aa68a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementErrorEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// EventHandler for HtmlElementErrorEventArgs + /// EventHandler for HtmlElementErrorEventArgs /// public delegate void HtmlElementErrorEventHandler(object sender, HtmlElementErrorEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementEventArgs.cs index 5547bcb5133..538c94262d5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlElementEventArgs.cs @@ -69,20 +69,20 @@ public bool BubbleEvent public int KeyPressedCode => NativeHTMLEventObj.GetKeyCode(); /// - /// Indicates whether the Alt key was pressed, if this information is - /// provided to the IHtmlEventObj + /// Indicates whether the Alt key was pressed, if this information is + /// provided to the IHtmlEventObj /// public bool AltKeyPressed => NativeHTMLEventObj.GetAltKey(); /// - /// Indicates whether the Ctrl key was pressed, if this information is - /// provided to the IHtmlEventObj + /// Indicates whether the Ctrl key was pressed, if this information is + /// provided to the IHtmlEventObj /// public bool CtrlKeyPressed => NativeHTMLEventObj.GetCtrlKey(); /// - /// Indicates whether the Shift key was pressed, if this information is - /// provided to the IHtmlEventObj + /// Indicates whether the Shift key was pressed, if this information is + /// provided to the IHtmlEventObj /// public bool ShiftKeyPressed => NativeHTMLEventObj.GetShiftKey(); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlHistory.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlHistory.cs index 791b2ba37ad..491c40f2295 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlHistory.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlHistory.cs @@ -81,10 +81,10 @@ public void Go(Uri url) /// /// Go to a specific url(string) in the history /// - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Go(string urlString) { object loc = (object)urlString; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShim.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShim.cs index 3499c9eff0f..0696da9df33 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShim.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShim.cs @@ -8,13 +8,13 @@ namespace System.Windows.Forms { - /// This is essentially a proxy object between the native - /// html objects and our managed ones. We want the managed - /// HtmlDocument, HtmlWindow and HtmlElement to be super-lightweight, - /// which means that we shouldnt have things that tie up their lifetimes - /// contained within them. The "Shim" is essentially the object that - /// manages events coming out of the HtmlDocument, HtmlElement and HtmlWindow - /// and serves them back up to the user. + /// This is essentially a proxy object between the native + /// html objects and our managed ones. We want the managed + /// HtmlDocument, HtmlWindow and HtmlElement to be super-lightweight, + /// which means that we shouldnt have things that tie up their lifetimes + /// contained within them. The "Shim" is essentially the object that + /// manages events coming out of the HtmlDocument, HtmlElement and HtmlWindow + /// and serves them back up to the user. internal abstract class HtmlShim : IDisposable { @@ -42,7 +42,7 @@ private EventHandlerList Events } } - /// Support IHtml*3.AttachHandler + /// Support IHtml*3.AttachHandler public abstract void AttachEventHandler(string eventName, EventHandler eventHandler); public void AddHandler(object key, Delegate value) @@ -68,14 +68,14 @@ public abstract IHTMLWindow2 AssociatedWindow get; } - /// create connectionpoint cookie + /// create connectionpoint cookie public abstract void ConnectToEvents(); - /// Support IHtml*3.DetachEventHandler + /// Support IHtml*3.DetachEventHandler public abstract void DetachEventHandler(string eventName, EventHandler eventHandler); - /// disconnect from connectionpoint cookie - /// inheriting classes should override to disconnect from ConnectionPoint and call base. + /// disconnect from connectionpoint cookie + /// inheriting classes should override to disconnect from ConnectionPoint and call base. public virtual void DisconnectFromEvents() { if (attachedEventList != null) @@ -92,7 +92,7 @@ public virtual void DisconnectFromEvents() } - /// return the sender for events, usually the HtmlWindow, HtmlElement, HtmlDocument + /// return the sender for events, usually the HtmlWindow, HtmlElement, HtmlDocument protected abstract object GetEventSender(); public void Dispose() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShimManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShimManager.cs index ad0f20ba558..ad3be690715 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShimManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlShimManager.cs @@ -153,8 +153,8 @@ private void OnShimAdded(HtmlShim addedShim) } } /// - /// HtmlWindowShim calls back on us when it has unloaded the page. At this point we need to - /// walk through our lists and make sure we've cleaned up + /// HtmlWindowShim calls back on us when it has unloaded the page. At this point we need to + /// walk through our lists and make sure we've cleaned up /// internal void OnWindowUnloaded(HtmlWindow unloadedWindow) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlWindow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlWindow.cs index c286e957aec..32be60388b8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/HtmlWindow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/HtmlWindow.cs @@ -241,19 +241,19 @@ public void Navigate(Uri url) NativeHtmlWindow.Navigate(url.ToString()); } - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Navigate(string urlString) { NativeHtmlWindow.Navigate(urlString); } - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public HtmlWindow Open(string urlString, string target, string windowOptions, bool replaceEntry) { IHTMLWindow2 iHTMLWindow2 = NativeHtmlWindow.Open(urlString, target, windowOptions, replaceEntry); @@ -265,10 +265,10 @@ public HtmlWindow Open(Uri url, string target, string windowOptions, bool replac return Open(url.ToString(), target, windowOptions, replaceEntry); } - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public HtmlWindow OpenNew(string urlString, string windowOptions) { IHTMLWindow2 iHTMLWindow2 = NativeHtmlWindow.Open(urlString, "_blank", windowOptions, true); @@ -451,7 +451,7 @@ public void onafterprint(IHTMLEventObj evtObj) { } } /// - /// HtmlWindowShim - this is the glue between the DOM eventing mechanisms + /// HtmlWindowShim - this is the glue between the DOM eventing mechanisms /// and our CLR callbacks. /// /// There are two kinds of events: HTMLWindowEvents2 and IHtmlWindow3.AttachHandler style @@ -483,7 +483,7 @@ public override IHTMLWindow2 AssociatedWindow get { return htmlWindow.NativeHtmlWindow; } } - /// Support IHtmlDocument3.AttachHandler + /// Support IHtmlDocument3.AttachHandler public override void AttachEventHandler(string eventName, EventHandler eventHandler) { @@ -496,7 +496,7 @@ public override void AttachEventHandler(string eventName, EventHandler eventHand Debug.Assert(success, "failed to add event"); } - /// Support HTMLWindowEvents2 + /// Support HTMLWindowEvents2 public override void ConnectToEvents() { if (cookie == null || !cookie.Connected) @@ -512,7 +512,7 @@ public override void ConnectToEvents() } } - /// Support IHTMLWindow3.DetachHandler + /// Support IHTMLWindow3.DetachHandler public override void DetachEventHandler(string eventName, EventHandler eventHandler) { HtmlToClrEventProxy proxy = RemoveEventProxy(eventHandler); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IButtonControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IButtonControl.cs index 3fed0fbff8c..08ee2cf1016 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IButtonControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IButtonControl.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms { /// - /// Allows a control to act like a button on a form. + /// Allows a control to act like a button on a form. /// public interface IButtonControl { /// - /// Gets and sets the dialog result of the Button control. This is used as the result - /// for the dialog on which the button is set to be an "accept" or "cancel" button. + /// Gets and sets the dialog result of the Button control. This is used as the result + /// for the dialog on which the button is set to be an "accept" or "cancel" button. /// DialogResult DialogResult { get; set; } /// - /// Notifies a control that it is the default button so that its appearance and behavior - /// is adjusted accordingly. + /// Notifies a control that it is the default button so that its appearance and behavior + /// is adjusted accordingly. /// void NotifyDefault(bool value); /// - /// Generates a event for the control. + /// Generates a event for the control. /// void PerformClick(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IContainerControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IContainerControl.cs index e52ee93332f..59b50799abf 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IContainerControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IContainerControl.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Provides functionality for a control to parent other controls. + /// Provides functionality for a control to parent other controls. /// public interface IContainerControl { /// - /// Indicates the control that is currently active on the container control. + /// Indicates the control that is currently active on the container control. /// Control ActiveControl { get; set; } /// - /// Activates the specified control. + /// Activates the specified control. /// bool ActivateControl(Control active); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ICurrencyManagerProvider.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ICurrencyManagerProvider.cs index b3a6256893f..f49094a5310 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ICurrencyManagerProvider.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ICurrencyManagerProvider.cs @@ -8,14 +8,14 @@ namespace System.Windows.Forms public interface ICurrencyManagerProvider { /// - /// Return the main currency manager for this data source. + /// Return the main currency manager for this data source. /// CurrencyManager CurrencyManager { get; } /// - /// Return a related currency manager for specified data member on this data source. - /// If data member is null or empty, this method returns the data source's main currency - /// manager (ie. this method returns the same value as the CurrencyManager property). + /// Return a related currency manager for specified data member on this data source. + /// If data member is null or empty, this method returns the data source's main currency + /// manager (ie. this method returns the same value as the CurrencyManager property). /// CurrencyManager GetRelatedCurrencyManager(string dataMember); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IDataGridEditingService.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IDataGridEditingService.cs index 6a442b2b5e7..911af12452a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IDataGridEditingService.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IDataGridEditingService.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// The DataGrid exposes hooks to request editing commands via this interface. + /// The DataGrid exposes hooks to request editing commands via this interface. /// public interface IDataGridEditingService { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IDataObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IDataObject.cs index 40404f26596..26eb2c70092 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IDataObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IDataObject.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides a format-independent mechanism for transferring data. + /// Provides a format-independent mechanism for transferring data. /// [ComVisible(true)] public interface IDataObject { /// - /// Retrieves the data associated with the specified data format, using - /// autoConvert to determine whether to convert the data to the format. + /// Retrieves the data associated with the specified data format, using + /// autoConvert to determine whether to convert the data to the format. /// object GetData(string format, bool autoConvert); @@ -24,64 +24,64 @@ public interface IDataObject object GetData(string format); /// - /// Retrieves the data associated with the specified class type format. + /// Retrieves the data associated with the specified class type format. /// object GetData(Type format); /// - /// Stores the specified data and its associated format in this instance, - /// using autoConvert to specify whether the data can be converted to - /// another format. + /// Stores the specified data and its associated format in this instance, + /// using autoConvert to specify whether the data can be converted to + /// another format. /// void SetData(string format, bool autoConvert, object data); /// - /// Stores the specified data and its associated format in this instance. + /// Stores the specified data and its associated format in this instance. /// void SetData(string format, object data); /// /// Stores the specified data and its associated class type in this - /// instance. + /// instance. /// void SetData(Type format, object data); /// - /// Stores the specified data in this instance, using the class of the - /// data for the format. + /// Stores the specified data in this instance, using the class of the + /// data for the format. /// void SetData(object data); /// - /// Determines whether data stored in this instance is associated with the - /// specified format, using autoConvert to determine whether to convert the - /// data to the format. + /// Determines whether data stored in this instance is associated with the + /// specified format, using autoConvert to determine whether to convert the + /// data to the format. /// bool GetDataPresent(string format, bool autoConvert); /// - /// Determines whether data stored in this instance is associated with, or - /// can be converted to, the specified format. + /// Determines whether data stored in this instance is associated with, or + /// can be converted to, the specified format. /// bool GetDataPresent(string format); /// - /// Determines whether data stored in this instance is associated with, or - /// can be converted to, the specified format. + /// Determines whether data stored in this instance is associated with, or + /// can be converted to, the specified format. /// bool GetDataPresent(Type format); /// - /// Gets a list of all formats that data stored in this instance is - /// associated with or can be converted to, using autoConvert to determine - /// whether to retrieve all formats that the data can be converted to or' - /// only native data formats. + /// Gets a list of all formats that data stored in this instance is + /// associated with or can be converted to, using autoConvert to determine + /// whether to retrieve all formats that the data can be converted to or' + /// only native data formats. /// string[] GetFormats(bool autoConvert); /// - /// Gets a list of all formats that data stored in this instance is - /// associated with or can be converted to. + /// Gets a list of all formats that data stored in this instance is + /// associated with or can be converted to. /// string[] GetFormats(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IFeatureSupport.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IFeatureSupport.cs index 6d2bd49dc87..5f45bf94b38 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IFeatureSupport.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IFeatureSupport.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms { /// - /// Specifies a standard interface for retrieving feature information from the current system. + /// Specifies a standard interface for retrieving feature information from the current system. /// public interface IFeatureSupport { /// - /// Determines whether any version of the specified feature is currently available - /// on the system. + /// Determines whether any version of the specified feature is currently available + /// on the system. /// bool IsPresent(object feature); /// - /// Determines whether the specified or newer version of the specified feature - /// is currently available on the system. + /// Determines whether the specified or newer version of the specified feature + /// is currently available on the system. /// bool IsPresent(object feature, Version minimumVersion); /// - /// Retrieves the version of the specified feature. + /// Retrieves the version of the specified feature. /// Version GetVersionPresent(object feature); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IKeyboardToolTip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IKeyboardToolTip.cs index 97fb4b75d4e..7248263301f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IKeyboardToolTip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IKeyboardToolTip.cs @@ -10,70 +10,70 @@ namespace System.Windows.Forms internal interface IKeyboardToolTip { /// - /// Returns true if a keyboard ToolTip can be shown for the tool or its - /// descendants at this moment. + /// Returns true if a keyboard ToolTip can be shown for the tool or its + /// descendants at this moment. /// bool CanShowToolTipsNow(); /// - /// Returns the tool's native screen rectangle. + /// Returns the tool's native screen rectangle. /// Rectangle GetNativeScreenRectangle(); /// - /// Returns a list of neighboring tools' native screen rectangles. - /// They are used to minimize the intersection between them and a keyboard ToolTip. + /// Returns a list of neighboring tools' native screen rectangles. + /// They are used to minimize the intersection between them and a keyboard ToolTip. /// IList GetNeighboringToolsRectangles(); /// - /// Returns true if the tool is being hovered by a mouse pointer. + /// Returns true if the tool is being hovered by a mouse pointer. /// bool IsHoveredWithMouse(); /// - /// Returns true if the tool has the Right-To-Left mode enabled + /// Returns true if the tool has the Right-To-Left mode enabled /// bool HasRtlModeEnabled(); /// - /// Returns true if a keyboard ToolTip is allowed for this tool. + /// Returns true if a keyboard ToolTip is allowed for this tool. /// bool AllowsToolTip(); /// - /// Returns the tool owner's native window. - /// The tool can return its own native window if it exists. + /// Returns the tool owner's native window. + /// The tool can return its own native window if it exists. /// IWin32Window GetOwnerWindow(); /// - /// Notifies this tool that it was hooked to a keyboard ToolTip + /// Notifies this tool that it was hooked to a keyboard ToolTip /// void OnHooked(ToolTip toolTip); /// - /// Notifies this tool that it was unhooked from a keyboard ToolTip + /// Notifies this tool that it was unhooked from a keyboard ToolTip /// void OnUnhooked(ToolTip toolTip); /// - /// Returns a caption set for this tool by the provided ToolTip + /// Returns a caption set for this tool by the provided ToolTip /// string GetCaptionForTool(ToolTip toolTip); /// - /// Returns false if this tool's own keyboard tooltip is not expected to be shown (e.g. it is just a container for other tools) + /// Returns false if this tool's own keyboard tooltip is not expected to be shown (e.g. it is just a container for other tools) /// bool ShowsOwnToolTip(); /// - /// Returns true when the tool is being tabbed to + /// Returns true when the tool is being tabbed to /// bool IsBeingTabbedTo(); /// - /// Returns false if the tool disables keyboard tooltips for it's children + /// Returns false if the tool disables keyboard tooltips for it's children /// bool AllowsChildrenToShowToolTips(); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IMEMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IMEMode.cs index 1e565f93785..73d92677e1b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IMEMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IMEMode.cs @@ -7,93 +7,93 @@ namespace System.Windows.Forms { /// - /// Specifies a value that determines the IME (Input Method Editor) status - /// of the object when that object is selected. + /// Specifies a value that determines the IME (Input Method Editor) status + /// of the object when that object is selected. /// [ComVisible(true)] public enum ImeMode { /// - /// Inherit (Default). This value indicates inherit the ImeMode from the - /// parent control. For controls with no parent, the ImeMode will default - /// to NoControl. + /// Inherit (Default). This value indicates inherit the ImeMode from the + /// parent control. For controls with no parent, the ImeMode will default + /// to NoControl. /// Inherit = -1, /// - /// None. This value indicates "No control to IME". When the IMEMode - /// property is set to 0, you can use the IMEStatus function to determine - /// the current IME status. + /// None. This value indicates "No control to IME". When the IMEMode + /// property is set to 0, you can use the IMEStatus function to determine + /// the current IME status. /// NoControl = 0, /// - /// IME on. This value indicates that the IME is on and characters specific - /// to Chinese or Japanese can be entered. This setting is valid for - /// Japanese, Simplified Chinese, and Traditional Chinese IME only. + /// IME on. This value indicates that the IME is on and characters specific + /// to Chinese or Japanese can be entered. This setting is valid for + /// Japanese, Simplified Chinese, and Traditional Chinese IME only. /// On = 1, /// - /// IME off. This mode indicates that the IME is off, meaning that the - /// object behaves the same as English entry mode. This setting is valid - /// for Japanese, Simplified Chinese, and Traditional Chinese IME only. + /// IME off. This mode indicates that the IME is off, meaning that the + /// object behaves the same as English entry mode. This setting is valid + /// for Japanese, Simplified Chinese, and Traditional Chinese IME only. /// Off = 2, /// - /// IME disabled. This mode is similar to IMEMode = 2, except the value 3 - /// disables IME. With this setting, the users cannot turn the IME on from - /// the keyboard, and the IME floating window is hidden. This setting is - /// valid for Japanese IME only. + /// IME disabled. This mode is similar to IMEMode = 2, except the value 3 + /// disables IME. With this setting, the users cannot turn the IME on from + /// the keyboard, and the IME floating window is hidden. This setting is + /// valid for Japanese IME only. /// Disable = 3, /// - /// Hiragana double-byte characters (DBC). This setting is valid for - /// Japanese IME only. + /// Hiragana double-byte characters (DBC). This setting is valid for + /// Japanese IME only. /// Hiragana = 4, /// - /// Katakana DBC. This setting is valid for Japanese IME only. + /// Katakana DBC. This setting is valid for Japanese IME only. /// Katakana = 5, /// - /// Katakana single-byte characters (SBC). This setting is valid for - /// Japanese IME only. + /// Katakana single-byte characters (SBC). This setting is valid for + /// Japanese IME only. /// KatakanaHalf = 6, /// - /// Alphanumeric DBC. This setting is valid for Japanese IME only. + /// Alphanumeric DBC. This setting is valid for Japanese IME only. /// AlphaFull = 7, /// - /// Alphanumeric SBC. This setting is valid for Japanese IME only. + /// Alphanumeric SBC. This setting is valid for Japanese IME only. /// Alpha = 8, /// - /// Hangeul DBC. This setting is valid for Korean IME only. + /// Hangeul DBC. This setting is valid for Korean IME only. /// HangulFull = 9, /// - /// Hangeul SBC. This setting is valid for Korean IME only. + /// Hangeul SBC. This setting is valid for Korean IME only. /// Hangul = 10, /// - /// Ime Closed. This setting is valid for Chinese IME only. + /// Ime Closed. This setting is valid for Chinese IME only. /// Close = 11, /// - /// Ime On HalfShape. This setting is valid for Chinese IME only. - /// Note: This value is for internal use only - See QFE 4448. + /// Ime On HalfShape. This setting is valid for Chinese IME only. + /// Note: This value is for internal use only - See QFE 4448. /// OnHalf = 12, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IMessageFilter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IMessageFilter.cs index b1ab5972e30..3db683b535d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IMessageFilter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IMessageFilter.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// Defines a message filter interface. + /// Defines a message filter interface. /// public interface IMessageFilter { /// - /// Filters out a message before it is dispatched. + /// Filters out a message before it is dispatched. /// bool PreFilterMessage(ref Message m); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IWin32window.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IWin32window.cs index 4bdaa4556f4..248436aa82e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IWin32window.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IWin32window.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms public interface IWin32Window { /// - /// Gets the handle to the window represented by the implementor. + /// Gets the handle to the window represented by the implementor. /// IntPtr Handle { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/IWindowTarget.cs b/src/System.Windows.Forms/src/System/Windows/Forms/IWindowTarget.cs index 252c15b6556..3d3730e4366 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/IWindowTarget.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/IWindowTarget.cs @@ -5,19 +5,19 @@ namespace System.Windows.Forms { /// - /// This interface defines the communication layer between a Control object and the - /// Win32 API. Each Control object has an internal implementation this interface that - /// is called by the Win32 window. + /// This interface defines the communication layer between a Control object and the + /// Win32 API. Each Control object has an internal implementation this interface that + /// is called by the Win32 window. /// public interface IWindowTarget { /// - /// Called when the window handle of the control has changed. + /// Called when the window handle of the control has changed. /// void OnHandleChange(IntPtr newHandle); /// - /// Called to do control-specific processing for this window. + /// Called to do control-specific processing for this window. /// void OnMessage(ref Message m); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ImageIndexConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ImageIndexConverter.cs index 900ca3c7b0f..8c7946faf94 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ImageIndexConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ImageIndexConverter.cs @@ -24,10 +24,10 @@ protected virtual bool IncludeNoneAsStandardValue } /// - /// this is the property to look at when there is no ImageList property - /// on the current object. For example, in ToolBarButton - the ImageList is - /// on the ToolBarButton.Parent property. In ToolStripItem, the ImageList is on - /// the ToolStripItem.Owner property. + /// this is the property to look at when there is no ImageList property + /// on the current object. For example, in ToolBarButton - the ImageList is + /// on the ToolBarButton.Parent property. In ToolStripItem, the ImageList is on + /// the ToolStripItem.Owner property. /// internal string ParentImageListProperty { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ImageKeyConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ImageKeyConverter.cs index 37b23e4b0a5..fce2c97d5ee 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ImageKeyConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ImageKeyConverter.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms { /// - /// ImageIndexConverter is a class that can be used to convert - /// image index values one data type to another. + /// ImageIndexConverter is a class that can be used to convert + /// image index values one data type to another. /// public class ImageKeyConverter : StringConverter { @@ -25,10 +25,10 @@ protected virtual bool IncludeNoneAsStandardValue } /// - /// this is the property to look at when there is no ImageList property - /// on the current object. For example, in ToolBarButton - the ImageList is - /// on the ToolBarButton.Parent property. In ToolStripItem, the ImageList is on - /// the ToolStripItem.Owner property. + /// this is the property to look at when there is no ImageList property + /// on the current object. For example, in ToolBarButton - the ImageList is + /// on the ToolBarButton.Parent property. In ToolStripItem, the ImageList is on + /// the ToolStripItem.Owner property. /// internal string ParentImageListProperty { @@ -42,8 +42,8 @@ internal string ParentImageListProperty } } /// - /// Gets a value indicating whether this converter can convert an object in the - /// given source type to a string using the specified context. + /// Gets a value indicating whether this converter can convert an object in the + /// given source type to a string using the specified context. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -55,7 +55,7 @@ public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceT } /// - /// Converts the specified value object to a string object. + /// Converts the specified value object to a string object. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { @@ -71,11 +71,11 @@ public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo c } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { @@ -97,10 +97,10 @@ public override object ConvertTo(ITypeDescriptorContext context, CultureInfo cul } /// - /// Retrieves a collection containing a set of standard values - /// for the data type this validator is designed for. This - /// will return null if the data type does not support a - /// standard set of values. + /// Retrieves a collection containing a set of standard values + /// for the data type this validator is designed for. This + /// will return null if the data type does not support a + /// standard set of values. /// public override StandardValuesCollection GetStandardValues(ITypeDescriptorContext context) { @@ -190,12 +190,12 @@ public override StandardValuesCollection GetStandardValues(ITypeDescriptorContex } /// - /// Determines if the list of standard values returned from - /// GetStandardValues is an exclusive list. If the list - /// is exclusive, then no other values are valid, such as - /// in an enum data type. If the list is not exclusive, - /// then there are other valid values besides the list of - /// standard values GetStandardValues provides. + /// Determines if the list of standard values returned from + /// GetStandardValues is an exclusive list. If the list + /// is exclusive, then no other values are valid, such as + /// in an enum data type. If the list is not exclusive, + /// then there are other valid values besides the list of + /// standard values GetStandardValues provides. /// public override bool GetStandardValuesExclusive(ITypeDescriptorContext context) { @@ -203,8 +203,8 @@ public override bool GetStandardValuesExclusive(ITypeDescriptorContext context) } /// - /// Determines if this object supports a standard set of values - /// that can be picked from a list. + /// Determines if this object supports a standard set of values + /// that can be picked from a list. /// public override bool GetStandardValuesSupported(ITypeDescriptorContext context) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ImageLayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ImageLayout.cs index cc1517fb949..5574d493834 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ImageLayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ImageLayout.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms { /// - /// Specifies the position of the image on the control. + /// Specifies the position of the image on the control. /// public enum ImageLayout { /// - /// The image is aligned TOP - LEFT across the controls client rectangle. + /// The image is aligned TOP - LEFT across the controls client rectangle. /// None, /// - /// The image is tiled across the controls client rectangle. + /// The image is tiled across the controls client rectangle. /// Tile, /// - /// The image is centred within the controls client rectangle. + /// The image is centred within the controls client rectangle. /// Center, /// - /// The image is streched across the controls client rectangle. + /// The image is streched across the controls client rectangle. /// Stretch, /// - /// The image is streched across the controls client rectangle. + /// The image is streched across the controls client rectangle. /// Zoom, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ImageList.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ImageList.cs index ef66805781d..50bddbbfa59 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ImageList.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ImageList.cs @@ -532,7 +532,7 @@ private int AddIconToHandle(Original original, Icon icon) finally { if ((original.options & OriginalOptions.OwnsImage) != 0) - { /// this is to handle the case were we clone the icon (see WHY WHY WHY below) + { /// this is to handle the case were we clone the icon (see WHY WHY WHY below) icon.Dispose(); } } @@ -1108,9 +1108,9 @@ public sealed class ImageCollection : IList private readonly ImageList owner; private readonly ArrayList imageInfoCollection = new ArrayList(); - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; /// diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguage.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguage.cs index dd11a7bdf14..2ca1095d0f8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguage.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguage.cs @@ -11,12 +11,12 @@ namespace System.Windows.Forms { /// - /// Provides methods and fields to manage the input language. + /// Provides methods and fields to manage the input language. /// public sealed class InputLanguage { /// - /// The HKL handle. + /// The HKL handle. /// private readonly IntPtr handle; @@ -26,12 +26,12 @@ internal InputLanguage(IntPtr handle) } /// - /// Returns the culture of the current input language. + /// Returns the culture of the current input language. /// public CultureInfo Culture => new CultureInfo((int)handle & 0xFFFF); /// - /// Gets or sets the input language for the current thread. + /// Gets or sets the input language for the current thread. /// public static InputLanguage CurrentInputLanguage { @@ -58,7 +58,7 @@ public static InputLanguage CurrentInputLanguage } /// - /// Returns the default input language for the system. + /// Returns the default input language for the system. /// public static InputLanguage DefaultInputLanguage { @@ -71,12 +71,12 @@ public static InputLanguage DefaultInputLanguage } /// - /// Returns the handle for the input language. + /// Returns the handle for the input language. /// public IntPtr Handle => handle; /// - /// Returns a list of all installed input languages. + /// Returns a list of all installed input languages. /// public static InputLanguageCollection InstalledInputLanguages { @@ -98,8 +98,8 @@ public static InputLanguageCollection InstalledInputLanguages } /// - /// Returns the name of the current keyboard layout as it appears in the Windows - /// Regional Settings on the computer. + /// Returns the name of the current keyboard layout as it appears in the Windows + /// Regional Settings on the computer. /// public string LayoutName { @@ -269,10 +269,10 @@ Look in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Keyboard Layouts\000 } /// - /// Attempts to extract the localized keyboard layout name using the - /// SHLoadIndirectString API (only on OSVersions >= 5). Returning - /// null from this method will force us to use the legacy codepath - /// (pulling the text directly from the registry). + /// Attempts to extract the localized keyboard layout name using the + /// SHLoadIndirectString API (only on OSVersions >= 5). Returning + /// null from this method will force us to use the legacy codepath + /// (pulling the text directly from the registry). /// private static string GetLocalizedKeyboardLayoutName(string layoutDisplayName) { @@ -290,7 +290,7 @@ private static string GetLocalizedKeyboardLayoutName(string layoutDisplayName) } /// - /// Creates an InputLanguageChangedEventArgs given a windows message. + /// Creates an InputLanguageChangedEventArgs given a windows message. /// internal static InputLanguageChangedEventArgs CreateInputLanguageChangedEventArgs(Message m) { @@ -298,7 +298,7 @@ internal static InputLanguageChangedEventArgs CreateInputLanguageChangedEventArg } /// - /// Creates an InputLanguageChangingEventArgs given a windows message. + /// Creates an InputLanguageChangingEventArgs given a windows message. /// internal static InputLanguageChangingEventArgs CreateInputLanguageChangingEventArgs(Message m) { @@ -310,7 +310,7 @@ internal static InputLanguageChangingEventArgs CreateInputLanguageChangingEventA } /// - /// Specifies whether two input languages are equal. + /// Specifies whether two input languages are equal. /// public override bool Equals(object value) { @@ -318,7 +318,7 @@ public override bool Equals(object value) } /// - /// Returns the input language associated with the specified culture. + /// Returns the input language associated with the specified culture. /// public static InputLanguage FromCulture(CultureInfo culture) { @@ -343,7 +343,7 @@ public static InputLanguage FromCulture(CultureInfo culture) } /// - /// Hash code for this input language. + /// Hash code for this input language. /// public override int GetHashCode() => unchecked((int)(long)handle); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventArgs.cs index 4887f2f7290..54eb95bbbc1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class InputLanguageChangedEventArgs : EventArgs { /// - /// Initializes a new instance of the class with the - /// specified locale and character set. + /// Initializes a new instance of the class with the + /// specified locale and character set. /// public InputLanguageChangedEventArgs(CultureInfo culture, byte charSet) { @@ -23,8 +23,8 @@ public InputLanguageChangedEventArgs(CultureInfo culture, byte charSet) } /// - /// Initializes a new instance of the class with the specified input language and - /// character set. + /// Initializes a new instance of the class with the specified input language and + /// character set. /// public InputLanguageChangedEventArgs(InputLanguage inputLanguage, byte charSet) { @@ -34,17 +34,17 @@ public InputLanguageChangedEventArgs(InputLanguage inputLanguage, byte charSet) } /// - /// Gets the input language. + /// Gets the input language. /// public InputLanguage InputLanguage { get; } /// - /// Gets the locale of the input language. + /// Gets the locale of the input language. /// public CultureInfo Culture { get; } /// - /// Gets the character set associated with the new input language. + /// Gets the character set associated with the new input language. /// public byte CharSet { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventHandler.cs index e695617c671..6b2cf08dfcd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void InputLanguageChangedEventHandler(object sender, InputLanguageChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventArgs.cs index 6e989b30cd6..9f810ad93bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventArgs.cs @@ -8,13 +8,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class InputLanguageChangingEventArgs : CancelEventArgs { /// - /// Initializes a new instance of the class with the - /// specified locale, character set, and acceptance. + /// Initializes a new instance of the class with the + /// specified locale, character set, and acceptance. /// public InputLanguageChangingEventArgs(CultureInfo culture, bool sysCharSet) { @@ -24,8 +24,8 @@ public InputLanguageChangingEventArgs(CultureInfo culture, bool sysCharSet) } /// - /// Initializes a new instance of the class with the - /// specified input language, character set, and acceptance of a language change. + /// Initializes a new instance of the class with the + /// specified input language, character set, and acceptance of a language change. /// public InputLanguageChangingEventArgs(InputLanguage inputLanguage, bool sysCharSet) { @@ -35,18 +35,18 @@ public InputLanguageChangingEventArgs(InputLanguage inputLanguage, bool sysCharS } /// - /// Gets the requested input language. + /// Gets the requested input language. /// public InputLanguage InputLanguage { get; } /// - /// Gets the locale of the requested input language. + /// Gets the locale of the requested input language. /// public CultureInfo Culture { get; } /// - /// Gets a value indicating whether the system default font supports the character set - /// required for the requested input language. + /// Gets a value indicating whether the system default font supports the character set + /// required for the requested input language. /// public bool SysCharSet { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventHandler.cs index 4a992b7e2ee..29410105c8d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageChangingEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the event of a . + /// Represents the method that will handle the event of a . /// public delegate void InputLanguageChangingEventHandler(object sender, InputLanguageChangingEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageCollection.cs index aeb2920a6a2..1058e036885 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InputLanguageCollection.cs @@ -20,7 +20,7 @@ internal InputLanguageCollection(InputLanguage[] value) } /// - /// Represents the entry at the specified index of the . + /// Represents the entry at the specified index of the . /// public InputLanguage this[int index] { @@ -31,7 +31,7 @@ public InputLanguage this[int index] } /// - /// Gets a value indicating whether the + /// Gets a value indicating whether the /// contains the specified . /// public bool Contains(InputLanguage value) @@ -40,7 +40,7 @@ public bool Contains(InputLanguage value) } /// - /// Copies the values to a one-dimensional instance at the + /// Copies the values to a one-dimensional instance at the /// specified index. /// public void CopyTo(InputLanguage[] array, int index) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InsertKeyMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InsertKeyMode.cs index 0bf15e283ce..a169d62bcc8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InsertKeyMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InsertKeyMode.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Represents the mode characters are entered in a text box. + /// Represents the mode characters are entered in a text box. /// public enum InsertKeyMode { /// - /// Honors the Insert key mode. + /// Honors the Insert key mode. /// Default, /// - /// Forces insertion mode to be 'on' regardless of the Insert key mode. + /// Forces insertion mode to be 'on' regardless of the Insert key mode. /// Insert, /// - /// Forces insertion mode to be 'off' regardless of the Insert key mode. + /// Forces insertion mode to be 'off' regardless of the Insert key mode. /// Overwrite } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventArgs.cs index 817388e90d3..27f609f8f33 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class InvalidateEventArgs : EventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public InvalidateEventArgs(Rectangle invalidRect) { @@ -21,8 +21,8 @@ public InvalidateEventArgs(Rectangle invalidRect) } /// - /// Gets a value indicating the that contains the - /// invalidated window area. + /// Gets a value indicating the that contains the + /// invalidated window area. /// public Rectangle InvalidRect { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventHandler.cs index 106167953b3..068d4185b0e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/InvalidateEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void InvalidateEventHandler(object sender, InvalidateEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemActivation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemActivation.cs index 656005c211c..b7082d3b41c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemActivation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemActivation.cs @@ -5,25 +5,25 @@ namespace System.Windows.Forms { /// - /// Specifies how the user activates items and the appearance of items as the - /// mouse cursor moves over them. + /// Specifies how the user activates items and the appearance of items as the + /// mouse cursor moves over them. /// public enum ItemActivation { /// - /// Activate items with a double-click. - /// Items do not change appearance. + /// Activate items with a double-click. + /// Items do not change appearance. /// Standard = 0, /// - /// Activate items with a single click. The cursor changes shape and the - /// item text changes color. + /// Activate items with a single click. The cursor changes shape and the + /// item text changes color. /// OneClick = 1, /// - /// Activate items with a double click. The item text changes color. + /// Activate items with a double click. The item text changes color. /// TwoClick = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemBoundsPortion.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemBoundsPortion.cs index 824186b88e6..665f18b522f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemBoundsPortion.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemBoundsPortion.cs @@ -5,27 +5,27 @@ namespace System.Windows.Forms { /// - /// Specifies the display bounds of a ListItem. + /// Specifies the display bounds of a ListItem. /// public enum ItemBoundsPortion { /// - /// Both the icon and label portions. In Report View, this includes subitems. + /// Both the icon and label portions. In Report View, this includes subitems. /// Entire = NativeMethods.LVIR_BOUNDS, /// - /// Only the icon portion. + /// Only the icon portion. /// Icon = NativeMethods.LVIR_ICON, /// - /// Only the label portion. + /// Only the label portion. /// Label = NativeMethods.LVIR_LABEL, /// - /// Both the icon and label portions. In Report view, this . + /// Both the icon and label portions. In Report view, this . /// ItemOnly = NativeMethods.LVIR_SELECTBOUNDS, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventArgs.cs index 33cf1f7f16a..2cdeb8eeb34 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class ItemCheckEventArgs : EventArgs @@ -20,17 +20,17 @@ public ItemCheckEventArgs(int index, CheckState newCheckValue, CheckState curren } /// - /// The index of the item that is about to change. + /// The index of the item that is about to change. /// public int Index { get; } /// - /// The proposed new value of the CheckBox. + /// The proposed new value of the CheckBox. /// public CheckState NewValue { get; set; } /// - /// The current state of the CheckBox. + /// The current state of the CheckBox. /// public CheckState CurrentValue { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventHandler.cs index b07f3ea8e60..ec9478db633 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a or + /// Represents the method that will handle the + /// event of a or /// . /// public delegate void ItemCheckEventHandler(object sender, ItemCheckEventArgs e); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventArgs.cs index 3f9f9d598f5..0b69b28ce3a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class ItemCheckedEventArgs : EventArgs { @@ -15,7 +15,7 @@ public ItemCheckedEventArgs(ListViewItem item) } /// - /// The index of the item that is about to change. + /// The index of the item that is about to change. /// public ListViewItem Item { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventHandler.cs index 7787d17e2ff..a9855c3d6de 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemCheckedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a or + /// Represents the method that will handle the + /// event of a or /// . /// public delegate void ItemCheckedEventHandler(object sender, ItemCheckedEventArgs e); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventArgs.cs index 3aac5f179ae..f129e096a26 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class ItemDragEventArgs : EventArgs diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventHandler.cs index 2f16b714f0c..87520797b6b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ItemDragEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ItemDragEventHandler(object sender, ItemDragEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventArgs.cs index 737be181c47..b8cbc4f38d8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the or + /// Provides data for the or /// event. /// [ComVisible(true)] @@ -16,7 +16,7 @@ public class KeyEventArgs : EventArgs private bool _suppressKeyPress = false; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public KeyEventArgs(Keys keyData) { @@ -24,22 +24,22 @@ public KeyEventArgs(Keys keyData) } /// - /// Gets a value indicating whether the ALT key was pressed. + /// Gets a value indicating whether the ALT key was pressed. /// public virtual bool Alt => (KeyData & Keys.Alt) == Keys.Alt; /// - /// Gets a value indicating whether the CTRL key was pressed. + /// Gets a value indicating whether the CTRL key was pressed. /// public bool Control => (KeyData & Keys.Control) == Keys.Control; /// - /// Gets or sets a value indicating whether the event was handled. + /// Gets or sets a value indicating whether the event was handled. /// public bool Handled { get; set; } /// - /// Gets the keyboard code for a or + /// Gets the keyboard code for a or /// event. /// public Keys KeyCode @@ -58,26 +58,26 @@ public Keys KeyCode } /// - /// Gets the keyboard value for a or + /// Gets the keyboard value for a or /// event. /// public int KeyValue => (int)(KeyData & Keys.KeyCode); /// - /// Gets the key data for a or + /// Gets the key data for a or /// event. /// public Keys KeyData { get; } /// - /// Gets the modifier flags for a or + /// Gets the modifier flags for a or /// event. - /// This indicates which modifier keys (CTRL, SHIFT, and/or ALT) were pressed. + /// This indicates which modifier keys (CTRL, SHIFT, and/or ALT) were pressed. /// public Keys Modifiers => KeyData & Keys.Modifiers; /// - /// Gets a value indicating whether the SHIFT key was pressed. + /// Gets a value indicating whether the SHIFT key was pressed. /// public virtual bool Shift => (KeyData & Keys.Shift) == Keys.Shift; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventHandler.cs index 9391cbabb3b..b05214646d6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/KeyEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle the - /// or event of a + /// Represents a method that will handle the + /// or event of a /// . /// public delegate void KeyEventHandler(object sender, KeyEventArgs e); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventArgs.cs index 5654993df59..cebd7d43d70 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventArgs.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class KeyPressEventArgs : EventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public KeyPressEventArgs(char keyChar) { @@ -22,13 +22,13 @@ public KeyPressEventArgs(char keyChar) } /// - /// Gets the character corresponding to the key pressed. + /// Gets the character corresponding to the key pressed. /// public char KeyChar { get; set; } /// - /// Gets or sets a value indicating whether the - /// event was handled. + /// Gets or sets a value indicating whether the + /// event was handled. /// public bool Handled { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventHandler.cs index eb303c37a08..850b6420baa 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/KeyPressEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle the - /// event of a . + /// Represents a method that will handle the + /// event of a . /// public delegate void KeyPressEventHandler(object sender, KeyPressEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Keys.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Keys.cs index 9955eee9c22..42b424e77bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Keys.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Keys.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Specifies key codes and modifiers. + /// Specifies key codes and modifiers. /// [Flags] [TypeConverter(typeof(KeysConverter))] @@ -18,971 +18,971 @@ namespace System.Windows.Forms public enum Keys { /// - /// The bit mask to extract a key code from a key value. + /// The bit mask to extract a key code from a key value. /// KeyCode = 0x0000FFFF, /// - /// The bit mask to extract modifiers from a key value. + /// The bit mask to extract modifiers from a key value. /// Modifiers = unchecked((int)0xFFFF0000), /// - /// No key pressed. + /// No key pressed. /// None = 0x00, /// - /// The left mouse button. + /// The left mouse button. /// LButton = 0x01, /// - /// The right mouse button. + /// The right mouse button. /// RButton = 0x02, /// - /// The CANCEL key. + /// The CANCEL key. /// Cancel = 0x03, /// - /// The middle mouse button (three-button mouse). + /// The middle mouse button (three-button mouse). /// MButton = 0x04, /// - /// The first x mouse button (five-button mouse). + /// The first x mouse button (five-button mouse). /// XButton1 = 0x05, /// - /// The second x mouse button (five-button mouse). + /// The second x mouse button (five-button mouse). /// XButton2 = 0x06, /// - /// The BACKSPACE key. + /// The BACKSPACE key. /// Back = 0x08, /// - /// The TAB key. + /// The TAB key. /// Tab = 0x09, /// - /// The CLEAR key. + /// The CLEAR key. /// LineFeed = 0x0A, - /// The CLEAR key. + /// The CLEAR key. /// Clear = 0x0C, /// - /// The RETURN key. + /// The RETURN key. /// Return = 0x0D, /// - /// The ENTER key. + /// The ENTER key. /// Enter = Return, /// - /// The SHIFT key. + /// The SHIFT key. /// ShiftKey = 0x10, /// - /// The CTRL key. + /// The CTRL key. /// ControlKey = 0x11, /// - /// The ALT key. + /// The ALT key. /// Menu = 0x12, /// - /// The PAUSE key. + /// The PAUSE key. /// Pause = 0x13, /// - /// The CAPS LOCK key. + /// The CAPS LOCK key. /// Capital = 0x14, /// - /// The CAPS LOCK key. + /// The CAPS LOCK key. /// CapsLock = 0x14, /// - /// The IME Kana mode key. + /// The IME Kana mode key. /// KanaMode = 0x15, /// - /// The IME Hanguel mode key. + /// The IME Hanguel mode key. /// HanguelMode = 0x15, /// - /// The IME Hangul mode key. + /// The IME Hangul mode key. /// HangulMode = 0x15, /// - /// The IME Junja mode key. + /// The IME Junja mode key. /// JunjaMode = 0x17, /// - /// The IME Final mode key. + /// The IME Final mode key. /// FinalMode = 0x18, /// - /// The IME Hanja mode key. + /// The IME Hanja mode key. /// HanjaMode = 0x19, /// - /// The IME Kanji mode key. + /// The IME Kanji mode key. /// KanjiMode = 0x19, /// - /// The ESC key. + /// The ESC key. /// Escape = 0x1B, /// - /// The IME Convert key. + /// The IME Convert key. /// IMEConvert = 0x1C, /// - /// The IME NonConvert key. + /// The IME NonConvert key. /// IMENonconvert = 0x1D, /// - /// The IME Accept key. + /// The IME Accept key. /// IMEAccept = 0x1E, /// - /// The IME Accept key. + /// The IME Accept key. /// IMEAceept = IMEAccept, /// - /// The IME Mode change request. + /// The IME Mode change request. /// IMEModeChange = 0x1F, /// - /// The SPACEBAR key. + /// The SPACEBAR key. /// Space = 0x20, /// - /// The PAGE UP key. + /// The PAGE UP key. /// Prior = 0x21, /// - /// The PAGE UP key. + /// The PAGE UP key. /// PageUp = Prior, /// - /// The PAGE DOWN key. + /// The PAGE DOWN key. /// Next = 0x22, /// - /// The PAGE DOWN key. + /// The PAGE DOWN key. /// PageDown = Next, /// - /// The END key. + /// The END key. /// End = 0x23, /// - /// The HOME key. + /// The HOME key. /// Home = 0x24, /// - /// The LEFT ARROW key. + /// The LEFT ARROW key. /// Left = 0x25, /// - /// The UP ARROW key. + /// The UP ARROW key. /// Up = 0x26, /// - /// The RIGHT ARROW key. + /// The RIGHT ARROW key. /// Right = 0x27, /// - /// The DOWN ARROW key. + /// The DOWN ARROW key. /// Down = 0x28, /// - /// The SELECT key. + /// The SELECT key. /// Select = 0x29, /// - /// The PRINT key. + /// The PRINT key. /// Print = 0x2A, /// - /// The EXECUTE key. + /// The EXECUTE key. /// Execute = 0x2B, /// - /// The PRINT SCREEN key. + /// The PRINT SCREEN key. /// Snapshot = 0x2C, /// - /// The PRINT SCREEN key. + /// The PRINT SCREEN key. /// PrintScreen = Snapshot, /// - /// The INS key. + /// The INS key. /// Insert = 0x2D, /// - /// The DEL key. + /// The DEL key. /// Delete = 0x2E, /// - /// The HELP key. + /// The HELP key. /// Help = 0x2F, /// - /// The 0 key. + /// The 0 key. /// D0 = 0x30, // 0 /// - /// The 1 key. + /// The 1 key. /// D1 = 0x31, // 1 /// - /// The 2 key. + /// The 2 key. /// D2 = 0x32, // 2 /// - /// The 3 key. + /// The 3 key. /// D3 = 0x33, // 3 /// - /// The 4 key. + /// The 4 key. /// D4 = 0x34, // 4 /// - /// The 5 key. + /// The 5 key. /// D5 = 0x35, // 5 /// - /// The 6 key. + /// The 6 key. /// D6 = 0x36, // 6 /// - /// The 7 key. + /// The 7 key. /// D7 = 0x37, // 7 /// - /// The 8 key. + /// The 8 key. /// D8 = 0x38, // 8 /// - /// The 9 key. + /// The 9 key. /// D9 = 0x39, // 9 /// - /// The A key. + /// The A key. /// A = 0x41, /// - /// The B key. + /// The B key. /// B = 0x42, /// - /// The C key. + /// The C key. /// C = 0x43, /// - /// The D key. + /// The D key. /// D = 0x44, /// - /// The E key. + /// The E key. /// E = 0x45, /// - /// The F key. + /// The F key. /// F = 0x46, /// - /// The G key. + /// The G key. /// G = 0x47, /// - /// The H key. + /// The H key. /// H = 0x48, /// - /// The I key. + /// The I key. /// I = 0x49, /// - /// The J key. + /// The J key. /// J = 0x4A, /// - /// The K key. + /// The K key. /// K = 0x4B, /// - /// The L key. + /// The L key. /// L = 0x4C, /// - /// The M key. + /// The M key. /// M = 0x4D, /// - /// The N key. + /// The N key. /// N = 0x4E, /// - /// The O key. + /// The O key. /// O = 0x4F, /// - /// The P key. + /// The P key. /// P = 0x50, /// - /// The Q key. + /// The Q key. /// Q = 0x51, /// - /// The R key. + /// The R key. /// R = 0x52, /// - /// The S key. + /// The S key. /// S = 0x53, /// - /// The T key. + /// The T key. /// T = 0x54, /// - /// The U key. + /// The U key. /// U = 0x55, /// - /// The V key. + /// The V key. /// V = 0x56, /// - /// The W key. + /// The W key. /// W = 0x57, /// - /// The X key. + /// The X key. /// X = 0x58, /// - /// The Y key. + /// The Y key. /// Y = 0x59, /// - /// The Z key. + /// The Z key. /// Z = 0x5A, /// - /// The left Windows logo key (Microsoft Natural Keyboard). + /// The left Windows logo key (Microsoft Natural Keyboard). /// LWin = 0x5B, /// - /// The right Windows logo key (Microsoft Natural Keyboard). + /// The right Windows logo key (Microsoft Natural Keyboard). /// RWin = 0x5C, /// - /// The Application key (Microsoft Natural Keyboard). + /// The Application key (Microsoft Natural Keyboard). /// Apps = 0x5D, /// - /// The Computer Sleep key. + /// The Computer Sleep key. /// Sleep = 0x5F, /// - /// The 0 key on the numeric keypad. + /// The 0 key on the numeric keypad. /// NumPad0 = 0x60, /// - /// The 1 key on the numeric keypad. + /// The 1 key on the numeric keypad. /// NumPad1 = 0x61, /// - /// The 2 key on the numeric keypad. + /// The 2 key on the numeric keypad. /// NumPad2 = 0x62, /// - /// The 3 key on the numeric keypad. + /// The 3 key on the numeric keypad. /// NumPad3 = 0x63, /// - /// The 4 key on the numeric keypad. + /// The 4 key on the numeric keypad. /// NumPad4 = 0x64, /// - /// The 5 key on the numeric keypad. + /// The 5 key on the numeric keypad. /// NumPad5 = 0x65, /// - /// The 6 key on the numeric keypad. + /// The 6 key on the numeric keypad. /// NumPad6 = 0x66, /// - /// The 7 key on the numeric keypad. + /// The 7 key on the numeric keypad. /// NumPad7 = 0x67, /// - /// The 8 key on the numeric keypad. + /// The 8 key on the numeric keypad. /// NumPad8 = 0x68, /// - /// The 9 key on the numeric keypad. + /// The 9 key on the numeric keypad. /// NumPad9 = 0x69, /// - /// The Multiply key. + /// The Multiply key. /// Multiply = 0x6A, /// - /// The Add key. + /// The Add key. /// Add = 0x6B, /// - /// The Separator key. + /// The Separator key. /// Separator = 0x6C, /// - /// The Subtract key. + /// The Subtract key. /// Subtract = 0x6D, /// - /// The Decimal key. + /// The Decimal key. /// Decimal = 0x6E, /// - /// The Divide key. + /// The Divide key. /// Divide = 0x6F, /// - /// The F1 key. + /// The F1 key. /// F1 = 0x70, /// - /// The F2 key. + /// The F2 key. /// F2 = 0x71, /// - /// The F3 key. + /// The F3 key. /// F3 = 0x72, /// - /// The F4 key. + /// The F4 key. /// F4 = 0x73, /// - /// The F5 key. + /// The F5 key. /// F5 = 0x74, /// - /// The F6 key. + /// The F6 key. /// F6 = 0x75, /// - /// The F7 key. + /// The F7 key. /// F7 = 0x76, /// - /// The F8 key. + /// The F8 key. /// F8 = 0x77, /// - /// The F9 key. + /// The F9 key. /// F9 = 0x78, /// - /// The F10 key. + /// The F10 key. /// F10 = 0x79, /// - /// The F11 key. + /// The F11 key. /// F11 = 0x7A, /// - /// The F12 key. + /// The F12 key. /// F12 = 0x7B, /// - /// The F13 key. + /// The F13 key. /// F13 = 0x7C, /// - /// The F14 key. + /// The F14 key. /// F14 = 0x7D, /// - /// The F15 key. + /// The F15 key. /// F15 = 0x7E, /// - /// The F16 key. + /// The F16 key. /// F16 = 0x7F, /// - /// The F17 key. + /// The F17 key. /// F17 = 0x80, /// - /// The F18 key. + /// The F18 key. /// F18 = 0x81, /// - /// The F19 key. + /// The F19 key. /// F19 = 0x82, /// - /// The F20 key. + /// The F20 key. /// F20 = 0x83, /// - /// The F21 key. + /// The F21 key. /// F21 = 0x84, /// - /// The F22 key. + /// The F22 key. /// F22 = 0x85, /// - /// The F23 key. + /// The F23 key. /// F23 = 0x86, /// - /// The F24 key. + /// The F24 key. /// F24 = 0x87, /// - /// The NUM LOCK key. + /// The NUM LOCK key. /// NumLock = 0x90, /// - /// The SCROLL LOCK key. + /// The SCROLL LOCK key. /// Scroll = 0x91, /// - /// The left SHIFT key. + /// The left SHIFT key. /// LShiftKey = 0xA0, /// - /// The right SHIFT key. + /// The right SHIFT key. /// RShiftKey = 0xA1, /// - /// The left CTRL key. + /// The left CTRL key. /// LControlKey = 0xA2, /// - /// The right CTRL key. + /// The right CTRL key. /// RControlKey = 0xA3, /// - /// The left ALT key. + /// The left ALT key. /// LMenu = 0xA4, /// - /// The right ALT key. + /// The right ALT key. /// RMenu = 0xA5, /// - /// The Browser Back key. + /// The Browser Back key. /// BrowserBack = 0xA6, /// - /// The Browser Forward key. + /// The Browser Forward key. /// BrowserForward = 0xA7, /// - /// The Browser Refresh key. + /// The Browser Refresh key. /// BrowserRefresh = 0xA8, /// - /// The Browser Stop key. + /// The Browser Stop key. /// BrowserStop = 0xA9, /// - /// The Browser Search key. + /// The Browser Search key. /// BrowserSearch = 0xAA, /// - /// The Browser Favorites key. + /// The Browser Favorites key. /// BrowserFavorites = 0xAB, /// - /// The Browser Home key. + /// The Browser Home key. /// BrowserHome = 0xAC, /// - /// The Volume Mute key. + /// The Volume Mute key. /// VolumeMute = 0xAD, /// - /// The Volume Down key. + /// The Volume Down key. /// VolumeDown = 0xAE, /// - /// The Volume Up key. + /// The Volume Up key. /// VolumeUp = 0xAF, /// - /// The Media Next Track key. + /// The Media Next Track key. /// MediaNextTrack = 0xB0, /// - /// The Media Previous Track key. + /// The Media Previous Track key. /// MediaPreviousTrack = 0xB1, /// - /// The Media Stop key. + /// The Media Stop key. /// MediaStop = 0xB2, /// - /// The Media Play Pause key. + /// The Media Play Pause key. /// MediaPlayPause = 0xB3, /// - /// The Launch Mail key. + /// The Launch Mail key. /// LaunchMail = 0xB4, /// - /// The Select Media key. + /// The Select Media key. /// SelectMedia = 0xB5, /// - /// The Launch Application1 key. + /// The Launch Application1 key. /// LaunchApplication1 = 0xB6, /// - /// The Launch Application2 key. + /// The Launch Application2 key. /// LaunchApplication2 = 0xB7, /// - /// The Oem Semicolon key. + /// The Oem Semicolon key. /// OemSemicolon = 0xBA, /// - /// The Oem 1 key. + /// The Oem 1 key. /// Oem1 = OemSemicolon, /// - /// The Oem plus key. + /// The Oem plus key. /// Oemplus = 0xBB, /// - /// The Oem comma key. + /// The Oem comma key. /// Oemcomma = 0xBC, /// - /// The Oem Minus key. + /// The Oem Minus key. /// OemMinus = 0xBD, /// - /// The Oem Period key. + /// The Oem Period key. /// OemPeriod = 0xBE, /// - /// The Oem Question key. + /// The Oem Question key. /// OemQuestion = 0xBF, /// - /// The Oem 2 key. + /// The Oem 2 key. /// Oem2 = OemQuestion, /// - /// The Oem tilde key. + /// The Oem tilde key. /// Oemtilde = 0xC0, /// - /// The Oem 3 key. + /// The Oem 3 key. /// Oem3 = Oemtilde, /// - /// The Oem Open Brackets key. + /// The Oem Open Brackets key. /// OemOpenBrackets = 0xDB, /// - /// The Oem 4 key. + /// The Oem 4 key. /// Oem4 = OemOpenBrackets, /// - /// The Oem Pipe key. + /// The Oem Pipe key. /// OemPipe = 0xDC, /// - /// The Oem 5 key. + /// The Oem 5 key. /// Oem5 = OemPipe, /// - /// The Oem Close Brackets key. + /// The Oem Close Brackets key. /// OemCloseBrackets = 0xDD, /// - /// The Oem 6 key. + /// The Oem 6 key. /// Oem6 = OemCloseBrackets, /// - /// The Oem Quotes key. + /// The Oem Quotes key. /// OemQuotes = 0xDE, /// - /// The Oem 7 key. + /// The Oem 7 key. /// Oem7 = OemQuotes, /// - /// The Oem8 key. + /// The Oem8 key. /// Oem8 = 0xDF, /// - /// The Oem Backslash key. + /// The Oem Backslash key. /// OemBackslash = 0xE2, /// - /// The Oem 102 key. + /// The Oem 102 key. /// Oem102 = OemBackslash, /// - /// The PROCESS KEY key. + /// The PROCESS KEY key. /// ProcessKey = 0xE5, /// - /// The Packet KEY key. + /// The Packet KEY key. /// Packet = 0xE7, /// - /// The ATTN key. + /// The ATTN key. /// Attn = 0xF6, /// - /// The CRSEL key. + /// The CRSEL key. /// Crsel = 0xF7, /// - /// The EXSEL key. + /// The EXSEL key. /// Exsel = 0xF8, /// - /// The ERASE EOF key. + /// The ERASE EOF key. /// EraseEof = 0xF9, /// - /// The PLAY key. + /// The PLAY key. /// Play = 0xFA, /// - /// The ZOOM key. + /// The ZOOM key. /// Zoom = 0xFB, /// - /// A constant reserved for future use. + /// A constant reserved for future use. /// NoName = 0xFC, /// - /// The PA1 key. + /// The PA1 key. /// Pa1 = 0xFD, /// - /// The CLEAR key. + /// The CLEAR key. /// OemClear = 0xFE, /// - /// The SHIFT modifier key. + /// The SHIFT modifier key. /// Shift = 0x00010000, /// - /// The CTRL modifier key. + /// The CTRL modifier key. /// Control = 0x00020000, /// - /// The ALT modifier key. + /// The ALT modifier key. /// Alt = 0x00040000, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/KeysConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/KeysConverter.cs index c1d19e7d925..7748e886ab2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/KeysConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/KeysConverter.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// Provides a type converter to convert objects to and from various + /// Provides a type converter to convert objects to and from various /// other representations. /// public class KeysConverter : TypeConverter, IComparer diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Label.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Label.cs index 1dd7216869d..573f0b44f0a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Label.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Label.cs @@ -71,7 +71,6 @@ public class Label : Control, IAutomationLiveRegion // } End Members /////////////////////////////////////////////////////////////////////// - /// /// Initializes a new instance of the class. /// @@ -676,8 +675,8 @@ public ContentAlignment ImageAlign } /// - /// Indicates the "politeness" level that a client should use - /// to notify the user of changes to the live region. + /// Indicates the "politeness" level that a client should use + /// to notify the user of changes to the live region. /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -1372,10 +1371,10 @@ internal override bool IsMnemonicsListenerAxSourced } /// - /// This method is required because the Label constructor needs to know if the control is - /// OwnerDraw but it should not call the virtual property because if a derived class has - /// overridden the method, the derived class version will be called (before the derived - /// class constructor is called). + /// This method is required because the Label constructor needs to know if the control is + /// OwnerDraw but it should not call the virtual property because if a derived class has + /// overridden the method, the derived class version will be called (before the derived + /// class constructor is called). /// private bool IsOwnerDraw() => FlatStyle != FlatStyle.System; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventArgs.cs index c77a4962875..54289c34834 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventArgs.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class LabelEditEventArgs : EventArgs { /// - /// Initializes a new instance of the - /// class with the specified index to the - /// to edit. + /// Initializes a new instance of the + /// class with the specified index to the + /// to edit. /// public LabelEditEventArgs(int item) : this(item, null) { } /// - /// Initializes a new instance of the - /// class with the specified index to the - /// being edited and the new text for the label of the . + /// Initializes a new instance of the + /// class with the specified index to the + /// being edited and the new text for the label of the . /// public LabelEditEventArgs(int item, string label) { @@ -30,18 +30,18 @@ public LabelEditEventArgs(int item, string label) } /// - /// Gets the zero-based index of the containing - /// the label to edit. + /// Gets the zero-based index of the containing + /// the label to edit. /// public int Item { get; } /// - /// Gets the new text assigned to the label of the . + /// Gets the new text assigned to the label of the . /// public string Label { get; } /// - /// Gets or sets a value indicating whether changes made to the label of the + /// Gets or sets a value indicating whether changes made to the label of the /// should be canceled. /// public bool CancelEdit { get; set; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventHandler.cs index 466159c74aa..aaa1870c9f5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LabelEditEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void LabelEditEventHandler(object sender, LabelEditEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/ArrangedElementCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/ArrangedElementCollection.cs index fecedfa4f9b..9535285c36c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/ArrangedElementCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/ArrangedElementCollection.cs @@ -59,7 +59,7 @@ public override int GetHashCode() } /// - /// Repositions a element in this list. + /// Repositions a element in this list. /// private protected void MoveElement(IArrangedElement element, int fromIndex, int toIndex) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/CommonProperties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/CommonProperties.cs index fd41fa71c16..b9f3e9a091c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/CommonProperties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/CommonProperties.cs @@ -64,7 +64,7 @@ private enum DockAnchorMode #region AppliesToAllLayouts - /// ClearMaximumSize + /// ClearMaximumSize /// Removes the maximum size from the property store, making it "unset". /// internal static void ClearMaximumSize(IArrangedElement element) @@ -75,7 +75,7 @@ internal static void ClearMaximumSize(IArrangedElement element) } } - /// GetAutoSize + /// GetAutoSize /// Determines whether or not the System.Windows.Forms.Layout LayoutEngines /// think the element is AutoSized. /// @@ -90,7 +90,7 @@ internal static bool GetAutoSize(IArrangedElement element) return value != 0; } - /// GetMargin + /// GetMargin /// Returns the Margin (exterior space) for an item /// /// We can not use our pattern of passing the default value into Margin because the @@ -106,7 +106,7 @@ internal static Padding GetMargin(IArrangedElement element) return DefaultMargin; } - /// GetMaximumSize + /// GetMaximumSize /// Returns the maximum size for an element internal static Size GetMaximumSize(IArrangedElement element, Size defaultMaximumSize) { @@ -118,7 +118,7 @@ internal static Size GetMaximumSize(IArrangedElement element, Size defaultMaximu return defaultMaximumSize; } - /// GetMinimumSize + /// GetMinimumSize /// Returns the minimum size for an element internal static Size GetMinimumSize(IArrangedElement element, Size defaultMinimumSize) { @@ -130,12 +130,12 @@ internal static Size GetMinimumSize(IArrangedElement element, Size defaultMinimu return defaultMinimumSize; } - /// GetPadding + /// GetPadding /// Returns the padding for an element /// Typically the padding is accounted for in either the DisplayRectangle calculation /// and/or the GetPreferredSize calculation of a control. /// - /// NOTE: LayoutEngines should never read this property. Padding gets incorperated into + /// NOTE: LayoutEngines should never read this property. Padding gets incorperated into /// layout by modifying what the control reports for preferred size. internal static Padding GetPadding(IArrangedElement element, Padding defaultPadding) { @@ -147,7 +147,7 @@ internal static Padding GetPadding(IArrangedElement element, Padding defaultPadd return defaultPadding; } - /// GetSpecifiedBounds + /// GetSpecifiedBounds /// Returns the last size manually set into the element. See UpdateSpecifiedBounds. internal static Rectangle GetSpecifiedBounds(IArrangedElement element) { @@ -159,7 +159,7 @@ internal static Rectangle GetSpecifiedBounds(IArrangedElement element) return element.Bounds; } - /// ResetPadding + /// ResetPadding /// clears out the padding from the property store internal static void ResetPadding(IArrangedElement element) { @@ -170,7 +170,7 @@ internal static void ResetPadding(IArrangedElement element) } } - /// SetAutoSize + /// SetAutoSize /// Sets whether or not the layout engines should treat this control as auto sized. internal static void SetAutoSize(IArrangedElement element, bool value) { @@ -188,7 +188,7 @@ internal static void SetAutoSize(IArrangedElement element, bool value) Debug.Assert(GetAutoSize(element) == value, "Error detected setting AutoSize."); } - /// SetMargin + /// SetMargin /// Sets the margin (exterior space) for an element. internal static void SetMargin(IArrangedElement element, Padding value) { @@ -202,7 +202,7 @@ internal static void SetMargin(IArrangedElement element, Padding value) } - /// SetMaximumSize + /// SetMaximumSize /// Sets the maximum size for an element. internal static void SetMaximumSize(IArrangedElement element, Size value) { @@ -224,7 +224,7 @@ internal static void SetMaximumSize(IArrangedElement element, Size value) Debug.Assert(GetMaximumSize(element, new Size(-7109, -7107)) == value, "Error detected setting MaximumSize."); } - /// SetMinimumSize + /// SetMinimumSize /// Sets the minimum size for an element. internal static void SetMinimumSize(IArrangedElement element, Size value) { @@ -246,7 +246,7 @@ internal static void SetMinimumSize(IArrangedElement element, Size value) Debug.Assert(GetMinimumSize(element, new Size(-7109, -7107)) == value, "Error detected setting MinimumSize."); } - /// SetPadding + /// SetPadding /// Sets the padding (interior space) for an element. See GetPadding for more detiails. /// NOTE: It is the callers responsibility to do layout. See Control.Padding for details. internal static void SetPadding(IArrangedElement element, Padding value) @@ -260,7 +260,7 @@ internal static void SetPadding(IArrangedElement element, Padding value) Debug.Assert(GetPadding(element, new Padding(-7105)) == value, "Error detected setting Padding."); } - /// UpdateSpecifiedBounds + /// UpdateSpecifiedBounds /// The main purpose of this function is to remember what size someone specified in the Size, Width, Height, Bounds /// property. (Its the whole reason the BoundsSpecified enum exists.) Consider this scenario. You set a Button /// to DockStyle.Fill, then DockStyle.None. When Dock.Filled, the Size changed to 300,300. When you @@ -331,12 +331,11 @@ internal static void UpdateSpecifiedBounds(IArrangedElement element, int x, int element.Properties.SetRectangle(_specifiedBoundsProperty, bounds); } - /// xClearPreferredSizeCache + /// xClearPreferredSizeCache /// clears the preferred size cached for any control that overrides /// the internal GetPreferredSizeCore method. DO NOT CALL DIRECTLY /// unless it is understood how the size of the control is going to be updated. /// - internal static void xClearPreferredSizeCache(IArrangedElement element) { element.Properties.SetSize(_preferredSizeCacheProperty, LayoutUtils.InvalidSize); @@ -347,7 +346,7 @@ internal static void xClearPreferredSizeCache(IArrangedElement element) Debug.Assert(xGetPreferredSizeCache(element) == Size.Empty, "Error detected in xClearPreferredSizeCache."); } - /// xClearAllPreferredSizeCaches + /// xClearAllPreferredSizeCaches /// clears all the caching for an IArrangedElement hierarchy /// typically done in dispose. internal static void xClearAllPreferredSizeCaches(IArrangedElement start) @@ -365,7 +364,7 @@ internal static void xClearAllPreferredSizeCaches(IArrangedElement start) } } - /// xGetPreferredSizeCache + /// xGetPreferredSizeCache /// This value is the cached result of the return value from /// a control's GetPreferredSizeCore implementation when asked /// for a constraining value of LayoutUtils.MaxValue (or Size.Empty too). @@ -379,7 +378,7 @@ internal static Size xGetPreferredSizeCache(IArrangedElement element) return Size.Empty; } - /// xSetPreferredSizeCache + /// xSetPreferredSizeCache /// Sets a control's preferred size. See xGetPreferredSizeCache. internal static void xSetPreferredSizeCache(IArrangedElement element, Size value) { @@ -395,7 +394,7 @@ internal static void xSetPreferredSizeCache(IArrangedElement element, Size value #region DockAndAnchorLayoutSpecific - /// GetAutoSizeMode + /// GetAutoSizeMode /// Returns whether or not a control should snap to its smallest size /// or retain its original size and only grow if the preferred size is larger. /// We tried not having GrowOnly as the default, but it becomes difficult @@ -406,7 +405,7 @@ internal static AutoSizeMode GetAutoSizeMode(IArrangedElement element) return state[_autoSizeModeSection] == 0 ? AutoSizeMode.GrowOnly : AutoSizeMode.GrowAndShrink; } - /// GetNeedsDockAndAnchorLayout + /// GetNeedsDockAndAnchorLayout /// Do not use. Internal property for DockAndAnchor layout. /// Returns true if DefaultLayout needs to do any work for this element. /// (Returns false if the element is purely absolutely positioned) @@ -424,7 +423,7 @@ internal static bool GetNeedsDockAndAnchorLayout(IArrangedElement element) return result; } - /// GetNeedsAnchorLayout + /// GetNeedsAnchorLayout /// Do not use. Internal property for DockAndAnchor layout. /// Returns true if DefaultLayout needs to do anchoring for this element. internal static bool GetNeedsAnchorLayout(IArrangedElement element) @@ -440,7 +439,7 @@ internal static bool GetNeedsAnchorLayout(IArrangedElement element) return result; } - /// GetNeedsDockLayout + /// GetNeedsDockLayout /// Do not use. Internal property for DockAndAnchor layout. /// Returns true if DefaultLayout needs to do docking for this element. internal static bool GetNeedsDockLayout(IArrangedElement element) @@ -454,7 +453,7 @@ internal static bool GetNeedsDockLayout(IArrangedElement element) return result; } - /// GetSelfAutoSize + /// GetSelfAutoSize /// Compat flag for controls that previously sized themselves. /// Some controls rolled their own implementation of AutoSize in V1 for Dock & Anchor /// In V2, the LayoutEngine is the one responsible for sizing the child items when @@ -467,7 +466,7 @@ internal static bool GetSelfAutoSizeInDefaultLayout(IArrangedElement element) return (value == 1); } - /// SetAutoSizeMode + /// SetAutoSizeMode /// Returns whether or not a control should snap to its smallest size /// or retain its original size and only grow if the preferred size is larger. /// We tried not having GrowOnly as the default, but it becomes difficult @@ -479,7 +478,7 @@ internal static void SetAutoSizeMode(IArrangedElement element, AutoSizeMode mode SetLayoutState(element, state); } - /// ShouldSelfSize + /// ShouldSelfSize /// Compat flag for controls that previously sized themselves. /// See GetSelfAutoSize comments. internal static bool ShouldSelfSize(IArrangedElement element) @@ -503,7 +502,7 @@ internal static bool ShouldSelfSize(IArrangedElement element) return true; } - /// SetSelfAutoSizeInDefaultLayout + /// SetSelfAutoSizeInDefaultLayout /// Compat flag for controls that previously sized themselves. /// See GetSelfAutoSize comments. internal static void SetSelfAutoSizeInDefaultLayout(IArrangedElement element, bool value) @@ -517,7 +516,7 @@ internal static void SetSelfAutoSizeInDefaultLayout(IArrangedElement element, bo Debug.Assert(GetSelfAutoSizeInDefaultLayout(element) == value, "Error detected setting AutoSize."); } - /// xGetAnchor - + /// xGetAnchor - /// Do not use this. Use DefaultLayout.GetAnchor. /// NOTE that Dock and Anchor are exclusive, so we store their enums in the same section. internal static AnchorStyles xGetAnchor(IArrangedElement element) @@ -533,7 +532,7 @@ internal static AnchorStyles xGetAnchor(IArrangedElement element) return value; } - /// xGetAutoSizedAndAnchored - + /// xGetAutoSizedAndAnchored - /// Do not use. Internal property for DockAndAnchor layout. /// Returns true if the element is both AutoSized and Anchored. internal static bool xGetAutoSizedAndAnchored(IArrangedElement element) @@ -551,7 +550,7 @@ internal static bool xGetAutoSizedAndAnchored(IArrangedElement element) return result; } - /// xGetDock + /// xGetDock /// Do not use this. Use DefaultLayout.GetDock. /// Note that Dock and Anchor are exclusive, so we store their enums in the same section. internal static DockStyle xGetDock(IArrangedElement element) @@ -570,7 +569,7 @@ internal static DockStyle xGetDock(IArrangedElement element) return value; } - /// xSetAnchor - + /// xSetAnchor - /// Do not use this. Use DefaultLayout.SetAnchor. /// Note that Dock and Anchor are exclusive, so we store their enums in the same section. internal static void xSetAnchor(IArrangedElement element, AnchorStyles value) @@ -589,7 +588,7 @@ internal static void xSetAnchor(IArrangedElement element, AnchorStyles value) "xSetAnchor did not set mode to Anchor."); } - /// xSetDock + /// xSetDock /// Do not use this. Use DefaultLayout.SetDock. /// Note that Dock and Anchor are exclusive, so we store their enums in the same section. internal static void xSetDock(IArrangedElement element, DockStyle value) @@ -609,7 +608,7 @@ internal static void xSetDock(IArrangedElement element, DockStyle value) == (value != DockStyle.None), "xSetDock set DockMode incorrectly."); } - /// xTranslateAnchorValue - + /// xTranslateAnchorValue - /// Helper method for xGetAnchor / xSetAnchor. /// We store anchor DefualtAnchor as None and vice versa. /// We either had to do this or map Dock.None to DefaultAnchor (Dock & Anchor share the same section @@ -639,7 +638,7 @@ internal static bool GetFlowBreak(IArrangedElement element) return value == 1; } - /// SetFlowBreak + /// SetFlowBreak /// Use FlowLayoutSettings.SetFlowBreak instead. /// See GetFlowBreak. internal static void SetFlowBreak(IArrangedElement element, bool value) @@ -657,7 +656,7 @@ internal static void SetFlowBreak(IArrangedElement element, bool value) #endregion #region AutoScrollSpecific - /// GetLayoutBounds - + /// GetLayoutBounds - /// This is the size used to determine whether or not we need scrollbars. /// /// Used if the layoutengine always want to return the same layout bounds regardless @@ -672,7 +671,7 @@ internal static Size GetLayoutBounds(IArrangedElement element) return Size.Empty; } - /// SetLayoutBounds - + /// SetLayoutBounds - /// This is the size used to determine whether or not we need scrollbars. /// /// The TableLayout engine now calls CommonProperties.SetLayoutBounds when @@ -688,7 +687,7 @@ internal static void SetLayoutBounds(IArrangedElement element, Size value) element.Properties.SetSize(_layoutBoundsProperty, value); } - /// HasLayoutBounds - + /// HasLayoutBounds - /// Returns whether we have layout bounds stored for this element. internal static bool HasLayoutBounds(IArrangedElement element) { @@ -699,7 +698,7 @@ internal static bool HasLayoutBounds(IArrangedElement element) #endregion #region InternalCommonPropertiesHelpers - /// GetLayoutState - returns the layout state bit vector from the property store. + /// GetLayoutState - returns the layout state bit vector from the property store. /// CAREFUL: this is a copy of the state. You need to SetLayoutState() to save your changes. /// internal static BitVector32 GetLayoutState(IArrangedElement element) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/DockAndAnchorLayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/DockAndAnchorLayout.cs index 2919d126e17..a9bda4896ca 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/DockAndAnchorLayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/DockAndAnchorLayout.cs @@ -18,9 +18,9 @@ internal class DefaultLayout : LayoutEngine private static readonly int s_cachedBoundsProperty = PropertyStore.CreateKey(); /// - /// Loop through the AutoSized controls and expand them if they are smaller than - /// their preferred size. If expanding the controls causes overlap, bump the overlapped - /// control if it is AutoRelocatable. + /// Loop through the AutoSized controls and expand them if they are smaller than + /// their preferred size. If expanding the controls causes overlap, bump the overlapped + /// control if it is AutoRelocatable. /// private static void LayoutAutoSizedControls(IArrangedElement container) { @@ -71,9 +71,9 @@ private static void LayoutAutoSizedControls(IArrangedElement container) } /// - /// Gets the bounds of the element after growing to newSize (note that depending on - /// anchoring the element may grow to the left/updwards rather than to the - /// right/downwards. i.e., it may be translated.) + /// Gets the bounds of the element after growing to newSize (note that depending on + /// anchoring the element may grow to the left/updwards rather than to the + /// right/downwards. i.e., it may be translated.) /// private static Rectangle GetGrowthBounds(IArrangedElement element, Size newSize) { @@ -104,7 +104,7 @@ private static Rectangle GetGrowthBounds(IArrangedElement element, Size newSize) } /// - /// Examines an elements anchoring to figure out which direction it should grow. + /// Examines an elements anchoring to figure out which direction it should grow. /// private static GrowthDirection GetGrowthDirection(IArrangedElement element) { @@ -145,7 +145,7 @@ private static GrowthDirection GetGrowthDirection(IArrangedElement element) } /// - /// Layout for a single anchored control. There's no order dependency when laying out anchored controls. + /// Layout for a single anchored control. There's no order dependency when laying out anchored controls. /// private static Rectangle GetAnchorDestination(IArrangedElement element, Rectangle displayRect, bool measureOnly) { @@ -396,8 +396,8 @@ private static Size LayoutDockedControls(IArrangedElement container, bool measur } /// - /// Helper method that either sets the element bounds or does the preferredSize computation based on - /// the value of measureOnly. + /// Helper method that either sets the element bounds or does the preferredSize computation based on + /// the value of measureOnly. /// private static void TryCalculatePreferredSizeDockedControl(IArrangedElement element, Rectangle newElementBounds, bool measureOnly, ref Size preferredSize, ref Rectangle remainingBounds) { @@ -509,7 +509,7 @@ private protected override bool LayoutCore(IArrangedElement container, LayoutEve } /// - /// PreferredSize is only computed if measureOnly = true. + /// PreferredSize is only computed if measureOnly = true. /// private static bool TryCalculatePreferredSize(IArrangedElement container, bool measureOnly, out Size preferredSize) { @@ -604,8 +604,8 @@ private static bool TryCalculatePreferredSize(IArrangedElement container, bool m } /// - /// Updates the Anchor information based on the controls current bounds. This should only be called - /// when the parent control changes or the anchor mode changes. + /// Updates the Anchor information based on the controls current bounds. This should only be called + /// when the parent control changes or the anchor mode changes. /// private static void UpdateAnchorInfo(IArrangedElement element) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/FlowLayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/FlowLayout.cs index 4e6dc867572..36cbc8ac075 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/FlowLayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/FlowLayout.cs @@ -87,8 +87,8 @@ private static ContainerProxy CreateContainerProxy(IArrangedElement container, F } /// - /// Both LayoutCore and GetPreferredSize forward to this method. - /// The measureOnly flag determines which behavior we get. + /// Both LayoutCore and GetPreferredSize forward to this method. + /// The measureOnly flag determines which behavior we get. /// private Size TryCalculatePreferredSize(IArrangedElement container, Rectangle displayRect, bool measureOnly) { @@ -147,9 +147,9 @@ private Size TryCalculatePreferredSize(IArrangedElement container, Rectangle dis } /// - /// Just forwards to TryCalculatePreferredSizeRow. This will layout elements from the start index to the end - /// index. RowBounds was computed by a call to measure row and is used for alignment/boxstretch. - /// See the ElementProxy class for an explaination of the elementProxy parameter. + /// Just forwards to TryCalculatePreferredSizeRow. This will layout elements from the start index to the end + /// index. RowBounds was computed by a call to measure row and is used for alignment/boxstretch. + /// See the ElementProxy class for an explaination of the elementProxy parameter. /// private void LayoutRow(ContainerProxy containerProxy, ElementProxy elementProxy, int startIndex, int endIndex, Rectangle rowBounds) { @@ -158,10 +158,10 @@ private void LayoutRow(ContainerProxy containerProxy, ElementProxy elementProxy, } // - /// Just forwards to TryCalculatePreferredSizeRow. breakIndex is the index of the first control not to - /// fit in the displayRectangle. The returned Size is the size required to layout the - /// controls from startIndex up to but not including breakIndex. See the ElementProxy - /// class for an explaination of the elementProxy parameter. + /// Just forwards to TryCalculatePreferredSizeRow. breakIndex is the index of the first control not to + /// fit in the displayRectangle. The returned Size is the size required to layout the + /// controls from startIndex up to but not including breakIndex. See the ElementProxy + /// class for an explaination of the elementProxy parameter. /// private Size MeasureRow(ContainerProxy containerProxy, ElementProxy elementProxy, int startIndex, Rectangle displayRectangle, out int breakIndex) { @@ -169,8 +169,8 @@ private Size MeasureRow(ContainerProxy containerProxy, ElementProxy elementProxy } // - /// LayoutRow and MeasureRow both forward to this method. The measureOnly flag - /// determines which behavior we get. + /// LayoutRow and MeasureRow both forward to this method. The measureOnly flag + /// determines which behavior we get. /// private Size TryCalculatePreferredSizeRow(ContainerProxy containerProxy, ElementProxy elementProxy, int startIndex, int endIndex, Rectangle rowBounds, out int breakIndex, bool measureOnly) { @@ -321,21 +321,21 @@ public static void SetFlowDirection(IArrangedElement container, FlowDirection va } /// - /// The goal of the FlowLayout Engine is to always layout from left to right. In order to achieve different - /// flow directions we have "Proxies" for the Container (the thing laying out) and for setting the bounds of the - /// child elements. + /// The goal of the FlowLayout Engine is to always layout from left to right. In order to achieve different + /// flow directions we have "Proxies" for the Container (the thing laying out) and for setting the bounds of the + /// child elements. /// - /// We have a base ContainerProxy, and derived proxies for all of the flow directions. In order to achieve flow direction of RightToLeft, - /// the RightToLeft container proxy detects when we're going to set the bounds and translates it to the right. + /// We have a base ContainerProxy, and derived proxies for all of the flow directions. In order to achieve flow direction of RightToLeft, + /// the RightToLeft container proxy detects when we're going to set the bounds and translates it to the right. /// - /// In order to do a vertical flow, such as TopDown, we pretend we're laying out horizontally. The main way this is - /// achieved is through the use of the VerticalElementProxy, which flips all rectangles and sizes. + /// In order to do a vertical flow, such as TopDown, we pretend we're laying out horizontally. The main way this is + /// achieved is through the use of the VerticalElementProxy, which flips all rectangles and sizes. /// - /// In order to do BottomUp, we combine the same techniques of TopDown with the RightToLeft flow. That is, - /// we override the bounds, and translate from left to right, AND use the VerticalElementProxy. + /// In order to do BottomUp, we combine the same techniques of TopDown with the RightToLeft flow. That is, + /// we override the bounds, and translate from left to right, AND use the VerticalElementProxy. /// - /// A final note: This layout engine does all its RightToLeft translation itself. It does not support - /// WS_EX_LAYOUTRTL (OS mirroring). + /// A final note: This layout engine does all its RightToLeft translation itself. It does not support + /// WS_EX_LAYOUTRTL (OS mirroring). /// private class ContainerProxy { @@ -398,8 +398,8 @@ public virtual Rectangle Bounds public IArrangedElement Container => _container; /// - /// Specifies if we're TopDown or BottomUp and should use the VerticalElementProxy to - /// translate + /// Specifies if we're TopDown or BottomUp and should use the VerticalElementProxy to + /// translate /// protected virtual bool IsVertical => false; @@ -407,7 +407,7 @@ public virtual Rectangle Bounds /// // Returns the display rectangle of the container - this will be flipped if the - /// layout is a vertical layout. + /// layout is a vertical layout. /// public Rectangle DisplayRect { @@ -425,9 +425,9 @@ public Rectangle DisplayRect } /// - /// Returns the element proxy to use. A vertical element proxy will typically flip - /// all the sizes and rectangles so that it can fake being laid out in a - /// horizontal manner. + /// Returns the element proxy to use. A vertical element proxy will typically flip + /// all the sizes and rectangles so that it can fake being laid out in a + /// horizontal manner. /// public ElementProxy ElementProxy { @@ -443,8 +443,8 @@ public ElementProxy ElementProxy } /// - /// Used when you want to translate from right to left, but preserve Margin.Righ - /// and Margin.Left. + /// Used when you want to translate from right to left, but preserve Margin.Righ + /// and Margin.Left. /// protected Rectangle RTLTranslateNoMarginSwap(Rectangle bounds) { @@ -502,11 +502,11 @@ public override Rectangle Bounds } /// - /// For TopDown we're really still laying out horizontally. The element proxy is the one - /// which flips all the rectangles and rotates itself into the vertical orientation. - /// to achieve right to left, we actually have to do something non-intuitive - instead of - /// sending the control to the right, we have to send the control to the bottom. When the rotation - /// is complete - that's equivilant to pushing it to the right. + /// For TopDown we're really still laying out horizontally. The element proxy is the one + /// which flips all the rectangles and rotates itself into the vertical orientation. + /// to achieve right to left, we actually have to do something non-intuitive - instead of + /// sending the control to the right, we have to send the control to the bottom. When the rotation + /// is complete - that's equivilant to pushing it to the right. /// private class TopDownProxy : ContainerProxy { @@ -526,15 +526,15 @@ public BottomUpProxy(IArrangedElement container) : base(container) protected override bool IsVertical => true; /// - /// For BottomUp we're really still laying out horizontally. The element proxy is the one - /// which flips all the rectangles and rotates itself into the vertical orientation. - /// BottomUp is the analog of RightToLeft - meaning, in order to place a control at the bottom, - /// the control has to be placed to the right. When the rotation is complete, that's the equivilant of - /// pushing it to the right. This must be done all the time. + /// For BottomUp we're really still laying out horizontally. The element proxy is the one + /// which flips all the rectangles and rotates itself into the vertical orientation. + /// BottomUp is the analog of RightToLeft - meaning, in order to place a control at the bottom, + /// the control has to be placed to the right. When the rotation is complete, that's the equivilant of + /// pushing it to the right. This must be done all the time. /// - /// To achieve right to left, we actually have to do something non-intuitive - instead of - /// sending the control to the right, we have to send the control to the bottom. When the rotation - /// is complete - that's equivilant to pushing it to the right. + /// To achieve right to left, we actually have to do something non-intuitive - instead of + /// sending the control to the right, we have to send the control to the bottom. When the rotation + /// is complete - that's equivilant to pushing it to the right. /// public override Rectangle Bounds { @@ -548,9 +548,9 @@ public override Rectangle Bounds } /// - /// ElementProxy inserts a level of indirection between the LayoutEngine - /// and the IArrangedElement that allows us to use the same code path - /// for Vertical and Horizontal flow layout. (see VerticalElementProxy) + /// ElementProxy inserts a level of indirection between the LayoutEngine + /// and the IArrangedElement that allows us to use the same code path + /// for Vertical and Horizontal flow layout. (see VerticalElementProxy) /// private class ElementProxy { @@ -625,9 +625,9 @@ public virtual Size GetPreferredSize(Size proposedSize) } /// - /// VerticalElementProxy swaps Top/Left, Bottom/Right, and other properties - /// so that the same code path used for horizantal flow can be applied to - /// vertical flow. + /// VerticalElementProxy swaps Top/Left, Bottom/Right, and other properties + /// so that the same code path used for horizantal flow can be applied to + /// vertical flow. /// private class VerticalElementProxy : ElementProxy { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/IArrangedElement.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/IArrangedElement.cs index 8daed49e5b5..dc20a053dfe 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/IArrangedElement.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/IArrangedElement.cs @@ -10,58 +10,58 @@ namespace System.Windows.Forms.Layout internal interface IArrangedElement : IComponent { /// - /// Bounding rectangle of the element. + /// Bounding rectangle of the element. /// Rectangle Bounds { get; } /// - /// Sets the bounds for an element. Implementors should call - /// CommonProperties.SetSpecifiedBounds. - /// See Control.SetBoundsCore. + /// Sets the bounds for an element. Implementors should call + /// CommonProperties.SetSpecifiedBounds. + /// See Control.SetBoundsCore. /// void SetBounds(Rectangle bounds, BoundsSpecified specified); /// - /// Query element for its preferred size. There is no guarantee - /// that layout engine will assign the element the returned size. - /// ProposedSize is a hint about constraints. + /// Query element for its preferred size. There is no guarantee + /// that layout engine will assign the element the returned size. + /// ProposedSize is a hint about constraints. /// Size GetPreferredSize(Size proposedSize); /// - /// DisplayRectangle is the client area of a container element. - /// Could possibly disappear if we change control to keep an - /// up-to-date copy of display rectangle in the property store. + /// DisplayRectangle is the client area of a container element. + /// Could possibly disappear if we change control to keep an + /// up-to-date copy of display rectangle in the property store. /// Rectangle DisplayRectangle { get; } /// - /// True if the element is currently visible (some layouts, like - /// flow, need to skip non-visible elements.) + /// True if the element is currently visible (some layouts, like + /// flow, need to skip non-visible elements.) /// bool ParticipatesInLayout { get; } /// - /// Internally, layout engines will get properties from the - /// property store on this interface. In Orcas, this will be - /// replaced with a global PropertyManager for DPs. + /// Internally, layout engines will get properties from the + /// property store on this interface. In Orcas, this will be + /// replaced with a global PropertyManager for DPs. /// PropertyStore Properties { get; } /// - /// When an extender provided property is changed, we call this - /// method to update the layout on the element. In Orcas, we - /// will sync the DPs changed event. + /// When an extender provided property is changed, we call this + /// method to update the layout on the element. In Orcas, we + /// will sync the DPs changed event. /// void PerformLayout(IArrangedElement affectedElement, string propertyName); /// - /// Returns the element's parent container (on a control, this forwands to Parent) + /// Returns the element's parent container (on a control, this forwands to Parent) /// IArrangedElement Container { get; } /// - /// Returns the element's childern (on a control, this forwands to Controls) + /// Returns the element's childern (on a control, this forwands to Controls) /// ArrangedElementCollection Children { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/LayoutUtils.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/LayoutUtils.cs index 1ea987036a1..213d6fecda3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/LayoutUtils.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/LayoutUtils.cs @@ -595,8 +595,8 @@ public static Rectangle RTLTranslate(Rectangle bounds, Rectangle withinBounds) return bounds; } - /// MeasureTextCache - /// 3000 character strings take 9 seconds to load the form + /// MeasureTextCache + /// 3000 character strings take 9 seconds to load the form public sealed class MeasureTextCache { private Size unconstrainedPreferredSize = LayoutUtils.InvalidSize; @@ -605,19 +605,19 @@ public sealed class MeasureTextCache private PreferredSizeCache[] sizeCacheList; // MRU of size MaxCacheSize - /// InvalidateCache - /// Clears out the cached values, should be called whenever Text, Font or a TextFormatFlag has changed + /// InvalidateCache + /// Clears out the cached values, should be called whenever Text, Font or a TextFormatFlag has changed public void InvalidateCache() { unconstrainedPreferredSize = LayoutUtils.InvalidSize; sizeCacheList = null; } - /// GetTextSize - /// Given constraints, format flags a font and text, determine the size of the string - /// employs an MRU of the last several constraints passed in via a ring-buffer of size MaxCacheSize. - /// Assumes Text and TextFormatFlags are the same, if either were to change, a call to - /// InvalidateCache should be made + /// GetTextSize + /// Given constraints, format flags a font and text, determine the size of the string + /// employs an MRU of the last several constraints passed in via a ring-buffer of size MaxCacheSize. + /// Assumes Text and TextFormatFlags are the same, if either were to change, a call to + /// InvalidateCache should be made public Size GetTextSize(string text, Font font, Size proposedConstraints, TextFormatFlags flags) { @@ -682,8 +682,8 @@ public Size GetTextSize(string text, Font font, Size proposedConstraints, TextFo } - /// GetUnconstrainedSize - /// Gets the unconstrained (Int32.MaxValue, Int32.MaxValue) size for a piece of text + /// GetUnconstrainedSize + /// Gets the unconstrained (Int32.MaxValue, Int32.MaxValue) size for a piece of text private Size GetUnconstrainedSize(string text, Font font, TextFormatFlags flags) { @@ -698,11 +698,11 @@ private Size GetUnconstrainedSize(string text, Font font, TextFormatFlags flags) return unconstrainedPreferredSize; } - /// TextRequiresWordBreak - /// If you give the text all the space in the world it wants, then there should be no reason - /// for it to break on a word. So we find out what the unconstrained size is (Int32.MaxValue, Int32.MaxValue) - /// for a string - eg. 35, 13. If the size passed in has a larger width than 35, then we know that - /// the WordBreak flag is not necessary. + /// TextRequiresWordBreak + /// If you give the text all the space in the world it wants, then there should be no reason + /// for it to break on a word. So we find out what the unconstrained size is (Int32.MaxValue, Int32.MaxValue) + /// for a string - eg. 35, 13. If the size passed in has a larger width than 35, then we know that + /// the WordBreak flag is not necessary. public bool TextRequiresWordBreak(string text, Font font, Size size, TextFormatFlags flags) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/TableLayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/TableLayout.cs index 66a20943819..3d073c89ca0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Layout/TableLayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Layout/TableLayout.cs @@ -200,11 +200,11 @@ internal override void ProcessSuspendedLayoutEventArgs(IArrangedElement containe } /// - /// LayoutCore: EntryPoint from LayoutEngine. - /// Container: IArrangedElement to layout (could be table layout panel but doesnt have to be - eg. ToolStrip) - /// LayoutEventArgs: args created from PerformLayout. + /// LayoutCore: EntryPoint from LayoutEngine. + /// Container: IArrangedElement to layout (could be table layout panel but doesnt have to be - eg. ToolStrip) + /// LayoutEventArgs: args created from PerformLayout. /// - /// Summary of algorithm: + /// Summary of algorithm: /// (1). Determine the row and column assignments of all the children of the container. (This can be cached) /// (2). Apply column styles, then row styles for all the rows: /// (a). Create a list of column or row sizes (Strip[]) - initialize absolute columns/rows sizes. @@ -248,12 +248,12 @@ private protected override bool LayoutCore(IArrangedElement container, LayoutEve } /// - /// GetPreferredSize: Called on the container to determine the size that best fits its contents. - /// Container: IArrangedElement to determine preferredSize (could be table layout panel but doesnt have to be - eg. ToolStrip) - /// ProposedContstraints: the suggested size that the table layout should fit into. If either argument is 0, + /// GetPreferredSize: Called on the container to determine the size that best fits its contents. + /// Container: IArrangedElement to determine preferredSize (could be table layout panel but doesnt have to be - eg. ToolStrip) + /// ProposedContstraints: the suggested size that the table layout should fit into. If either argument is 0, /// TableLayout pretends it's unconstrained for perfomance reasons. /// - /// Summary of Algorithm: + /// Summary of Algorithm: /// Similar to LayoutCore. Row/Column assignments are NOT cached. TableLayout uses AGRESSIVE /// caching for performance reasons. /// @@ -325,7 +325,7 @@ internal override Size GetPreferredSize(IArrangedElement container, Size propose } /// - /// EnsureRowAndColumnAssignments: Sets up Row/Column assignments for all the children of the container + /// EnsureRowAndColumnAssignments: Sets up Row/Column assignments for all the children of the container /// - Does nothing if Cache is valid /// - sets RowStart,RowSpan,ColumnStart,ColumnSpan into the LayoutInfo[] collection (containerInfo.ChildrenInfo) /// @@ -342,7 +342,7 @@ private void EnsureRowAndColumnAssignments(IArrangedElement container, Container } /// - /// ExpandLastElement: expands the row/column to fill the rest of the space in the container. + /// ExpandLastElement: expands the row/column to fill the rest of the space in the container. /// private void ExpandLastElement(ContainerInfo containerInfo, Size usedSpace, Size totalSpace) { @@ -359,7 +359,7 @@ private void ExpandLastElement(ContainerInfo containerInfo, Size usedSpace, Size } /// - /// AssignRowsAndColumns: part of EnsureRowAndColumnAssignments. + /// AssignRowsAndColumns: part of EnsureRowAndColumnAssignments. /// determines the number of rows and columns we need to create /// private void AssignRowsAndColumns(ContainerInfo containerInfo) @@ -432,7 +432,7 @@ private void AssignRowsAndColumns(ContainerInfo containerInfo) } /// - /// xAssignRowsAndColumns: part of AssignRowsAndColumns. + /// xAssignRowsAndColumns: part of AssignRowsAndColumns. /// def: fixed element: has a specific row/column assignment (assigned by SetRow,SetColumn, or Add(c,row,column) /// def: flow element: does NOT have a specific row/column assignment. /// @@ -605,7 +605,7 @@ private bool xAssignRowsAndColumns(ContainerInfo containerInfo, LayoutInfo[] chi } /// - /// GetNextLayoutInfo: part of xAssignRowsAndColumns. + /// GetNextLayoutInfo: part of xAssignRowsAndColumns. /// helper function that walks through the collection picking out the next flow element or fixed element. /// private static LayoutInfo GetNextLayoutInfo(LayoutInfo[] layoutInfo, ref int index, bool absolutelyPositioned) @@ -623,7 +623,7 @@ private static LayoutInfo GetNextLayoutInfo(LayoutInfo[] layoutInfo, ref int ind } /// - /// IsCursorPastInsertionPoint: part of xAssignRowsAndColumns. + /// IsCursorPastInsertionPoint: part of xAssignRowsAndColumns. /// check to see if the user specified location for fixedLayoutInfo has passed the insertion point specified by the cursor /// private bool IsCursorPastInsertionPoint(LayoutInfo fixedLayoutInfo, int insertionRow, int insertionCol) @@ -644,7 +644,7 @@ private bool IsCursorPastInsertionPoint(LayoutInfo fixedLayoutInfo, int insertio } /// - /// IsOverlappingWithReservationGrid: part of xAssignRowsAndColumns. + /// IsOverlappingWithReservationGrid: part of xAssignRowsAndColumns. /// check to see if the absolutely positioned layoutInfo fits in the reservation grid /// private bool IsOverlappingWithReservationGrid(LayoutInfo fixedLayoutInfo, ReservationGrid reservationGrid, int currentRow) @@ -668,7 +668,7 @@ private bool IsOverlappingWithReservationGrid(LayoutInfo fixedLayoutInfo, Reserv } /// - /// AdvanceUntilFits: part of xAssignRowsAndColumns. + /// AdvanceUntilFits: part of xAssignRowsAndColumns. /// Advances the position of layoutInfo until we have enough space and do not /// collide with a rowSpanned element. ColStop will be the column on which the /// element ends (exclusive). @@ -683,7 +683,7 @@ private void AdvanceUntilFits(int maxColumns, ReservationGrid reservationGrid, L } /// - /// GetColStartAndStop: part of xAssignRowsAndColumns. + /// GetColStartAndStop: part of xAssignRowsAndColumns. /// private void GetColStartAndStop(int maxColumns, ReservationGrid reservationGrid, LayoutInfo layoutInfo, out int colStop) { @@ -993,7 +993,7 @@ internal int SumStrips(Strip[] strips, int start, int span) } /// - /// Sets the minimum size for each element + /// Sets the minimum size for each element /// private void DistributeSize(IList styles, Strip[] strips, int start, int stop, int min, int max, int cellBorderWidth) { @@ -1109,8 +1109,8 @@ private bool IsAbsolutelySized(int index, IList styles) } /// - /// Now that we've allocated minimum and maximum sizes to everyone (the strips), distribute the extra space - /// as according to the Row/Column styles. + /// Now that we've allocated minimum and maximum sizes to everyone (the strips), distribute the extra space + /// as according to the Row/Column styles. /// private int DistributeStyles(int cellBorderWidth, IList styles, Strip[] strips, int maxSize, bool dontHonorConstraint) { @@ -1474,9 +1474,9 @@ internal static void SetLayoutInfo(IArrangedElement element, LayoutInfo value) } /// - /// This class contains layout related information pertaining to a child control of the - /// container being laid out. It contains Row,column assignments as well as RowSpan/ColumnSpan. - /// This class is used from ContainerInfo as a way of caching information about child controls. + /// This class contains layout related information pertaining to a child control of the + /// container being laid out. It contains Row,column assignments as well as RowSpan/ColumnSpan. + /// This class is used from ContainerInfo as a way of caching information about child controls. /// internal sealed class LayoutInfo { @@ -1490,16 +1490,16 @@ public LayoutInfo(IArrangedElement element) public IArrangedElement Element { get; } /// - /// Corresponds to TableLayoutSettings.SetRow. Can be -1 indicating that it is a - /// "flow" element and will fit in as necessary. This occurs when a control is - /// just added without specific position. + /// Corresponds to TableLayoutSettings.SetRow. Can be -1 indicating that it is a + /// "flow" element and will fit in as necessary. This occurs when a control is + /// just added without specific position. /// public int RowPosition { get; set; } = -1; /// - /// Corresponds to TableLayoutSettings.SetColumn. Can be -1 indicating that it is a - /// "flow" element and will fit in as necessary. This occurs when a control is - /// just added without specific position. + /// Corresponds to TableLayoutSettings.SetColumn. Can be -1 indicating that it is a + /// "flow" element and will fit in as necessary. This occurs when a control is + /// just added without specific position. /// public int ColumnPosition { get; set; } = -1; @@ -1577,11 +1577,11 @@ internal static ContainerInfo GetContainerInfo(IArrangedElement container) } /// - /// this class contains layout related information pertaining to the container - /// being laid out by this instance of the TableLayout. It contains references - /// to all the information that should be used from the table layout engine, - /// as this class is responsible for caching information about the control and - /// it's children being layed out. + /// this class contains layout related information pertaining to the container + /// being laid out by this instance of the TableLayout. It contains references + /// to all the information that should be used from the table layout engine, + /// as this class is responsible for caching information about the control and + /// it's children being layed out. /// internal sealed class ContainerInfo { @@ -1627,7 +1627,7 @@ public ContainerInfo(ContainerInfo containerInfo) } /// - /// the container being laid out + /// the container being laid out /// public IArrangedElement Container { @@ -1648,7 +1648,7 @@ public int CellBorderWidth } /// - /// list of ints that represent the sizes of individual columns + /// list of ints that represent the sizes of individual columns /// public Strip[] Columns { @@ -1661,7 +1661,7 @@ public Strip[] Columns } /// - /// list of ints that represent the sizes of individual rows + /// list of ints that represent the sizes of individual rows /// public Strip[] Rows { @@ -1677,7 +1677,7 @@ public Strip[] Rows } /// - /// Same as TableLayoutSettings.RowCount + /// Same as TableLayoutSettings.RowCount /// public int MaxRows { @@ -1697,7 +1697,7 @@ public int MaxRows } /// - /// Same as TableLayoutSettings.ColumnCount + /// Same as TableLayoutSettings.ColumnCount /// public int MaxColumns { @@ -1716,7 +1716,7 @@ public int MaxColumns } } - /// Cached information + /// Cached information public int MinRowsAndColumns { get @@ -1726,7 +1726,7 @@ public int MinRowsAndColumns } } - /// Cached information + /// Cached information public int MinColumns { get @@ -1737,7 +1737,7 @@ public int MinColumns } } - /// Cached information + /// Cached information public int MinRows { get @@ -1812,7 +1812,7 @@ public TableLayoutColumnStyleCollection ColumnStyles } /// - /// gets cached information about the children of the control being layed out. + /// gets cached information about the children of the control being layed out. /// public LayoutInfo[] ChildrenInfo { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LeftRightAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LeftRightAlignment.cs index 277f644fa3b..cafdbb01cf6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LeftRightAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LeftRightAlignment.cs @@ -7,20 +7,20 @@ namespace System.Windows.Forms { /// - /// Specifies whether an object or text is aligned to - /// the left or - /// right of a reference point. + /// Specifies whether an object or text is aligned to + /// the left or + /// right of a reference point. /// [ComVisible(true)] public enum LeftRightAlignment { /// - /// The object or text is aligned to the left of the reference point. + /// The object or text is aligned to the left of the reference point. /// Left = 0, /// - /// The object or text is aligned to the right of the reference point. + /// The object or text is aligned to the right of the reference point. /// Right = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkArea.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkArea.cs index 927af14ccaf..835d1ea73dd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkArea.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkArea.cs @@ -64,14 +64,14 @@ public override bool Equals(object o) public override int GetHashCode() => HashCode.Combine(start, length); /// - /// LinkAreaConverter is a class that can be used to convert LinkArea from one data type - /// to another. Access this class through the TypeDescriptor. + /// LinkAreaConverter is a class that can be used to convert LinkArea from one data type + /// to another. Access this class through the TypeDescriptor. /// public class LinkAreaConverter : TypeConverter { /// - /// Determines if this converter can convert an object in the given source - /// type to the native type of the converter. + /// Determines if this converter can convert an object in the given source + /// type to the native type of the converter. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -84,8 +84,8 @@ public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceT } /// - /// Gets a value indicating whether this converter can convert an object to the - /// given destination type using the context. + /// Gets a value indicating whether this converter can convert an object to the + /// given destination type using the context. /// public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) { @@ -98,7 +98,7 @@ public override bool CanConvertTo(ITypeDescriptorContext context, Type destinati } /// - /// Converts the given object to the converter's native type. + /// Converts the given object to the converter's native type. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { @@ -139,11 +139,11 @@ public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo c } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { @@ -178,9 +178,9 @@ public override object ConvertTo(ITypeDescriptorContext context, CultureInfo cul } /// - /// Creates an instance of this type given a set of property values - /// for the object. This is useful for objects that are immutable, but still - /// want to provide changable properties. + /// Creates an instance of this type given a set of property values + /// for the object. This is useful for objects that are immutable, but still + /// want to provide changable properties. /// public override object CreateInstance(ITypeDescriptorContext context, IDictionary propertyValues) { @@ -205,15 +205,15 @@ public override object CreateInstance(ITypeDescriptorContext context, IDictionar } /// - /// Determines if changing a value on this object should require a call to - /// CreateInstance to create a new value. + /// Determines if changing a value on this object should require a call to + /// CreateInstance to create a new value. /// public override bool GetCreateInstanceSupported(ITypeDescriptorContext context) => true; /// - /// Retrieves the set of properties for this type. By default, a type has - /// does not return any properties. An easy implementation of this method - /// can just call TypeDescriptor.GetProperties for the correct data type. + /// Retrieves the set of properties for this type. By default, a type has + /// does not return any properties. An easy implementation of this method + /// can just call TypeDescriptor.GetProperties for the correct data type. /// public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes) { @@ -222,7 +222,7 @@ public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContex } /// - /// Determines if this object supports properties. By default, this is false. + /// Determines if this object supports properties. By default, this is false. /// public override bool GetPropertiesSupported(ITypeDescriptorContext context) => true; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventArgs.cs index 3c1b82842a3..262e73bb3ea 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class LinkClickedEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public LinkClickedEventArgs(string linkText) { @@ -21,7 +21,7 @@ public LinkClickedEventArgs(string linkText) } /// - /// Gets the text of the link being clicked. + /// Gets the text of the link being clicked. /// public string LinkText { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventHandler.cs index 29650519a95..08f51572169 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkClickedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void LinkClickedEventHandler(object sender, LinkClickedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkConverter.cs index edb0ebe7ef0..60176cfcac9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkConverter.cs @@ -9,13 +9,13 @@ namespace System.Windows.Forms { /// - /// A TypeConverter for LinkLabel.Link objects. Access this class through the TypeDescriptor. + /// A TypeConverter for LinkLabel.Link objects. Access this class through the TypeDescriptor. /// public class LinkConverter : TypeConverter { /// - /// Determines if this converter can convert an object in the given source - /// type to the native type of the converter. + /// Determines if this converter can convert an object in the given source + /// type to the native type of the converter. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -28,8 +28,8 @@ public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceT } /// - /// Gets a value indicating whether this converter can convert an object to the given - /// destination type using the context. + /// Gets a value indicating whether this converter can convert an object to the given + /// destination type using the context. /// public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) { @@ -42,7 +42,7 @@ public override bool CanConvertTo(ITypeDescriptorContext context, Type destinati } /// - /// Converts the given object to the converter's native type. + /// Converts the given object to the converter's native type. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { @@ -83,11 +83,11 @@ public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo c } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabel.cs index c0aa301ddb5..750023a06b8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabel.cs @@ -926,9 +926,9 @@ private bool LinkInText(int start, int length) } /// - /// Gets or sets a value that is returned to the - /// parent form when the link label. - /// is clicked. + /// Gets or sets a value that is returned to the + /// parent form when the link label. + /// is clicked. /// DialogResult IButtonControl.DialogResult { @@ -954,7 +954,7 @@ void IButtonControl.NotifyDefault(bool value) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnGotFocus(EventArgs e) { @@ -2106,10 +2106,10 @@ public class LinkCollection : IList private readonly LinkLabel owner; private bool linksAdded = false; //whether we should serialize the linkCollection - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. - /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. + /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. private int lastAccessedIndex = -1; public LinkCollection(LinkLabel owner) @@ -2554,7 +2554,7 @@ internal Link(LinkLabel owner) } /// - /// Description for accessibility + /// Description for accessibility /// public string Description { get; set; } @@ -2619,14 +2619,14 @@ public int Length public object LinkData { get; set; } /// - /// The LinkLabel object that owns this link. + /// The LinkLabel object that owns this link. /// internal LinkLabel Owner { get; set; } internal LinkState State { get; set; } = LinkState.Normal; /// - /// The name for the link - useful for indexing by key. + /// The name for the link - useful for indexing by key. /// [DefaultValue("")] [SRCategory(nameof(SR.CatAppearance))] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventArgs.cs index 6a25cf61637..627ac15c1bb 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class LinkLabelLinkClickedEventArgs : EventArgs { /// - /// Initializes a new instance of the class, given the link. + /// Initializes a new instance of the class, given the link. /// public LinkLabelLinkClickedEventArgs(LinkLabel.Link link) : this(link, MouseButtons.Left) { @@ -26,12 +26,12 @@ public LinkLabelLinkClickedEventArgs(LinkLabel.Link link, MouseButtons button) } /// - /// Gets the that was clicked. + /// Gets the that was clicked. /// public LinkLabel.Link Link { get; } /// - /// Gets the mouseButton which causes the link to be clicked + /// Gets the mouseButton which causes the link to be clicked /// public MouseButtons Button { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventHandler.cs index 73dde8cd2ef..5aba0adec7a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkLabelLinkClickedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the event of a . + /// Represents the method that will handle the event of a . /// public delegate void LinkLabelLinkClickedEventHandler(object sender, LinkLabelLinkClickedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/LinkUtilities.cs b/src/System.Windows.Forms/src/System/Windows/Forms/LinkUtilities.cs index d8128bd854a..2108fe82bb2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/LinkUtilities.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/LinkUtilities.cs @@ -108,7 +108,7 @@ public static Color IEVisitedLinkColor } } - /// Produces a color for visited links using SystemColors + /// Produces a color for visited links using SystemColors public static Color GetVisitedLinkColor() { int r = (SystemColors.Window.R + SystemColors.WindowText.R + 1) / 2; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListBindingHelper.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListBindingHelper.cs index 638e711fac7..9fdf174456a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListBindingHelper.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListBindingHelper.cs @@ -537,17 +537,17 @@ private static bool IsListBasedType(Type type) /// /// - /// Returns info about the 'indexer' property on the specified type. The presence of an indexer is used to - /// determine that the type represents a collection or list. The return type of that indexer is used to - /// determine the underlying item type. + /// Returns info about the 'indexer' property on the specified type. The presence of an indexer is used to + /// determine that the type represents a collection or list. The return type of that indexer is used to + /// determine the underlying item type. /// - /// PROCESS: We look for the first public instance property on the type that is an 'indexer'. This property - /// is usually - but not always - called "Item". So we look at 'indexer parameters' to identify true indexers, - /// rather than looking at the property name. And we also ignore any indexers that return an item type of just - /// Object, since we are trying to use indexers here to determine the actual underlying item type! + /// PROCESS: We look for the first public instance property on the type that is an 'indexer'. This property + /// is usually - but not always - called "Item". So we look at 'indexer parameters' to identify true indexers, + /// rather than looking at the property name. And we also ignore any indexers that return an item type of just + /// Object, since we are trying to use indexers here to determine the actual underlying item type! /// - /// NOTE: A special rule is also enforced here - we only want to consider using the typed indexer on list - /// based types, ie. types we already know are supposed to be treated as lists (rather than list items). + /// NOTE: A special rule is also enforced here - we only want to consider using the typed indexer on list + /// based types, ie. types we already know are supposed to be treated as lists (rather than list items). /// private static PropertyInfo GetTypedIndexer(Type type) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.AccessibleObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.AccessibleObject.cs index e441fc1cf3b..e8be1b6c9a4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.AccessibleObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.AccessibleObject.cs @@ -12,9 +12,9 @@ namespace System.Windows.Forms public partial class ListBox { /// - /// ListBox control accessible object with UI Automation provider functionality. - /// This inherits from the base ListBoxExAccessibleObject and ListBoxAccessibleObject - /// to have all base functionality. + /// ListBox control accessible object with UI Automation provider functionality. + /// This inherits from the base ListBoxExAccessibleObject and ListBoxAccessibleObject + /// to have all base functionality. /// [ComVisible(true)] internal class ListBoxAccessibleObject : ControlAccessibleObject @@ -24,7 +24,7 @@ internal class ListBoxAccessibleObject : ControlAccessibleObject private readonly IAccessible _systemIAccessible; /// - /// Initializes new instance of ListBoxAccessibleObject. + /// Initializes new instance of ListBoxAccessibleObject. /// /// The owning ListBox control. public ListBoxAccessibleObject(ListBox owningListBox) : base(owningListBox) @@ -79,7 +79,7 @@ public override AccessibleStates State } /// - /// Return the child object at the given screen coordinates. + /// Return the child object at the given screen coordinates. /// /// X coordinate. /// Y coordinate. @@ -97,7 +97,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProvide } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -127,7 +127,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment GetFocus() } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.ItemAccessibleObject.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.ItemAccessibleObject.cs index 1c7f4b76315..d6c1912d797 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.ItemAccessibleObject.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.ItemAccessibleObject.cs @@ -12,9 +12,9 @@ namespace System.Windows.Forms public partial class ListBox { /// - /// ListBox control accessible object with UI Automation provider functionality. - /// This inherits from the base ListBoxExAccessibleObject and ListBoxAccessibleObject - /// to have all base functionality. + /// ListBox control accessible object with UI Automation provider functionality. + /// This inherits from the base ListBoxExAccessibleObject and ListBoxAccessibleObject + /// to have all base functionality. /// [ComVisible(true)] internal class ListBoxItemAccessibleObject : AccessibleObject @@ -47,7 +47,7 @@ internal override bool IsItemSelected internal override UnsafeNativeMethods.IRawElementProviderSimple ItemSelectionContainer => _owningAccessibleObject; /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -65,7 +65,7 @@ internal override int[] RuntimeId } /// - /// Gets the ListBox Item bounds. + /// Gets the ListBox Item bounds. /// public override Rectangle Bounds { @@ -93,17 +93,17 @@ public override Rectangle Bounds } /// - /// Gets the ListBox item default action. + /// Gets the ListBox item default action. /// public override string DefaultAction => _systemIAccessible.accDefaultAction[GetChildId()]; /// - /// Gets the help text. + /// Gets the help text. /// public override string Help => _systemIAccessible.accHelp[GetChildId()]; /// - /// Gets or sets the accessible name. + /// Gets or sets the accessible name. /// public override string Name { @@ -118,12 +118,12 @@ public override string Name } /// - /// Gets the accessible role. + /// Gets the accessible role. /// public override AccessibleRole Role => (AccessibleRole)_systemIAccessible.get_accRole(GetChildId()); /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -220,7 +220,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Indicates whether specified pattern is supported. + /// Indicates whether specified pattern is supported. /// /// The pattern ID. /// True if specified diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.cs index 6e7f9a2a601..403b502c432 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListBox.cs @@ -51,8 +51,8 @@ public partial class ListBox : ListControl public const int NoMatches = NativeMethods.LB_ERR; /// - /// The default item height for an owner-draw ListBox. The ListBox's non-ownderdraw - /// item height is 13 for the default font on Windows. + /// The default item height for an owner-draw ListBox. The ListBox's non-ownderdraw + /// item height is 13 for the default font on Windows. /// public const int DefaultItemHeight = 13; @@ -114,17 +114,17 @@ public partial class ListBox : ListControl private IntegerCollection customTabOffsets; /// - /// Default start position of items in the checked list box + /// Default start position of items in the checked list box /// private const int defaultListItemStartPos = 1; /// - /// Borders are 1 pixel height. + /// Borders are 1 pixel height. /// private const int defaultListItemBorderHeight = 1; /// - /// Borders are 1 pixel width and a pixel buffer + /// Borders are 1 pixel width and a pixel buffer /// private const int defaultListItemPaddingBuffer = 3; @@ -1476,14 +1476,14 @@ public void EndUpdate() } /// - /// Finds the first item in the list box that starts with the given string. - /// The search is not case sensitive. + /// Finds the first item in the list box that starts with the given string. + /// The search is not case sensitive. /// public int FindString(string s) => FindString(s, startIndex: -1); /// - /// Finds the first item after the given index which starts with the given string. - /// The search is not case sensitive. + /// Finds the first item after the given index which starts with the given string. + /// The search is not case sensitive. /// public int FindString(string s, int startIndex) { @@ -1491,14 +1491,14 @@ public int FindString(string s, int startIndex) } /// - /// Finds the first item in the list box that matches the given string. - /// The strings must match exactly, except for differences in casing. + /// Finds the first item in the list box that matches the given string. + /// The strings must match exactly, except for differences in casing. /// public int FindStringExact(string s) => FindStringExact(s, startIndex: -1); /// - /// Finds the first item after the given index that matches the given string. - /// The strings must match excatly, except for differences in casing. + /// Finds the first item after the given index that matches the given string. + /// The strings must match excatly, except for differences in casing. /// public int FindStringExact(string s, int startIndex) { @@ -2087,7 +2087,7 @@ public override void Refresh() base.Refresh(); } /// - /// Reparses the objects, getting new text strings for them. + /// Reparses the objects, getting new text strings for them. /// protected override void RefreshItems() { @@ -2159,7 +2159,7 @@ protected override void RefreshItems() } /// - /// Reparses the object at the given index, getting new text string for it. + /// Reparses the object at the given index, getting new text string for it. /// protected override void RefreshItem(int index) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListControl.cs index 3a43c01d8b3..65e42a1192e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListControl.cs @@ -41,8 +41,8 @@ public abstract class ListControl : Control private bool _inSetDataConnection = false; /// - /// The ListSource to consume as this ListBox's source of data. - /// When set, a user can not modify the Items collection. + /// The ListSource to consume as this ListBox's source of data. + /// When set, a user can not modify the Items collection. /// [SRCategory(nameof(SR.CatData))] [DefaultValue(null)] @@ -98,8 +98,8 @@ public event EventHandler DataSourceChanged protected CurrencyManager DataManager => _dataManager; /// - /// If the ListBox contains objects that support properties, this indicates - /// which property of the object to show. If "", the object shows it's ToString(). + /// If the ListBox contains objects that support properties, this indicates + /// which property of the object to show. If "", the object shows it's ToString(). /// [SRCategory(nameof(SR.CatData))] [DefaultValue("")] @@ -132,7 +132,7 @@ public event EventHandler DisplayMemberChanged } /// - /// Cached type converter of the property associated with the display member + /// Cached type converter of the property associated with the display member /// private TypeConverter DisplayMemberConverter { @@ -336,7 +336,7 @@ public event EventHandler ValueMemberChanged } /// - /// Indicates whether list currently allows selection of list items. + /// Indicates whether list currently allows selection of list items. /// protected virtual bool AllowSelection => true; @@ -454,8 +454,8 @@ protected object FilterItemOnProperty(object item, string field) } /// - /// We use this to prevent getting the selected item when mouse is hovering - /// over the dropdown. + /// We use this to prevent getting the selected item when mouse is hovering + /// over the dropdown. /// private protected bool BindingFieldEmpty => _displayMember.BindingField.Length == 0; @@ -547,7 +547,7 @@ public string GetItemText(object item) } /// - /// Handling special input keys, such as PageUp, PageDown, Home, End, etc... + /// Handling special input keys, such as PageUp, PageDown, Home, End, etc... /// protected override bool IsInputKey(Keys keyData) { @@ -611,11 +611,11 @@ protected virtual void OnFormattingEnabledChanged(EventArgs e) } /// - /// Actually goes and fires the selectedIndexChanged event. Inheriting controls - /// should use this to know when the event is fired [this is preferable to - /// adding an event handler on yourself for this event]. They should, - /// however, remember to call base.OnSelectedIndexChanged(e); to ensure the event is - /// still fired to external listeners + /// Actually goes and fires the selectedIndexChanged event. Inheriting controls + /// should use this to know when the event is fired [this is preferable to + /// adding an event handler on yourself for this event]. They should, + /// however, remember to call base.OnSelectedIndexChanged(e); to ensure the event is + /// still fired to external listeners /// protected virtual void OnSelectedIndexChanged(EventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListControlConvertEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListControlConvertEventHandler.cs index 514f5ca4248..eeafd97b3f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListControlConvertEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListControlConvertEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the ListControlConvert event of a ListView. + /// Represents the method that will handle the ListControlConvert event of a ListView. /// public delegate void ListControlConvertEventHandler(object sender, ListControlConvertEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListItemConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListItemConverter.cs index 02e48108492..75b4145240f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListItemConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListItemConverter.cs @@ -13,15 +13,15 @@ namespace System.Windows.Forms { /// - /// ListViewItemConverter is a class that can be used to convert - /// ListViewItem objects from one data type to another. Access this - /// class through the TypeDescriptor. + /// ListViewItemConverter is a class that can be used to convert + /// ListViewItem objects from one data type to another. Access this + /// class through the TypeDescriptor. /// public class ListViewItemConverter : ExpandableObjectConverter { /// - /// Gets a value indicating whether this converter can convert an object to the given - /// destination type using the context. + /// Gets a value indicating whether this converter can convert an object to the given + /// destination type using the context. /// public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) { @@ -34,11 +34,11 @@ public override bool CanConvertTo(ITypeDescriptorContext context, Type destinati } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListManagerBindingsCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListManagerBindingsCollection.cs index 54edcf8adf4..6e55cace09f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListManagerBindingsCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListManagerBindingsCollection.cs @@ -8,8 +8,8 @@ namespace System.Windows.Forms { /// - /// BindingsCollection is a collection of bindings for a Control. It has Add/Remove capabilities, - /// as well as an All array property, enumeration, etc. + /// BindingsCollection is a collection of bindings for a Control. It has Add/Remove capabilities, + /// as well as an All array property, enumeration, etc. /// [DefaultEvent(nameof(CollectionChanged))] internal class ListManagerBindingsCollection : BindingsCollection @@ -17,7 +17,7 @@ internal class ListManagerBindingsCollection : BindingsCollection private readonly BindingManagerBase _bindingManagerBase; /// - /// ColumnsCollection constructor. Used only by DataSource. + /// ColumnsCollection constructor. Used only by DataSource. /// internal ListManagerBindingsCollection(BindingManagerBase bindingManagerBase) : base() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListView.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListView.cs index c6c41eb005d..c5a466fc285 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListView.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListView.cs @@ -1300,8 +1300,8 @@ public ImageList LargeImageList } /// - /// Returns the current LISTVIEWSTATE_handleDestroyed value so that this - /// value can be accessed from child classes. + /// Returns the current LISTVIEWSTATE_handleDestroyed value so that this + /// value can be accessed from child classes. /// internal bool ListViewHandleDestroyed { @@ -4378,9 +4378,9 @@ protected override void OnMouseLeave(EventArgs e) /// protected override void OnMouseHover(EventArgs e) { - /// Hover events need to be caught for each node - /// within the TreeView so the appropriate - /// NodeHovered event can be raised. + /// Hover events need to be caught for each node + /// within the TreeView so the appropriate + /// NodeHovered event can be raised. ListViewItem item = null; @@ -5420,7 +5420,7 @@ internal void SetItemText(int itemIndex, int subItemIndex, string text) } /// - /// For perf, allow a LVITEM to be passed in so we can reuse in tight loops. + /// For perf, allow a LVITEM to be passed in so we can reuse in tight loops. /// private void SetItemText(int itemIndex, int subItemIndex, string text, ref NativeMethods.LVITEM lvItem) { @@ -7048,9 +7048,9 @@ public class CheckedListViewItemCollection : IList { private readonly ListView owner; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; /* C#r: protected */ @@ -7703,9 +7703,9 @@ public class SelectedListViewItemCollection : IList { private readonly ListView owner; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; /* C#r: protected */ @@ -8233,10 +8233,10 @@ public virtual void RemoveByKey(string key) } } - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. - /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. + /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. private int lastAccessedIndex = -1; /// @@ -8715,9 +8715,9 @@ public IEnumerator GetEnumerator() [ListBindable(false)] public class ListViewItemCollection : IList { - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; internal interface IInnerList @@ -9730,11 +9730,11 @@ public IEnumerator GetEnumerator() } /// - /// Creates the new instance of AccessibleObject for this ListView control. - /// Returning ListViewAccessibleObject. + /// Creates the new instance of AccessibleObject for this ListView control. + /// Returning ListViewAccessibleObject. /// /// - /// The AccessibleObject for this ListView instance. + /// The AccessibleObject for this ListView instance. /// protected override AccessibleObject CreateAccessibilityInstance() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewAlignment.cs index 2d1288743ee..33cb897705b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewAlignment.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - /// Specifies how items align in the . + /// Specifies how items align in the . /// public enum ListViewAlignment { /// - /// When the user moves an item, it remains where it is dropped. + /// When the user moves an item, it remains where it is dropped. /// Default = NativeMethods.LVA_DEFAULT, /// - /// Items are aligned to the top of the control. + /// Items are aligned to the top of the control. /// Top = NativeMethods.LVA_ALIGNTOP, /// - /// Items are aligned to the left of the control. + /// Items are aligned to the left of the control. /// Left = NativeMethods.LVA_ALIGNLEFT, /// - /// Items are aligned to an invisible grid in the control. When the user - /// moves an item, it moves to the closest juncture in the grid. + /// Items are aligned to an invisible grid in the control. When the user + /// moves an item, it moves to the closest juncture in the grid. /// SnapToGrid = NativeMethods.LVA_SNAPTOGRID, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroup.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroup.cs index a668c00e37b..1a714088bd8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroup.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroup.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Represents a group within a ListView. + /// Represents a group within a ListView. /// [TypeConverter(typeof(ListViewGroupConverter))] [ToolboxItem(false)] @@ -28,14 +28,14 @@ public sealed class ListViewGroup : ISerializable private static int s_nextHeader = 1; /// - /// Creates a ListViewGroup. + /// Creates a ListViewGroup. /// public ListViewGroup() : this(string.Format(SR.ListViewGroupDefaultHeader, s_nextHeader++)) { } /// - /// Creates a ListViewItem object from an Stream. + /// Creates a ListViewItem object from an Stream. /// private ListViewGroup(SerializationInfo info, StreamingContext context) : this() { @@ -43,7 +43,7 @@ private ListViewGroup(SerializationInfo info, StreamingContext context) : this() } /// - /// Creates a ListViewItem object from a Key and a Name + /// Creates a ListViewItem object from a Key and a Name /// public ListViewGroup(string key, string headerText) : this() { @@ -52,7 +52,7 @@ public ListViewGroup(string key, string headerText) : this() } /// - /// Creates a ListViewGroup. + /// Creates a ListViewGroup. /// public ListViewGroup(string header) { @@ -61,7 +61,7 @@ public ListViewGroup(string header) } /// - /// Creates a ListViewGroup. + /// Creates a ListViewGroup. /// public ListViewGroup(string header, HorizontalAlignment headerAlignment) : this(header) { @@ -69,7 +69,7 @@ public ListViewGroup(string header, HorizontalAlignment headerAlignment) : this( } /// - /// The text displayed in the group header. + /// The text displayed in the group header. /// [SRCategory(nameof(SR.CatAppearance))] public string Header @@ -86,7 +86,7 @@ public string Header } /// - /// The alignment of the group header. + /// The alignment of the group header. /// [DefaultValue(HorizontalAlignment.Left)] [SRCategory(nameof(SR.CatAppearance))] @@ -111,7 +111,7 @@ public HorizontalAlignment HeaderAlignment internal int ID { get; } /// - /// The items that belong to this group. + /// The items that belong to this group. /// [Browsable(false)] public ListView.ListViewItemCollection Items diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupCollection.cs index e857acef459..aced962a25b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupCollection.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// A collection of listview groups. + /// A collection of listview groups. /// [ListBindable(false)] public class ListViewGroupCollection : IList diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupConverter.cs index 1279da0f933..a6425bf53a2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewGroupConverter.cs @@ -12,14 +12,14 @@ namespace System.Windows.Forms { /// - /// ListViewGroupConverter is a class that can be used to convert ListViewGroup objects - /// from one data type to another. Access this class through the TypeDescriptor. + /// ListViewGroupConverter is a class that can be used to convert ListViewGroup objects + /// from one data type to another. Access this class through the TypeDescriptor. /// internal class ListViewGroupConverter : TypeConverter { /// - /// Determines if this converter can convert an object in the given source type to - /// the native type of the converter. + /// Determines if this converter can convert an object in the given source type to + /// the native type of the converter. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -32,8 +32,8 @@ public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceT } /// - /// Gets a value indicating whether this converter can convert an object to the given - /// destination type using the context. + /// Gets a value indicating whether this converter can convert an object to the given + /// destination type using the context. /// public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) { @@ -50,7 +50,7 @@ public override bool CanConvertTo(ITypeDescriptorContext context, Type destinati } /// - /// Converts the given object to the converter's native type. + /// Converts the given object to the converter's native type. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { @@ -81,11 +81,11 @@ public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo c } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { @@ -114,9 +114,9 @@ public override object ConvertTo(ITypeDescriptorContext context, CultureInfo cul } /// - /// Retrieves a collection containing a set of standard values for the data type this - /// validator is designed for. This will return null if the data type does not support - /// a standard set of values. + /// Retrieves a collection containing a set of standard values for the data type this + /// validator is designed for. This will return null if the data type does not support + /// a standard set of values. /// public override StandardValuesCollection GetStandardValues(ITypeDescriptorContext context) { @@ -134,10 +134,10 @@ public override StandardValuesCollection GetStandardValues(ITypeDescriptorContex } /// - /// Determines if the list of standard values returned from GetStandardValues is an - /// exclusive list. If the list is exclusive, then no other values are valid, such as - /// in an enum data type. If the list is not exclusive, then there are other valid values - /// besides the list of standard values GetStandardValues provides. + /// Determines if the list of standard values returned from GetStandardValues is an + /// exclusive list. If the list is exclusive, then no other values are valid, such as + /// in an enum data type. If the list is not exclusive, then there are other valid values + /// besides the list of standard values GetStandardValues provides. /// public override bool GetStandardValuesExclusive(ITypeDescriptorContext context) { @@ -145,8 +145,8 @@ public override bool GetStandardValuesExclusive(ITypeDescriptorContext context) } /// - /// Determines if this object supports a standard set of values that can be picked - /// from a list. + /// Determines if this object supports a standard set of values that can be picked + /// from a list. /// public override bool GetStandardValuesSupported(ITypeDescriptorContext context) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItem.cs index ce8aba7ad66..b5e7f3e3f0e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItem.cs @@ -15,7 +15,7 @@ namespace System.Windows.Forms { /// - /// Implements an item of a . + /// Implements an item of a . /// [TypeConverter(typeof(ListViewItemConverter))] [ToolboxItem(false)] @@ -80,7 +80,7 @@ public ListViewItem() } /// - /// Creates a ListViewItem object from an Stream. + /// Creates a ListViewItem object from an Stream. /// protected ListViewItem(SerializationInfo info, StreamingContext context) : this() { @@ -243,8 +243,8 @@ public ListViewItem(ListViewSubItem[] subItems, string imageKey, ListViewGroup g } /// - /// The font that this item will be displayed in. If its value is null, it will be displayed - /// using the global font for the ListView control that hosts it. + /// The font that this item will be displayed in. If its value is null, it will be displayed + /// using the global font for the ListView control that hosts it. /// [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] [SRCategory(nameof(SR.CatAppearance))] @@ -270,8 +270,8 @@ public Color BackColor } /// - /// Returns the ListViewItem's bounding rectangle, including subitems. The bounding rectangle is empty if - /// the ListViewItem has not been added to a ListView control. + /// Returns the ListViewItem's bounding rectangle, including subitems. The bounding rectangle is empty if + /// the ListViewItem has not been added to a ListView control. /// [Browsable(false)] public Rectangle Bounds @@ -322,7 +322,7 @@ public bool Checked } /// - /// Returns the focus state of the ListViewItem. + /// Returns the focus state of the ListViewItem. /// [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] [Browsable(false)] @@ -425,7 +425,7 @@ public ListViewGroup Group } /// - /// Returns the ListViewItem's currently set image index + /// Returns the ListViewItem's currently set image index /// [DefaultValue(-1)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -465,7 +465,7 @@ public int ImageIndex internal ListViewItemImageIndexer ImageIndexer => imageIndexer ?? (imageIndexer = new ListViewItemImageIndexer(this)); /// - /// Returns the ListViewItem's currently set image index + /// Returns the ListViewItem's currently set image index /// [DefaultValue("")] [TypeConverter(typeof(ImageKeyConverter))] @@ -536,7 +536,7 @@ public int IndentCount } /// - /// Returns ListViewItem's current index in the listview, or -1 if it has not been added to a ListView control. + /// Returns ListViewItem's current index in the listview, or -1 if it has not been added to a ListView control. /// [Browsable(false)] public int Index @@ -561,14 +561,14 @@ public int Index } /// - /// Returns the ListView control that holds this ListViewItem. May be null if no - /// control has been assigned yet. + /// Returns the ListView control that holds this ListViewItem. May be null if no + /// control has been assigned yet. /// [Browsable(false)] public ListView ListView => listView; /// - /// Name associated with this ListViewItem + /// Name associated with this ListViewItem /// [Localizable(true)] [Browsable(false)] @@ -622,7 +622,7 @@ public Point Position internal int RawStateImageIndex => (SavedStateImageIndex + 1) << 12; /// - /// Accessor for our state bit vector. + /// Accessor for our state bit vector. /// private int SavedStateImageIndex { @@ -643,7 +643,7 @@ private int SavedStateImageIndex } /// - /// Treats the ListViewItem as a row of strings, and returns an array of those strings + /// Treats the ListViewItem as a row of strings, and returns an array of those strings /// [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -719,7 +719,7 @@ public int StateImageIndex internal bool StateImageSet => (state[s_stateImageMaskSet] != 0); /// - /// Accessor for our state bit vector. + /// Accessor for our state bit vector. /// internal bool StateSelected { @@ -728,7 +728,7 @@ internal bool StateSelected } /// - /// Accessor for our state bit vector. + /// Accessor for our state bit vector. /// private int SubItemCount // Do NOT rename (binary serialization). { @@ -768,7 +768,7 @@ public object Tag } /// - /// Text associated with this ListViewItem + /// Text associated with this ListViewItem /// [Localizable(true)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -790,7 +790,7 @@ public string Text } /// - /// Tool tip text associated with this ListViewItem + /// Tool tip text associated with this ListViewItem /// [SRCategory(nameof(SR.CatAppearance))] [DefaultValue("")] @@ -818,10 +818,10 @@ public string ToolTipText } /// - /// Whether or not the font and coloring for the ListViewItem will be used for all of its subitems. - /// If true, the ListViewItem style will be used when drawing the subitems. - /// If false, the ListViewItem and its subitems will be drawn in their own individual styles - /// if any have been set. + /// Whether or not the font and coloring for the ListViewItem will be used for all of its subitems. + /// If true, the ListViewItem style will be used when drawing the subitems. + /// If false, the ListViewItem and its subitems will be drawn in their own individual styles + /// if any have been set. /// [DefaultValue(true)] [SRCategory(nameof(SR.CatAppearance))] @@ -832,7 +832,7 @@ public bool UseItemStyleForSubItems } /// - /// Initiate editing of the item's label. Only effective if LabelEdit property is true. + /// Initiate editing of the item's label. Only effective if LabelEdit property is true. /// public void BeginEdit() { @@ -905,7 +905,7 @@ public virtual object Clone() } /// - /// Ensure that the item is visible, scrolling the view as necessary. + /// Ensure that the item is visible, scrolling the view as necessary. /// public virtual void EnsureVisible() { @@ -935,8 +935,8 @@ public ListViewItem FindNearestItem(SearchDirectionHint searchDirection) } /// - /// Returns a specific portion of the ListViewItem's bounding rectangle. - /// The rectangle returned is empty if the ListViewItem has not been added to a ListView control. + /// Returns a specific portion of the ListViewItem's bounding rectangle. + /// The rectangle returned is empty if the ListViewItem has not been added to a ListView control. /// public Rectangle GetBounds(ItemBoundsPortion portion) { @@ -983,7 +983,7 @@ internal void Host(ListView parent, int id, int index) } /// - /// This is used to map list view items w/ their respective groups in localized forms. + /// This is used to map list view items w/ their respective groups in localized forms. /// internal void UpdateGroupFromName() { @@ -1008,9 +1008,9 @@ internal void UpdateStateToListView(int index) } /// - /// Called when we have just pushed this item into a list view and we need - /// to configure the list view's state for the item. Use a valid index - /// if you can, or use -1 if you can't. + /// Called when we have just pushed this item into a list view and we need + /// to configure the list view's state for the item. Use a valid index + /// if you can, or use -1 if you can't. /// internal void UpdateStateToListView(int index, ref NativeMethods.LVITEM lvItem, bool updateOwner) { @@ -1205,7 +1205,7 @@ protected virtual void Deserialize(SerializationInfo info, StreamingContext cont } /// - /// Saves this ListViewItem object to the given data stream. + /// Saves this ListViewItem object to the given data stream. /// protected virtual void Serialize(SerializationInfo info, StreamingContext context) { @@ -1565,7 +1565,7 @@ public ListViewSubItemCollection(ListViewItem owner) } /// - /// Returns the total number of items within the list view. + /// Returns the total number of items within the list view. /// [Browsable(false)] public int Count => _owner.SubItemCount; @@ -1579,7 +1579,7 @@ public ListViewSubItemCollection(ListViewItem owner) public bool IsReadOnly => false; /// - /// Returns a ListViewSubItem given it's zero based index into the ListViewSubItemCollection. + /// Returns a ListViewSubItem given it's zero based index into the ListViewSubItemCollection. /// public ListViewSubItem this[int index] { @@ -1618,7 +1618,7 @@ object IList.this[int index] } } /// - /// Retrieves the child control with the specified key. + /// Retrieves the child control with the specified key. /// public virtual ListViewSubItem this[string key] { @@ -1759,17 +1759,17 @@ bool IList.Contains(object item) } /// - /// Returns true if the collection contains an item with the specified key, false otherwise. + /// Returns true if the collection contains an item with the specified key, false otherwise. /// public virtual bool ContainsKey(string key) => IsValidIndex(IndexOfKey(key)); /// - /// Ensures that the sub item array has the given - /// capacity. If it doesn't, it enlarges the - /// array until it does. If index is -1, additional - /// space is tacked onto the end. If it is a valid - /// insertion index into the array, this will move - /// the array data to accomodate the space. + /// Ensures that the sub item array has the given + /// capacity. If it doesn't, it enlarges the + /// array until it does. If index is -1, additional + /// space is tacked onto the end. If it is a valid + /// insertion index into the array, this will move + /// the array data to accomodate the space. /// private void EnsureSubItemSpace(int size, int index) { @@ -1848,7 +1848,7 @@ int IList.IndexOf(object subItem) } /// - /// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1. + /// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1. /// public virtual int IndexOfKey(string key) { @@ -1879,7 +1879,7 @@ public virtual int IndexOfKey(string key) } /// - /// Determines if the index is valid for the collection. + /// Determines if the index is valid for the collection. /// private bool IsValidIndex(int index) => ((index >= 0) && (index < Count)); @@ -1954,7 +1954,7 @@ public void RemoveAt(int index) } /// - /// Removes the child control with the specified key. + /// Removes the child control with the specified key. /// public virtual void RemoveByKey(string key) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventArgs.cs index f10b0ad5ad2..8754641722c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class ListViewItemMouseHoverEventArgs : EventArgs diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventHandler.cs index b8a85c0768e..246e226a277 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemMouseHoverEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ListViewItemMouseHoverEventHandler(object sender, ListViewItemMouseHoverEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventArgs.cs index 8783ae0c56a..600247f8e68 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventArgs.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// The event class that is created when the selection state of a ListViewItem is changed. + /// The event class that is created when the selection state of a ListViewItem is changed. /// public class ListViewItemSelectionChangedEventArgs : EventArgs { /// - /// Constructs a ListViewItemSelectionChangedEventArgs object. + /// Constructs a ListViewItemSelectionChangedEventArgs object. /// public ListViewItemSelectionChangedEventArgs(ListViewItem item, int itemIndex, bool isSelected) { @@ -20,17 +20,17 @@ public ListViewItemSelectionChangedEventArgs(ListViewItem item, int itemIndex, b } /// - /// The list view item whose selection changed + /// The list view item whose selection changed /// public ListViewItem Item { get; } /// - /// The list view item's index + /// The list view item's index /// public int ItemIndex { get; } /// - /// Return true if the item is selected + /// Return true if the item is selected /// public bool IsSelected { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventHandler.cs index 38551d327c7..3977bce3248 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemSelectionChangedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ListViewItemSelectionChangedEventHandler(object sender, ListViewItemSelectionChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemState.cs index e589ef2dc09..950b0ae82ca 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewItemState.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Gives state information about a ListView item/sub-item. Used with owner draw. + /// Gives state information about a ListView item/sub-item. Used with owner draw. /// [Flags] public enum ListViewItemStates diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventArgs.cs index 5bde2f2244a..bd9a52f1def 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventArgs.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// The event class that is created when the selection state of a ListViewItem is changed. + /// The event class that is created when the selection state of a ListViewItem is changed. /// public class ListViewVirtualItemsSelectionRangeChangedEventArgs : EventArgs { /// - /// Constructs a ListViewVirtualItemsSelectionRangeChangedEventArgs object. + /// Constructs a ListViewVirtualItemsSelectionRangeChangedEventArgs object. /// public ListViewVirtualItemsSelectionRangeChangedEventArgs(int startIndex, int endIndex, bool isSelected) { @@ -25,17 +25,17 @@ public ListViewVirtualItemsSelectionRangeChangedEventArgs(int startIndex, int en } /// - /// Returns the begining of the range where the selection changed + /// Returns the begining of the range where the selection changed /// public int StartIndex { get; } /// - /// Returns the end of the range where the selection changed + /// Returns the end of the range where the selection changed /// public int EndIndex { get; } /// - /// Return true if the items are selected + /// Return true if the items are selected /// public bool IsSelected { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventHandler.cs index 6f6f89a8c1b..5f8135fa079 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ListViewVirtualItemsSelectionRangeChangedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ListViewVirtualItemsSelectionRangeChangedEventHandler(object sender, ListViewVirtualItemsSelectionRangeChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MDIControlStrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MDIControlStrip.cs index cdfe2b67adb..afbfb69ed64 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MDIControlStrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MDIControlStrip.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// This is the toolstrip used for merging the [:)] [_][#][X] buttons onto an + /// This is the toolstrip used for merging the [:)] [_][#][X] buttons onto an /// mdi parent when an MDI child is maximized. /// internal class MdiControlStrip : MenuStrip diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MDILayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MDILayout.cs index 9bc90e26581..9a64eaf601d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MDILayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MDILayout.cs @@ -5,33 +5,33 @@ namespace System.Windows.Forms { /// - /// Specifies the layout of multiple document interface (MDI) child windows in an MDI parent window. + /// Specifies the layout of multiple document interface (MDI) child windows in an MDI parent window. /// public enum MdiLayout { /// - /// All MDI child windows are cascaded within the client region of the - /// MDI parent form. + /// All MDI child windows are cascaded within the client region of the + /// MDI parent form. /// Cascade = 0, /// - /// All MDI child windows are tiled horizontally within the client region - /// of the MDI parent form. + /// All MDI child windows are tiled horizontally within the client region + /// of the MDI parent form. /// TileHorizontal = 1, /// - /// All MDI child windows are tiled vertically within the client region of - /// the MDI parent form. + /// All MDI child windows are tiled vertically within the client region of + /// the MDI parent form. /// TileVertical = 2, /// - /// All MDI child icons are arranged within the client region of the MDI - /// parent form. An application sets this layout to arrange all minimized - /// MDI child windows (in the bottom of the client area). - /// It does not affect child windows that are not minimized. + /// All MDI child icons are arranged within the client region of the MDI + /// parent form. An application sets this layout to arrange all minimized + /// MDI child windows (in the bottom of the client area). + /// It does not affect child windows that are not minimized. /// ArrangeIcons = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MainMenu.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MainMenu.cs index b235a732889..4ab2c41d9ef 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MainMenu.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MainMenu.cs @@ -26,7 +26,7 @@ public MainMenu() } /// - /// Initializes a new instance of the class with the specified container. + /// Initializes a new instance of the class with the specified container. /// public MainMenu(IContainer container) : this() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MaskFormat.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MaskFormat.cs index ff0c62b3bf4..493f29e729c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MaskFormat.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MaskFormat.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Enum defining inclusion of special characters. + /// Enum defining inclusion of special characters. /// public enum MaskFormat { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventArgs.cs index a0004b2095a..b74e4d6df26 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the MaskInputRejected event. + /// Provides data for the MaskInputRejected event. /// public class MaskInputRejectedEventArgs : EventArgs { @@ -18,12 +18,12 @@ public MaskInputRejectedEventArgs(int position, MaskedTextResultHint rejectionHi } /// - /// The position where the test failed the mask constraint. + /// The position where the test failed the mask constraint. /// public int Position { get; } /// - /// Retreives a hint on why the input is rejected. + /// Retreives a hint on why the input is rejected. /// public MaskedTextResultHint RejectionHint { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventHandler.cs index a57f302c47b..aa4201d54e3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MaskInputRejectedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Describes a delegate for an event that has a MaskInputRejectedEventArgs as - /// a parameter. + /// Describes a delegate for an event that has a MaskInputRejectedEventArgs as + /// a parameter. /// public delegate void MaskInputRejectedEventHandler(object sender, MaskInputRejectedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MaskedTextBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MaskedTextBox.cs index 1da048147b9..2d57d13e065 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MaskedTextBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MaskedTextBox.cs @@ -56,7 +56,7 @@ public class MaskedTextBox : TextBoxBase private const byte imeConvertionUpdate = 1; // the char being composed has been updated but not coverted yet. private const byte imeConvertionCompleted = 2; // the char being composed has been fully converted. - ///////// Instance fields + ///////// Instance fields // Used for keeping selection when prompt is hidden on leave (text changes). private int lastSelLength; @@ -98,7 +98,7 @@ public class MaskedTextBox : TextBoxBase private static readonly int CUTCOPYINCLUDEPROMPT = BitVector32.CreateMask(INSERT_TOGGLED); private static readonly int CUTCOPYINCLUDELITERALS = BitVector32.CreateMask(CUTCOPYINCLUDEPROMPT); - ///////// Properties backend fields. See corresponding property comments for more info. + ///////// Properties backend fields. See corresponding property comments for more info. private char passwordChar; // control's pwd char, it could be different from the one displayed if using system password. private Type validatingType; @@ -184,9 +184,8 @@ private void Initialize(MaskedTextProvider maskedTextProvider) caretTestPos = 0; } - /////////////////// Properties + /////////////////// Properties /// - /// /// Unsupported method/property. /// @@ -1203,7 +1202,7 @@ private void SetEditControlPasswordChar(char pwdChar) } /// - /// The value of the Edit control default password char. + /// The value of the Edit control default password char. /// private char SystemPasswordChar { @@ -1585,7 +1584,7 @@ public Type ValidatingType set { } } - ////////////// Methods + ////////////// Methods /// /// Clears information about the most recent operation from the undo buffer of the control. @@ -2135,7 +2134,7 @@ protected override void OnKeyPress(KeyPressEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnKeyUp(KeyEventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MeasureItemEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MeasureItemEventArgs.cs index d963c273837..d1e26115e20 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MeasureItemEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MeasureItemEventArgs.cs @@ -7,8 +7,8 @@ namespace System.Windows.Forms { /// - /// This event is sent by controls such as the ListBox or ComboBox that need users - /// to tell them how large a given item is to be. + /// This event is sent by controls such as the ListBox or ComboBox that need users + /// to tell them how large a given item is to be. /// public class MeasureItemEventArgs : EventArgs { @@ -25,24 +25,24 @@ public MeasureItemEventArgs(Graphics graphics, int index, int itemHeight) } /// - /// A Graphics object to measure relative to. + /// A Graphics object to measure relative to. /// public Graphics Graphics { get; } /// - /// The index of item for which the height/width is needed. + /// The index of item for which the height/width is needed. /// public int Index { get; } /// - /// Where the recipient of the event should put the height of the item specified by - /// the index. + /// Where the recipient of the event should put the height of the item specified by + /// the index. /// public int ItemHeight { get; set; } /// - /// Where the recipient of the event should put the width of the item specified by - /// the index. + /// Where the recipient of the event should put the width of the item specified by + /// the index. /// public int ItemWidth { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Menu.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Menu.cs index 6e5cb9c5792..89b6c8356de 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Menu.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Menu.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// This is the base class for all menu components (MainMenu, MenuItem, and ContextMenu). + /// This is the base class for all menu components (MainMenu, MenuItem, and ContextMenu). /// [ToolboxItemFilter("System.Windows.Forms")] [ListBindable(false)] @@ -522,7 +522,7 @@ private IntPtr MatchKeyToMenuItem(int startItem, char key, MenuItemKeyComparer c return (IntPtr)NativeMethods.Util.MAKELONG(firstMatch, action); } - /// Delegate type used by MatchKeyToMenuItem + /// Delegate type used by MatchKeyToMenuItem private delegate bool MenuItemKeyComparer(MenuItem mi, char key); /// @@ -694,14 +694,14 @@ internal IntPtr WmMenuCharInternal(char key) return result; } - /// MenuItemKeyComparer delegate used by WmMenuCharInternal + /// MenuItemKeyComparer delegate used by WmMenuCharInternal private bool CheckOwnerDrawItemWithMnemonic(MenuItem mi, char key) { return mi.OwnerDraw && mi.Mnemonic == key; } - /// MenuItemKeyComparer delegate used by WmMenuCharInternal + /// MenuItemKeyComparer delegate used by WmMenuCharInternal private bool CheckOwnerDrawItemNoMnemonic(MenuItem mi, char key) { return mi.OwnerDraw && @@ -715,9 +715,9 @@ public class MenuItemCollection : IList { private readonly Menu owner; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; public MenuItemCollection(Menu owner) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MenuGlyph.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MenuGlyph.cs index 14c9d5ab0c8..25d33b11d94 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MenuGlyph.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MenuGlyph.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Enum to be used with the drawMenuGlyph function. + /// Enum to be used with the drawMenuGlyph function. /// public enum MenuGlyph { /// - /// Draws a submenu arrow. + /// Draws a submenu arrow. /// Arrow = NativeMethods.DFCS_MENUARROW, /// - /// Draws a menu checkmark. + /// Draws a menu checkmark. /// Checkmark = NativeMethods.DFCS_MENUCHECK, /// - /// Draws a menu bullet. + /// Draws a menu bullet. /// Bullet = NativeMethods.DFCS_MENUBULLET, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MenuItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MenuItem.cs index 6b7ae73f4ba..927d36f010b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MenuItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MenuItem.cs @@ -13,8 +13,8 @@ namespace System.Windows.Forms { /// - /// Represents an individual item that is displayed within a - /// or . + /// Represents an individual item that is displayed within a + /// or . /// [ToolboxItem(false)] [DesignTimeVisible(false)] @@ -57,39 +57,39 @@ public class MenuItem : Menu #endif /// - /// Initializes a with a blank caption. + /// Initializes a with a blank caption. /// public MenuItem() : this(MenuMerge.Add, 0, 0, null, null, null, null, null) { } /// - /// Initializes a new instance of the class - /// with a specified caption for the menu item. + /// Initializes a new instance of the class + /// with a specified caption for the menu item. /// public MenuItem(string text) : this(MenuMerge.Add, 0, 0, text, null, null, null, null) { } /// - /// Initializes a new instance of the class with a specified caption and event handler - /// for the menu item. + /// Initializes a new instance of the class with a specified caption and event handler + /// for the menu item. /// public MenuItem(string text, EventHandler onClick) : this(MenuMerge.Add, 0, 0, text, onClick, null, null, null) { } /// - /// Initializes a new instance of the class with a specified caption, event handler, - /// and associated shorcut key for the menu item. + /// Initializes a new instance of the class with a specified caption, event handler, + /// and associated shorcut key for the menu item. /// public MenuItem(string text, EventHandler onClick, Shortcut shortcut) : this(MenuMerge.Add, 0, shortcut, text, onClick, null, null, null) { } /// - /// Initializes a new instance of the class with a specified caption and an array of - /// submenu items defined for the menu item. + /// Initializes a new instance of the class with a specified caption and an array of + /// submenu items defined for the menu item. /// public MenuItem(string text, MenuItem[] items) : this(MenuMerge.Add, 0, 0, text, null, null, null, items) { @@ -105,9 +105,9 @@ internal MenuItem(MenuItemData data) : base(null) } /// - /// Initializes a new instance of the class with a specified caption, defined - /// event-handlers for the Click, Select and Popup events, a shortcut key, - /// a merge type, and order specified for the menu item. + /// Initializes a new instance of the class with a specified caption, defined + /// event-handlers for the Click, Select and Popup events, a shortcut key, + /// a merge type, and order specified for the menu item. /// public MenuItem(MenuMerge mergeType, int mergeOrder, Shortcut shortcut, string text, EventHandler onClick, EventHandler onPopup, @@ -123,9 +123,9 @@ public MenuItem(MenuMerge mergeType, int mergeOrder, Shortcut shortcut, } /// - /// Gets or sets a value indicating whether the item is placed on a new line (for a - /// menu item added to a object) or in a - /// new column (for a submenu or menu displayed in a ). + /// Gets or sets a value indicating whether the item is placed on a new line (for a + /// menu item added to a object) or in a + /// new column (for a submenu or menu displayed in a ). /// [Browsable(false)] [DefaultValue(false)] @@ -144,9 +144,9 @@ public bool BarBreak } /// - /// Gets or sets a value indicating whether the item is placed on a new line (for a - /// menu item added to a object) or in a - /// new column (for a submenu or menu displayed in a ). + /// Gets or sets a value indicating whether the item is placed on a new line (for a + /// menu item added to a object) or in a + /// new column (for a submenu or menu displayed in a ). /// [Browsable(false)] [DefaultValue(false)] @@ -165,8 +165,8 @@ public bool Break } /// - /// Gets or sets a value indicating whether a checkmark appears beside the text of - /// the menu item. + /// Gets or sets a value indicating whether a checkmark appears beside the text of + /// the menu item. /// [DefaultValue(false)] [SRDescription(nameof(SR.MenuItemCheckedDescr))] @@ -191,7 +191,7 @@ public bool Checked } /// - /// Gets or sets a value indicating whether the menu item is the default. + /// Gets or sets a value indicating whether the menu item is the default. /// [DefaultValue(false)] [SRDescription(nameof(SR.MenuItemDefaultDescr))] @@ -222,8 +222,8 @@ public bool DefaultItem } /// - /// Gets or sets a value indicating whether code that you provide draws the menu - /// item or Windows draws the menu item. + /// Gets or sets a value indicating whether code that you provide draws the menu + /// item or Windows draws the menu item. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -243,7 +243,7 @@ public bool OwnerDraw } /// - /// Gets or sets a value indicating whether the menu item is enabled. + /// Gets or sets a value indicating whether the menu item is enabled. /// [Localizable(true)] [DefaultValue(true)] @@ -263,7 +263,7 @@ public bool Enabled } /// - /// Gets or sets the menu item's position in its parent menu. + /// Gets or sets the menu item's position in its parent menu. /// [Browsable(false)] public int Index @@ -306,7 +306,7 @@ public int Index } /// - /// Gets a value indicating whether the menu item contains child menu items. + /// Gets a value indicating whether the menu item contains child menu items. /// [Browsable(false)] public override bool IsParent @@ -341,8 +341,8 @@ public override bool IsParent } /// - /// Gets or sets a value indicating whether the menu item will be populated with a - /// list of the MDI child windows that are displayed within the associated form. + /// Gets or sets a value indicating whether the menu item will be populated with a + /// list of the MDI child windows that are displayed within the associated form. /// [DefaultValue(false)] [SRDescription(nameof(SR.MenuItemMDIListDescr))] @@ -362,7 +362,7 @@ public bool MdiList } /// - /// Gets the Windows identifier for this menu item. + /// Gets the Windows identifier for this menu item. /// protected int MenuID { @@ -374,7 +374,7 @@ protected int MenuID } /// - /// Is this menu item currently selected (highlighted) by the user? + /// Is this menu item currently selected (highlighted) by the user? /// internal bool Selected { @@ -397,8 +397,8 @@ internal bool Selected } /// - /// Gets the zero-based index of this menu item in the parent menu, or -1 if this - /// menu item is not associated with a parent menu. + /// Gets the zero-based index of this menu item in the parent menu, or -1 if this + /// menu item is not associated with a parent menu. /// internal int MenuIndex { @@ -434,8 +434,8 @@ internal int MenuIndex } /// - /// Gets or sets a value that indicates the behavior of this - /// menu item when its menu is merged with another. + /// Gets or sets a value that indicates the behavior of this + /// menu item when its menu is merged with another. /// [DefaultValue(MenuMerge.Add)] [SRDescription(nameof(SR.MenuItemMergeTypeDescr))] @@ -459,8 +459,8 @@ public MenuMerge MergeType } /// - /// Gets or sets the relative position the menu item when its - /// menu is merged with another. + /// Gets or sets the relative position the menu item when its + /// menu is merged with another. /// [DefaultValue(0)] [SRDescription(nameof(SR.MenuItemMergeOrderDescr))] @@ -479,10 +479,10 @@ public int MergeOrder } /// - /// Retrieves the hotkey mnemonic that is associated with this menu item. - /// The mnemonic is the first character after an ampersand symbol in the menu's text - /// that is not itself an ampersand symbol. If no such mnemonic is defined this - /// will return zero. + /// Retrieves the hotkey mnemonic that is associated with this menu item. + /// The mnemonic is the first character after an ampersand symbol in the menu's text + /// that is not itself an ampersand symbol. If no such mnemonic is defined this + /// will return zero. /// [Browsable(false)] public char Mnemonic @@ -495,14 +495,14 @@ public char Mnemonic } /// - /// Gets the menu in which this menu item appears. + /// Gets the menu in which this menu item appears. /// [Browsable(false)] public Menu Parent { get; internal set; } /// - /// Gets or sets a value that indicates whether the menu item, if checked, - /// displays a radio-button mark instead of a check mark. + /// Gets or sets a value that indicates whether the menu item, if checked, + /// displays a radio-button mark instead of a check mark. /// [DefaultValue(false)] [SRDescription(nameof(SR.MenuItemRadioCheckDescr))] @@ -523,7 +523,7 @@ public bool RadioCheck internal override bool RenderIsRightToLeft => Parent != null && Parent.RenderIsRightToLeft; /// - /// Gets or sets the text of the menu item. + /// Gets or sets the text of the menu item. /// [Localizable(true)] [SRDescription(nameof(SR.MenuItemTextDescr))] @@ -542,7 +542,7 @@ public string Text } /// - /// Gets or sets the shortcut key associated with the menu item. + /// Gets or sets the shortcut key associated with the menu item. /// [Localizable(true)] [DefaultValue(Shortcut.None)] @@ -568,8 +568,8 @@ public Shortcut Shortcut } /// - /// Gets or sets a value that indicates whether the shortcut key that is associated - /// with the menu item is displayed next to the menu item caption. + /// Gets or sets a value that indicates whether the shortcut key that is associated + /// with the menu item is displayed next to the menu item caption. /// [DefaultValue(true), Localizable(true)] @@ -593,8 +593,8 @@ public bool ShowShortcut } /// - /// Gets or sets a value that indicates whether the menu item is visible on its - /// parent menu. + /// Gets or sets a value that indicates whether the menu item is visible on its + /// parent menu. /// [Localizable(true)] [DefaultValue(true)] @@ -614,8 +614,8 @@ public bool Visible } /// - /// Occurs when the menu item is clicked or selected using a shortcut key defined - /// for the menu item. + /// Occurs when the menu item is clicked or selected using a shortcut key defined + /// for the menu item. /// [SRDescription(nameof(SR.MenuItemOnClickDescr))] public event EventHandler Click @@ -633,8 +633,8 @@ public event EventHandler Click } /// - /// Occurs when when the property of a menu item is set to and - /// a request is made to draw the menu item. + /// Occurs when when the property of a menu item is set to and + /// a request is made to draw the menu item. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.drawItemEventDescr))] public event DrawItemEventHandler DrawItem @@ -652,7 +652,7 @@ public event DrawItemEventHandler DrawItem } /// - /// Occurs when when the menu needs to know the size of a menu item before drawing it. + /// Occurs when when the menu needs to know the size of a menu item before drawing it. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.measureItemEventDescr))] public event MeasureItemEventHandler MeasureItem @@ -670,7 +670,7 @@ public event MeasureItemEventHandler MeasureItem } /// - /// Occurs before a menu item's list of menu items is displayed. + /// Occurs before a menu item's list of menu items is displayed. /// [SRDescription(nameof(SR.MenuItemOnInitDescr))] public event EventHandler Popup @@ -688,8 +688,8 @@ public event EventHandler Popup } /// - /// Occurs when the user hovers their mouse over a menu item or selects it with the - /// keyboard but has not activated it. + /// Occurs when the user hovers their mouse over a menu item or selects it with the + /// keyboard but has not activated it. /// [SRDescription(nameof(SR.MenuItemOnSelectDescr))] public event EventHandler Select @@ -721,7 +721,7 @@ private static void CleanListItems(MenuItem senderMenu) } /// - /// Creates and returns an identical copy of this menu item. + /// Creates and returns an identical copy of this menu item. /// public virtual MenuItem CloneMenu() { @@ -731,7 +731,7 @@ public virtual MenuItem CloneMenu() } /// - /// Creates a copy of the specified menu item. + /// Creates a copy of the specified menu item. /// protected void CloneMenu(MenuItem itemSrc) { @@ -872,7 +872,7 @@ private NativeMethods.MENUITEMINFO_T CreateMenuItemInfo() } /// - /// Disposes the . + /// Disposes the . /// protected override void Dispose(bool disposing) { @@ -894,8 +894,8 @@ protected override void Dispose(bool disposing) } /// - /// Given a unique menu item ID, find the corresponding MenuItem - /// object, using the master lookup table of all created MenuItems. + /// Given a unique menu item ID, find the corresponding MenuItem + /// object, using the master lookup table of all created MenuItems. /// internal static MenuItem GetMenuItemFromUniqueID(uint uniqueID) { @@ -909,11 +909,11 @@ internal static MenuItem GetMenuItemFromUniqueID(uint uniqueID) } /// - /// Given the "item data" value of a Win32 menu item, find the corresponding MenuItem object (using - /// the master lookup table of all created MenuItems). The item data may be either the unique menu - /// item ID, or a pointer to an MSAAMENUINFO structure with a copy of the unique ID tacked to the end. - /// To reliably tell IDs and structure addresses apart, IDs live in the 0xC0000000-0xFFFFFFFF range. - /// This is the top 1Gb of unmananged process memory, where an app's heap allocations should never be. + /// Given the "item data" value of a Win32 menu item, find the corresponding MenuItem object (using + /// the master lookup table of all created MenuItems). The item data may be either the unique menu + /// item ID, or a pointer to an MSAAMENUINFO structure with a copy of the unique ID tacked to the end. + /// To reliably tell IDs and structure addresses apart, IDs live in the 0xC0000000-0xFFFFFFFF range. + /// This is the top 1Gb of unmananged process memory, where an app's heap allocations should never be. /// internal static MenuItem GetMenuItemFromItemData(IntPtr itemData) { @@ -942,9 +942,9 @@ internal static MenuItem GetMenuItemFromItemData(IntPtr itemData) } /// - /// MsaaMenuInfoWithId is an MSAAMENUINFO structure with a menu item ID field tacked onto the - /// end. This allows us to pass the data we need to Win32 / MSAA, and still be able to get the ID - /// out again later on, so we can delegate Win32 menu messages back to the correct MenuItem object. + /// MsaaMenuInfoWithId is an MSAAMENUINFO structure with a menu item ID field tacked onto the + /// end. This allows us to pass the data we need to Win32 / MSAA, and still be able to get the ID + /// out again later on, so we can delegate Win32 menu messages back to the correct MenuItem object. /// [StructLayout(LayoutKind.Sequential)] private struct MsaaMenuInfoWithId @@ -960,10 +960,10 @@ public MsaaMenuInfoWithId(string text, uint uniqueID) } /// - /// Creates an MSAAMENUINFO structure (in the unmanaged heap) based on the current state - /// of this MenuItem object. Address of this structure is cached in the object so we can - /// free it later on using FreeMsaaMenuInfo(). If structure has already been allocated, - /// it is destroyed and a new one created. + /// Creates an MSAAMENUINFO structure (in the unmanaged heap) based on the current state + /// of this MenuItem object. Address of this structure is cached in the object so we can + /// free it later on using FreeMsaaMenuInfo(). If structure has already been allocated, + /// it is destroyed and a new one created. /// private IntPtr AllocMsaaMenuInfo() { @@ -984,9 +984,9 @@ private IntPtr AllocMsaaMenuInfo() } /// - /// Frees the MSAAMENUINFO structure (in the unmanaged heap) for the current MenuObject - /// object, if one has previously been allocated. Takes care to free sub-structures too, - /// to avoid leaks! + /// Frees the MSAAMENUINFO structure (in the unmanaged heap) for the current MenuObject + /// object, if one has previously been allocated. Takes care to free sub-structures too, + /// to avoid leaks! /// private void FreeMsaaMenuInfo() { @@ -1079,10 +1079,10 @@ internal Form[] FindMdiForms() } /// - /// See the similar code in MdiWindowListStrip.PopulateItems, which is - /// unfortunately just different enough in its working environment that we - /// can't readily combine the two. But if you're fixing something here, chances - /// are that the same issue will need scrutiny over there. + /// See the similar code in MdiWindowListStrip.PopulateItems, which is + /// unfortunately just different enough in its working environment that we + /// can't readily combine the two. But if you're fixing something here, chances + /// are that the same issue will need scrutiny over there. /// // "-" is OK private void PopulateMdiList() @@ -1167,7 +1167,7 @@ private void PopulateMdiList() } /// - /// Merges this menu item with another menu item and returns the resulting merged + /// Merges this menu item with another menu item and returns the resulting merged /// . /// public virtual MenuItem MergeMenu() @@ -1181,7 +1181,7 @@ public virtual MenuItem MergeMenu() } /// - /// Merges another menu item with this menu item. + /// Merges another menu item with this menu item. /// public void MergeMenu(MenuItem itemSrc) { @@ -1190,7 +1190,7 @@ public void MergeMenu(MenuItem itemSrc) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnClick(EventArgs e) { @@ -1211,7 +1211,7 @@ protected virtual void OnClick(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnDrawItem(DrawItemEventArgs e) { @@ -1228,7 +1228,7 @@ protected virtual void OnDrawItem(DrawItemEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnMeasureItem(MeasureItemEventArgs e) { @@ -1245,7 +1245,7 @@ protected virtual void OnMeasureItem(MeasureItemEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnPopup(EventArgs e) { @@ -1291,7 +1291,7 @@ protected virtual void OnPopup(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnSelect(EventArgs e) { @@ -1310,13 +1310,13 @@ protected virtual void OnSelect(EventArgs e) protected internal virtual void OnInitMenuPopup(EventArgs e) => OnPopup(e); /// - /// Generates a event for the MenuItem, - /// simulating a click by a user. + /// Generates a event for the MenuItem, + /// simulating a click by a user. /// public void PerformClick() => OnClick(EventArgs.Empty); /// - /// Raises the event for this menu item. + /// Raises the event for this menu item. /// public virtual void PerformSelect() => OnSelect(EventArgs.Empty); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MenuMerge.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MenuMerge.cs index a3fd5cd0f59..d7e4cc08ff8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MenuMerge.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MenuMerge.cs @@ -5,34 +5,34 @@ namespace System.Windows.Forms { /// - /// Specifies the behavior of a when it is merged with items in another menu. + /// Specifies the behavior of a when it is merged with items in another menu. /// public enum MenuMerge { /// - /// The is added to the - /// existing objects in a - /// merged menu. + /// The is added to the + /// existing objects in a + /// merged menu. /// Add = 0, /// - /// The replaces the - /// existing at the same - /// position in a merged menu. + /// The replaces the + /// existing at the same + /// position in a merged menu. /// Replace = 1, /// - /// Subitems of this are merged - /// with those of existing - /// objects at the same position in a merged menu. + /// Subitems of this are merged + /// with those of existing + /// objects at the same position in a merged menu. /// MergeItems = 2, /// - /// The is not included in a - /// merged menu. + /// The is not included in a + /// merged menu. /// Remove = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MenuStrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MenuStrip.cs index 05c75ff78a5..c9c2135df76 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MenuStrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MenuStrip.cs @@ -187,7 +187,7 @@ protected virtual void OnMenuDeactivate(EventArgs e) } /// - /// Called from ToolStripManager.ProcessMenuKey. Fires MenuActivate event and sets focus. + /// Called from ToolStripManager.ProcessMenuKey. Fires MenuActivate event and sets focus. /// internal bool OnMenuKey() { @@ -239,7 +239,7 @@ protected override bool ProcessCmdKey(ref Message m, Keys keyData) } /// - /// Summary of WndProc. + /// Summary of WndProc. /// /// protected override void WndProc(ref Message m) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Message.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Message.cs index efee235aca3..f4a0a269ed6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Message.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Message.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Implements a Windows message. + /// Implements a Windows message. /// public struct Message { @@ -21,24 +21,24 @@ public struct Message public int Msg { get; set; } /// - /// Specifies the of the message. + /// Specifies the of the message. /// public IntPtr WParam { get; set; } /// - /// Specifies the of the message. + /// Specifies the of the message. /// public IntPtr LParam { get; set; } public IntPtr Result { get; set; } /// - /// Gets the value, and converts the value to an object. + /// Gets the value, and converts the value to an object. /// public object GetLParam(Type cls) => Marshal.PtrToStructure(LParam, cls); /// - /// Creates a new object. + /// Creates a new object. /// public static Message Create(IntPtr hWnd, int msg, IntPtr wparam, IntPtr lparam) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBox.cs index dd6a33699d0..ae1bdf3c1f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBox.cs @@ -135,7 +135,6 @@ private static void PushHelpInfo(HelpInfo hpi) ///////////////////////////////////////////////////////////////////////////////////////////////////////////////// //START WHIDBEY ADDS // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////// - /// /// Displays a message box with specified text, caption, and style with Help Button. /// @@ -230,7 +229,6 @@ public static DialogResult Show(IWin32Window owner, string text, string caption, ///////////////////////////////////////////////////////////////////////////////////////////////////////////////// //END ADD // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////// - /// /// Displays a message box with specified text, caption, and style. /// diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxButtons.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxButtons.cs index a432b8a1fb1..57f79141049 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxButtons.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxButtons.cs @@ -7,40 +7,40 @@ namespace System.Windows.Forms public enum MessageBoxButtons { /// - /// Specifies that the message box contains an OK button. This field is - /// constant. + /// Specifies that the message box contains an OK button. This field is + /// constant. /// OK = 0x00000000, /// - /// Specifies that the message box contains OK and Cancel buttons. This - /// field is constant. + /// Specifies that the message box contains OK and Cancel buttons. This + /// field is constant. /// OKCancel = 0x00000001, /// - /// Specifies that the message box contains Abort, Retry, and Ignore - /// buttons. - /// This field is constant. + /// Specifies that the message box contains Abort, Retry, and Ignore + /// buttons. + /// This field is constant. /// AbortRetryIgnore = 0x00000002, /// - /// Specifies that the message box contains Yes, No, and Cancel buttons. - /// This field is constant. + /// Specifies that the message box contains Yes, No, and Cancel buttons. + /// This field is constant. /// YesNoCancel = 0x00000003, /// - /// Specifies that the - /// message box contains Yes and No buttons. This field is - /// constant. + /// Specifies that the + /// message box contains Yes and No buttons. This field is + /// constant. /// YesNo = 0x00000004, /// - /// Specifies that the message box contains Retry and Cancel buttons. - /// This field is constant. + /// Specifies that the message box contains Retry and Cancel buttons. + /// This field is constant. /// RetryCancel = 0x00000005 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxDefaultButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxDefaultButton.cs index 15b54a8299a..068f1755cb3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxDefaultButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxDefaultButton.cs @@ -7,20 +7,20 @@ namespace System.Windows.Forms public enum MessageBoxDefaultButton { /// - /// Specifies that the first button on the message box should be the - /// default button. + /// Specifies that the first button on the message box should be the + /// default button. /// Button1 = 0x00000000, /// - /// Specifies that the second button on the message box should be the - /// default button. + /// Specifies that the second button on the message box should be the + /// default button. /// Button2 = 0x00000100, /// - /// Specifies that the third button on the message box should be the - /// default button. + /// Specifies that the third button on the message box should be the + /// default button. /// Button3 = 0x00000200, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxIcon.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxIcon.cs index bb0b5dac509..5bc38bd6c3d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxIcon.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxIcon.cs @@ -7,48 +7,48 @@ namespace System.Windows.Forms public enum MessageBoxIcon { /// - /// Specifies that the message box contain no symbols. + /// Specifies that the message box contain no symbols. /// None = 0, /// - /// Specifies that the message box contains a hand symbol. + /// Specifies that the message box contains a hand symbol. /// Hand = 0x00000010, /// - /// Specifies that the message box contains a question mark symbol. + /// Specifies that the message box contains a question mark symbol. /// Question = 0x00000020, /// - /// Specifies that the message box contains an exclamation symbol. + /// Specifies that the message box contains an exclamation symbol. /// Exclamation = 0x00000030, /// - /// Specifies that the message box contains an asterisk symbol. + /// Specifies that the message box contains an asterisk symbol. /// Asterisk = 0x00000040, /// - /// Specifies that the message box contains a hand icon. This field is - /// constant. + /// Specifies that the message box contains a hand icon. This field is + /// constant. /// Stop = Hand, /// - /// Specifies that the message box contains a hand icon. + /// Specifies that the message box contains a hand icon. /// Error = Hand, /// - /// Specifies that the message box contains an exclamation icon. + /// Specifies that the message box contains an exclamation icon. /// Warning = Exclamation, /// - /// Specifies that the message box contains an asterisk icon. + /// Specifies that the message box contains an asterisk icon. /// Information = Asterisk, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxOptions.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxOptions.cs index 4f7856bef9e..ee34edf1cbc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxOptions.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageBoxOptions.cs @@ -8,22 +8,22 @@ namespace System.Windows.Forms public enum MessageBoxOptions { /// - /// Specifies that the message box is displayed on the active desktop. + /// Specifies that the message box is displayed on the active desktop. /// ServiceNotification = 0x00200000, /// - /// Specifies that the message box is displayed on the active desktop. + /// Specifies that the message box is displayed on the active desktop. /// DefaultDesktopOnly = 0x00020000, /// - /// Specifies that the message box text is right-aligned. + /// Specifies that the message box text is right-aligned. /// RightAlign = 0x00080000, /// - /// Specifies that the message box text is displayed with Rtl reading order. + /// Specifies that the message box text is displayed with Rtl reading order. /// RtlReading = 0x00100000, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MessageDecoder.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MessageDecoder.cs index 5ad8d04ac1b..f6816421dde 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MessageDecoder.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MessageDecoder.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Decodes Windows messages. This is in a separate class from Message so we can avoid - /// loading it in the 99% case where we don't need it. + /// Decodes Windows messages. This is in a separate class from Message so we can avoid + /// loading it in the 99% case where we don't need it. /// internal static class MessageDecoder { /// - /// Returns the symbolic name of the msg value, or null if it isn't one of the - /// existing constants. + /// Returns the symbolic name of the msg value, or null if it isn't one of the + /// existing constants. /// private static string MsgToString(int msg) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MonthCalendar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MonthCalendar.cs index 7f1055ac205..d6195c4dd53 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MonthCalendar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MonthCalendar.cs @@ -160,7 +160,7 @@ public MonthCalendar() } /// - /// MonthCalendar control accessbile object. + /// MonthCalendar control accessbile object. /// /// protected override AccessibleObject CreateAccessibilityInstance() @@ -2537,94 +2537,94 @@ internal static bool HitAreaHasValidDateTime(HitArea hitArea) } /// - /// This enumeration has specific areas of the MonthCalendar control as - /// its enumerated values. The hitArea member of System.Windows.Forms.Win32.HitTestInfo - /// will be one of these enumerated values, and indicates which portion of - /// a month calendar is under a specific point. + /// This enumeration has specific areas of the MonthCalendar control as + /// its enumerated values. The hitArea member of System.Windows.Forms.Win32.HitTestInfo + /// will be one of these enumerated values, and indicates which portion of + /// a month calendar is under a specific point. /// public enum HitArea { /// - /// The given point was not on the month calendar control, or it was - /// in an inactive portion of the control. + /// The given point was not on the month calendar control, or it was + /// in an inactive portion of the control. /// Nowhere = 0, /// - /// The given point was over the background of a month's title + /// The given point was over the background of a month's title /// TitleBackground = 1, /// - /// The given point was in a month's title bar, over a month name + /// The given point was in a month's title bar, over a month name /// TitleMonth = 2, /// - /// The given point was in a month's title bar, over the year value + /// The given point was in a month's title bar, over the year value /// TitleYear = 3, /// - /// The given point was over the button at the top right corner of - /// the control. If the user clicks here, the month calendar will - /// scroll its display to the next month or set of months + /// The given point was over the button at the top right corner of + /// the control. If the user clicks here, the month calendar will + /// scroll its display to the next month or set of months /// NextMonthButton = 4, /// - /// The given point was over the button at the top left corner of - /// the control. If the user clicks here, the month calendar will - /// scroll its display to the previous month or set of months + /// The given point was over the button at the top left corner of + /// the control. If the user clicks here, the month calendar will + /// scroll its display to the previous month or set of months /// PrevMonthButton = 5, /// - /// The given point was in the calendar's background + /// The given point was in the calendar's background /// CalendarBackground = 6, /// - /// The given point was on a particular date within the calendar, - /// and the time member of HitTestInfo will be set to the date at - /// the given point. + /// The given point was on a particular date within the calendar, + /// and the time member of HitTestInfo will be set to the date at + /// the given point. /// Date = 7, /// - /// The given point was over a date from the next month (partially - /// displayed at the end of the currently displayed month). If the - /// user clicks here, the month calendar will scroll its display to - /// the next month or set of months. + /// The given point was over a date from the next month (partially + /// displayed at the end of the currently displayed month). If the + /// user clicks here, the month calendar will scroll its display to + /// the next month or set of months. /// NextMonthDate = 8, /// - /// The given point was over a date from the previous month (partially - /// displayed at the end of the currently displayed month). If the - /// user clicks here, the month calendar will scroll its display to - /// the previous month or set of months. + /// The given point was over a date from the previous month (partially + /// displayed at the end of the currently displayed month). If the + /// user clicks here, the month calendar will scroll its display to + /// the previous month or set of months. /// PrevMonthDate = 9, /// - /// The given point was over a day abbreviation ("Fri", for example). - /// The time member of HitTestInfo will be set to the corresponding - /// date on the top row. + /// The given point was over a day abbreviation ("Fri", for example). + /// The time member of HitTestInfo will be set to the corresponding + /// date on the top row. /// DayOfWeek = 10, /// - /// The given point was over a week number. This will only occur if - /// the showWeekNumbers property of MonthCalendar is enabled. The - /// time member of HitTestInfo will be set to the corresponding date - /// in the leftmost column. + /// The given point was over a week number. This will only occur if + /// the showWeekNumbers property of MonthCalendar is enabled. The + /// time member of HitTestInfo will be set to the corresponding date + /// in the leftmost column. /// WeekNumbers = 11, /// - /// The given point was on the "today" link at the bottom of the - /// month calendar control + /// The given point was on the "today" link at the bottom of the + /// month calendar control /// TodayLink = 12, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MouseButtons.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MouseButtons.cs index d7abc3ccb99..c512d89760f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MouseButtons.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MouseButtons.cs @@ -7,29 +7,29 @@ namespace System.Windows.Forms { /// - /// Specifies constants that define which mouse button was pressed. + /// Specifies constants that define which mouse button was pressed. /// [Flags] [ComVisible(true)] public enum MouseButtons { /// - /// The left mouse button was pressed. + /// The left mouse button was pressed. /// Left = 0x00100000, /// - /// No mouse button was pressed. + /// No mouse button was pressed. /// None = 0x00000000, /// - /// The right mouse button was pressed. + /// The right mouse button was pressed. /// Right = 0x00200000, /// - /// The middle mouse button was pressed. + /// The middle mouse button was pressed. /// Middle = 0x00400000, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventArgs.cs index aefd00fbd0a..bfa50b24d13 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventArgs.cs @@ -8,14 +8,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the , , and + /// Provides data for the , , and /// events. /// [ComVisible(true)] public class MouseEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public MouseEventArgs(MouseButtons button, int clicks, int x, int y, int delta) { @@ -27,32 +27,32 @@ public MouseEventArgs(MouseButtons button, int clicks, int x, int y, int delta) } /// - /// Gets which mouse button was pressed. + /// Gets which mouse button was pressed. /// public MouseButtons Button { get; } /// - /// Gets the number of times the mouse button was pressed and released. + /// Gets the number of times the mouse button was pressed and released. /// public int Clicks { get; } /// - /// Gets the x-coordinate of a mouse click. + /// Gets the x-coordinate of a mouse click. /// public int X { get; } /// - /// Gets the y-coordinate of a mouse click. + /// Gets the y-coordinate of a mouse click. /// public int Y { get; } /// - /// Gets a signed count of the number of detents the mouse wheel has rotated. + /// Gets a signed count of the number of detents the mouse wheel has rotated. /// public int Delta { get; } /// - /// Gets the location of the mouse during MouseEvent. + /// Gets the location of the mouse during MouseEvent. /// public Point Location => new Point(X, Y); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventHandler.cs index 8111b072c48..6687b21658f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/MouseEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , or - /// event of a form, control, or other component. + /// event of a form, control, or other component. /// public delegate void MouseEventHandler(object sender, MouseEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/NativeWindow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/NativeWindow.cs index 3d2c4a5db7d..15693a4341b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/NativeWindow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/NativeWindow.cs @@ -99,7 +99,7 @@ public NativeWindow() } /// - /// Cache window DpiContext awareness information that helps to create handle with right context at the later time. + /// Cache window DpiContext awareness information that helps to create handle with right context at the later time. /// internal DpiAwarenessContext DpiAwarenessContext { get; } = DpiHelper.IsScalingRequirementMet ? CommonUnsafeNativeMethods.TryGetThreadDpiAwarenessContext() @@ -114,9 +114,9 @@ public NativeWindow() } /// - /// This was factored into another function so the finalizer in control that releases the window - /// can perform the exact same code without further changes. If you make changes to the finalizer, - /// change this method -- try not to change NativeWindow's finalizer. + /// This was factored into another function so the finalizer in control that releases the window + /// can perform the exact same code without further changes. If you make changes to the finalizer, + /// change this method -- try not to change NativeWindow's finalizer. /// internal void ForceExitMessageLoop() { @@ -198,7 +198,7 @@ internal static bool AnyHandleCreated internal NativeWindow PreviousWindow { get; private set; } /// - /// Address of the Windows default WNDPROC (DefWindowProcW). + /// Address of the Windows default WNDPROC (DefWindowProcW). /// internal static IntPtr DefaultWindowProc { @@ -1405,7 +1405,7 @@ private string GetFullClassName(string className) } /// - /// Once the classname and style bits have been set, this can be called to register the class. + /// Once the classname and style bits have been set, this can be called to register the class. /// private unsafe void RegisterClass() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventArgs.cs index cbe2539c7d6..28459166d04 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventArgs.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// or event. + /// Provides data for the + /// or event. /// public class NodeLabelEditEventArgs : EventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventHandler.cs index 4c5901e4d2a..ab79480e0ce 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/NodeLabelEditEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// or event of - /// a . + /// Represents the method that will handle the + /// or event of + /// a . /// public delegate void NodeLabelEditEventHandler(object sender, NodeLabelEditEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDown.cs b/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDown.cs index 189fb70c026..162be78a2a5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDown.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDown.cs @@ -36,7 +36,6 @@ public class NumericUpDown : UpDownBase, ISupportInitialize // Member variables // ////////////////////////////////////////////////////////////// - /// /// The number of decimal places to display. /// @@ -89,7 +88,6 @@ public NumericUpDown() : base() // Properties // ////////////////////////////////////////////////////////////// - /// /// Specifies the acceleration information. /// @@ -383,7 +381,6 @@ public decimal Value // Methods // ////////////////////////////////////////////////////////////// - /// /// Occurs when the property has been changed in some way. /// @@ -546,7 +543,7 @@ protected override void OnTextBoxKeyPress(object source, KeyPressEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnValueChanged(EventArgs e) { @@ -658,7 +655,7 @@ private void ResetValue() } /// - /// Indicates whether the property should be + /// Indicates whether the property should be /// persisted. /// private bool ShouldSerializeIncrement() @@ -667,7 +664,7 @@ private bool ShouldSerializeIncrement() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// private bool ShouldSerializeMaximum() { @@ -675,7 +672,7 @@ private bool ShouldSerializeMaximum() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// private bool ShouldSerializeMinimum() { @@ -683,7 +680,7 @@ private bool ShouldSerializeMinimum() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// private bool ShouldSerializeValue() { @@ -928,7 +925,7 @@ public NumericUpDownAccessibleObject(NumericUpDown owner) : base(owner) } /// - /// Gets or sets the accessible name. + /// Gets or sets the accessible name. /// public override string Name { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDownAccelerationCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDownAccelerationCollection.cs index 715df0b3dbf..e092378f324 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDownAccelerationCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/NumericUpDownAccelerationCollection.cs @@ -17,7 +17,7 @@ public class NumericUpDownAccelerationCollection : MarshalByRefObject, ICollecti { readonly List items; - /// ICollection implementation. + /// ICollection implementation. /// /// Adds an item (NumericUpDownAcceleration object) to the ICollection. @@ -93,7 +93,7 @@ public bool Remove(NumericUpDownAcceleration acceleration) return items.Remove(acceleration); } - /// IEnumerable implementation. + /// IEnumerable implementation. /// /// Returns an enumerator that can iterate through the collection. @@ -108,7 +108,7 @@ IEnumerator IEnumerable.GetEnumerator() return ((IEnumerable)items).GetEnumerator(); } - /// NumericUpDownAccelerationCollection methods. + /// NumericUpDownAccelerationCollection methods. /// /// Class constructor. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/OSFeature.cs b/src/System.Windows.Forms/src/System/Windows/Forms/OSFeature.cs index e5e0fee7783..7f61e81d730 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/OSFeature.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/OSFeature.cs @@ -5,38 +5,38 @@ namespace System.Windows.Forms { /// - /// Provides operating-system specific feature queries. + /// Provides operating-system specific feature queries. /// public class OSFeature : FeatureSupport { /// - /// Represents the layered, top-level windows feature. This field - /// is read-only. + /// Represents the layered, top-level windows feature. This field + /// is read-only. /// public static readonly object LayeredWindows = new object(); /// - /// Determines if the OS supports themes + /// Determines if the OS supports themes /// public static readonly object Themes = new object(); private static OSFeature _feature = null; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// protected OSFeature() { } /// - /// Represents the instance of - /// to use for feature queries. This property is read-only. + /// Represents the instance of + /// to use for feature queries. This property is read-only. /// public static OSFeature Feature => _feature ?? (_feature = new OSFeature()); /// - /// Retrieves the version of the specified feature currently available on the system. + /// Retrieves the version of the specified feature currently available on the system. /// public override Version GetVersionPresent(object feature) { @@ -50,7 +50,7 @@ public override Version GetVersionPresent(object feature) } /// - /// Retrieves whether SystemParameterType is supported on the Current OS version. + /// Retrieves whether SystemParameterType is supported on the Current OS version. /// public static bool IsPresent(SystemParameter enumVal) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/OpacityConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/OpacityConverter.cs index 0e3a316b7ad..82fa270c984 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/OpacityConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/OpacityConverter.cs @@ -8,14 +8,14 @@ namespace System.Windows.Forms { /// - /// OpacityConverter is a class that can be used to convert opacity values from one - /// data type to another. Access this class through the TypeDescriptor. + /// OpacityConverter is a class that can be used to convert opacity values from one + /// data type to another. Access this class through the TypeDescriptor. /// public class OpacityConverter : TypeConverter { /// - /// Determines if this converter can convert an object in the given source - /// type to the native type of the converter. + /// Determines if this converter can convert an object in the given source + /// type to the native type of the converter. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -28,7 +28,7 @@ public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceT } /// - /// Converts the given object to the converter's native type. + /// Converts the given object to the converter's native type. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { @@ -81,11 +81,11 @@ public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo c } /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Orientation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Orientation.cs index 17e3328c428..11003a350ba 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Orientation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Orientation.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Specifies the orientation of controls or elements of controls. + /// Specifies the orientation of controls or elements of controls. /// public enum Orientation { /// - /// The control or element is oriented horizontally. + /// The control or element is oriented horizontally. /// Horizontal = 0, /// - /// The control or element is oriented vertically. + /// The control or element is oriented vertically. /// Vertical = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/OwnerDrawPropertyBag.cs b/src/System.Windows.Forms/src/System/Windows/Forms/OwnerDrawPropertyBag.cs index 656decf36a1..8596f241467 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/OwnerDrawPropertyBag.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/OwnerDrawPropertyBag.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Class used to pass new font/color information around for "partial" ownerdraw list/treeview items. + /// Class used to pass new font/color information around for "partial" ownerdraw list/treeview items. /// [Serializable] // This class is participating in resx serialization scenarios for listview/treeview items. public class OwnerDrawPropertyBag : MarshalByRefObject, ISerializable @@ -59,12 +59,12 @@ internal IntPtr FontHandle } /// - /// Returns whether or not this property bag contains all default values (is empty) + /// Returns whether or not this property bag contains all default values (is empty) /// public virtual bool IsEmpty() => Font == null && ForeColor.IsEmpty && BackColor.IsEmpty; /// - /// Copies the bag. Always returns a valid ODPB object + /// Copies the bag. Always returns a valid ODPB object /// public static OwnerDrawPropertyBag Copy(OwnerDrawPropertyBag value) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Padding.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Padding.cs index f317c07ec1f..773c467d84e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Padding.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Padding.cs @@ -141,7 +141,7 @@ public override bool Equals(object other) } /// - /// Performs vector addition of two objects. + /// Performs vector addition of two objects. /// public static Padding operator +(Padding p1, Padding p2) { @@ -149,7 +149,7 @@ public override bool Equals(object other) } /// - /// Contracts a by another . + /// Contracts a by another . /// public static Padding operator -(Padding p1, Padding p2) { @@ -157,7 +157,7 @@ public override bool Equals(object other) } /// - /// Tests whether two objects are identical. + /// Tests whether two objects are identical. /// public static bool operator ==(Padding p1, Padding p2) { @@ -165,7 +165,7 @@ public override bool Equals(object other) } /// - /// Tests whether two objects are different. + /// Tests whether two objects are different. /// public static bool operator !=(Padding p1, Padding p2) => !(p1 == p2); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PaddingConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PaddingConverter.cs index 4e609406be3..928f122252d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PaddingConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PaddingConverter.cs @@ -12,8 +12,8 @@ namespace System.Windows.Forms public class PaddingConverter : TypeConverter { /// - /// Determines if this converter can convert an object in the given source type to - /// the native type of the converter. + /// Determines if this converter can convert an object in the given source type to + /// the native type of the converter. /// public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) { @@ -36,7 +36,7 @@ public override bool CanConvertTo(ITypeDescriptorContext context, Type destinati } /// - /// Converts the given object to the converter's native type. + /// Converts the given object to the converter's native type. /// public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventArgs.cs index ed63e2a1121..e3a134147e1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventArgs.cs @@ -10,25 +10,25 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. - /// NOTE: Please keep this class consistent with PrintPageEventArgs. + /// Provides data for the + /// event. + /// NOTE: Please keep this class consistent with PrintPageEventArgs. /// public class PaintEventArgs : EventArgs, IDisposable { /// - /// Graphics object with which painting should be done. + /// Graphics object with which painting should be done. /// private Graphics _graphics; /// - /// See ResetGraphics() + /// See ResetGraphics() /// private GraphicsState _savedGraphicsState; /// - /// DC (Display context) for obtaining the graphics object. Used to delay - /// getting the graphics object until absolutely necessary (for perf reasons) + /// DC (Display context) for obtaining the graphics object. Used to delay + /// getting the graphics object until absolutely necessary (for perf reasons) /// private readonly IntPtr _dc = IntPtr.Zero; @@ -52,8 +52,8 @@ internal static string GetAllocationStack() #endif /// - /// Initializes a new instance of the - /// class with the specified graphics and clipping rectangle. + /// Initializes a new instance of the + /// class with the specified graphics and clipping rectangle. /// public PaintEventArgs(Graphics graphics, Rectangle clipRect) { @@ -62,8 +62,8 @@ public PaintEventArgs(Graphics graphics, Rectangle clipRect) } /// - /// Internal version of constructor for performance - /// We try to avoid getting the graphics object until needed + /// Internal version of constructor for performance + /// We try to avoid getting the graphics object until needed /// internal PaintEventArgs(IntPtr dc, Rectangle clipRect) { @@ -76,19 +76,19 @@ internal PaintEventArgs(IntPtr dc, Rectangle clipRect) ~PaintEventArgs() => Dispose(false); /// - /// Gets the rectangle in which to paint. + /// Gets the rectangle in which to paint. /// public Rectangle ClipRectangle { get; } /// - /// Gets the HDC this paint event is connected to. If there is no associated - /// HDC, or the GDI+ Graphics object has been created (meaning GDI+ now owns the - /// HDC), 0 is returned. + /// Gets the HDC this paint event is connected to. If there is no associated + /// HDC, or the GDI+ Graphics object has been created (meaning GDI+ now owns the + /// HDC), 0 is returned. /// internal IntPtr HDC => _graphics == null ? _dc : IntPtr.Zero; /// - /// Gets the object used to paint. + /// Gets the object used to paint. /// public Graphics Graphics { @@ -107,7 +107,7 @@ public Graphics Graphics } /// - /// Disposes of the resources (other than memory) used by the + /// Disposes of the resources (other than memory) used by the /// . /// public void Dispose() @@ -135,11 +135,11 @@ protected virtual void Dispose(bool disposing) } /// - /// If ControlStyles.AllPaintingInWmPaint, we call this method - /// after OnPaintBackground so it appears to OnPaint that it's getting a fresh - /// Graphics. We want to make sure AllPaintingInWmPaint is purely an optimization, - /// and doesn't change behavior, so we need to make sure any clipping regions established - /// in OnPaintBackground don't apply to OnPaint. + /// If ControlStyles.AllPaintingInWmPaint, we call this method + /// after OnPaintBackground so it appears to OnPaint that it's getting a fresh + /// Graphics. We want to make sure AllPaintingInWmPaint is purely an optimization, + /// and doesn't change behavior, so we need to make sure any clipping regions established + /// in OnPaintBackground don't apply to OnPaint. /// internal void ResetGraphics() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventHandler.cs index 56679ffb31d..022c045369a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PaintEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the event of a class. + /// Represents the method that will handle the event of a class. /// public delegate void PaintEventHandler(object sender, PaintEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Panel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Panel.cs index 3f8a15c727d..44f0fd4712a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Panel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Panel.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms { /// - /// Represents a control. + /// Represents a control. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -24,7 +24,7 @@ public class Panel : ScrollableControl private BorderStyle _borderStyle = BorderStyle.None; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Panel() : base() { @@ -36,7 +36,7 @@ public Panel() : base() } /// - /// Override to re-expose AutoSize. + /// Override to re-expose AutoSize. /// [Browsable(true)] [EditorBrowsable(EditorBrowsableState.Always)] @@ -58,7 +58,7 @@ public override bool AutoSize } /// - /// Allows the control to optionally shrink when AutoSize is true. + /// Allows the control to optionally shrink when AutoSize is true. /// [SRDescription(nameof(SR.ControlAutoSizeModeDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -94,7 +94,7 @@ public virtual AutoSizeMode AutoSizeMode } /// - /// Indicates the border style for the control. + /// Indicates the border style for the control. /// [SRCategory(nameof(SR.CatAppearance))] [DefaultValue(BorderStyle.None)] @@ -119,9 +119,9 @@ public BorderStyle BorderStyle } /// - /// Returns the parameters needed to create the handle. Inheriting classes can override - /// this to provide extra functionality. They should not, however, forget to call - /// base.getCreateParams() first to get the struct filled up with the basic info. + /// Returns the parameters needed to create the handle. Inheriting classes can override + /// this to provide extra functionality. They should not, however, forget to call + /// base.getCreateParams() first to get the struct filled up with the basic info. /// protected override CreateParams CreateParams { @@ -147,8 +147,8 @@ protected override CreateParams CreateParams } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected override Size DefaultSize => new Size(200, 100); @@ -210,10 +210,10 @@ public override string Text } /// - /// Fires the event indicating that the panel has been resized. - /// Inheriting controls should use this in favour of actually listening to - /// the event, but should not forget to call base.onResize() to - /// ensure that the event is still fired for external listeners. + /// Fires the event indicating that the panel has been resized. + /// Inheriting controls should use this in favour of actually listening to + /// the event, but should not forget to call base.onResize() to + /// ensure that the event is still fired for external listeners. /// protected override void OnResize(EventArgs eventargs) { @@ -239,7 +239,7 @@ internal override void PrintToMetaFileRecursive(HandleRef hDC, IntPtr lParam, Re } /// - /// Returns a string representation for this control. + /// Returns a string representation for this control. /// public override string ToString() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PictureBoxSizeMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PictureBoxSizeMode.cs index 6d4489cdbe1..851d3d922ca 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PictureBoxSizeMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PictureBoxSizeMode.cs @@ -5,42 +5,42 @@ namespace System.Windows.Forms { /// - /// Specifies how an image is positioned within a . + /// Specifies how an image is positioned within a . /// public enum PictureBoxSizeMode { /// - /// The image is placed in the top-left corner of the + /// The image is placed in the top-left corner of the /// . The image is clipped - /// if the is to small. + /// if the is to small. /// Normal = 0, /// - /// The image within the is - /// stretched or shrunk to fit the current size of the + /// The image within the is + /// stretched or shrunk to fit the current size of the // . /// StretchImage = 1, /// - /// The is sized to fit the - /// size of the image that is displayed. + /// The is sized to fit the + /// size of the image that is displayed. /// AutoSize = 2, /// - /// The image is displayed in the center if the + /// The image is displayed in the center if the /// is larger than the - /// image. If the image is larger than the , - /// the center of the picture is placed in the center of the + /// image. If the image is larger than the , + /// the center of the picture is placed in the center of the /// and the outside edges are - /// clipped. + /// clipped. /// CenterImage = 3, /// - /// The size of image is increased or decresed maintaining the aspect ratio. + /// The size of image is increased or decresed maintaining the aspect ratio. /// Zoom = 4 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventArgs.cs index 184be1aa95d..1f471bdd011 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventArgs.cs @@ -8,12 +8,12 @@ namespace System.Windows.Forms { /// - /// This class contains the information a user needs to paint the ToolTip. + /// This class contains the information a user needs to paint the ToolTip. /// public class PopupEventArgs : CancelEventArgs { /// - /// Creates a new PopupEventArgs with the given parameters. + /// Creates a new PopupEventArgs with the given parameters. /// public PopupEventArgs(IWin32Window associatedWindow, Control associatedControl, bool isBalloon, Size size) { @@ -24,22 +24,22 @@ public PopupEventArgs(IWin32Window associatedWindow, Control associatedControl, } /// - /// The Associated Window for which the tooltip is being painted. + /// The Associated Window for which the tooltip is being painted. /// public IWin32Window AssociatedWindow { get; } /// - /// The control for which the tooltip is being painted. + /// The control for which the tooltip is being painted. /// public Control AssociatedControl { get; } /// - /// The rectangle outlining the area in which the painting should be done. + /// The rectangle outlining the area in which the painting should be done. /// public Size ToolTipSize { get; set; } /// - /// Whether the tooltip is Ballooned. + /// Whether the tooltip is Ballooned. /// public bool IsBalloon { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventHandler.cs index 7dfc58087ed..dd39e4672d6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PopupEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Handler for the Popup event of the ToolTip control. + /// Handler for the Popup event of the ToolTip control. /// public delegate void PopupEventHandler(object sender, PopupEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PreProcessControlState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PreProcessControlState.cs index 210554fd09b..26a91e9654d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PreProcessControlState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PreProcessControlState.cs @@ -7,18 +7,18 @@ namespace System.Windows.Forms public enum PreProcessControlState { /// - /// Indicates the message has been processed, and no further processing - /// is necessary + /// Indicates the message has been processed, and no further processing + /// is necessary /// MessageProcessed = 0x00, /// - /// Indicates the control wants the message and processing should continue + /// Indicates the control wants the message and processing should continue /// MessageNeeded = 0x01, /// - /// Indicates the control doesn't care about the message + /// Indicates the control doesn't care about the message /// MessageNotNeeded = 0x02 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventArgs.cs index 6148d2f5f28..d849e2f7ca8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the PreviewKeyDownEvent + /// Provides data for the PreviewKeyDownEvent /// public class PreviewKeyDownEventArgs : EventArgs { @@ -15,21 +15,21 @@ public PreviewKeyDownEventArgs(Keys keyData) } /// - /// Gets the key data for a - /// or event. + /// Gets the key data for a + /// or event. /// public Keys KeyData { get; } public bool Alt => (KeyData & Keys.Alt) == Keys.Alt; /// - /// Gets a value indicating whether the CTRL key was pressed. + /// Gets a value indicating whether the CTRL key was pressed. /// public bool Control => (KeyData & Keys.Control) == Keys.Control; /// - /// Gets the keyboard code for a - /// or event. + /// Gets the keyboard code for a + /// or event. /// public Keys KeyCode { @@ -46,20 +46,20 @@ public Keys KeyCode } /// - /// Gets the keyboard value for a - /// or event. + /// Gets the keyboard value for a + /// or event. /// public int KeyValue => (int)(KeyData & Keys.KeyCode); /// - /// Gets the modifier flags for a - /// or event. - /// This indicates which modifier keys (CTRL, SHIFT, and/or ALT) were pressed. + /// Gets the modifier flags for a + /// or event. + /// This indicates which modifier keys (CTRL, SHIFT, and/or ALT) were pressed. /// public Keys Modifiers => KeyData & Keys.Modifiers; /// - /// Gets a value indicating whether the SHIFT key was pressed. + /// Gets a value indicating whether the SHIFT key was pressed. /// public bool Shift => (KeyData & Keys.Shift) == Keys.Shift; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventHandler.cs index 4203387484f..5928cca1db3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PreviewKeyDownEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle PreviewKeyDown events. + /// Represents the method that will handle PreviewKeyDown events. /// public delegate void PreviewKeyDownEventHandler(object sender, PreviewKeyDownEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PageSetupDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PageSetupDialog.cs index ee0cb0e8464..4a0cbfc8bc0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PageSetupDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PageSetupDialog.cs @@ -34,7 +34,7 @@ public sealed class PageSetupDialog : CommonDialog private bool enableMetric; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public PageSetupDialog() { @@ -106,8 +106,8 @@ public bool AllowPrinter } /// - /// Gets or sets a value indicating the - /// to get page settings from. + /// Gets or sets a value indicating the + /// to get page settings from. /// [ SRCategory(nameof(SR.CatData)), diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintDialog.cs index 60d5f23ea2b..084d9a442c9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintDialog.cs @@ -36,7 +36,7 @@ public sealed class PrintDialog : CommonDialog private bool showNetwork; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public PrintDialog() { @@ -213,10 +213,10 @@ public bool ShowNetwork } /// - /// UseEXDialog = true means to use the EX versions of the dialogs and to ignore the - /// ShowHelp & ShowNetwork properties. - /// UseEXDialog = false means to never use the EX versions of the dialog. - /// ShowHelp & ShowNetwork will work in this case. + /// UseEXDialog = true means to use the EX versions of the dialogs and to ignore the + /// ShowHelp & ShowNetwork properties. + /// UseEXDialog = false means to never use the EX versions of the dialog. + /// ShowHelp & ShowNetwork will work in this case. /// [DefaultValue(false)] [SRDescription(nameof(SR.PDuseEXDialog))] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs index 7e7b1785e7d..ac6d6c8fdd3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs @@ -998,14 +998,14 @@ internal override bool ShouldSerializeForeColor() } /// - /// Gets back color respectively to the High Contrast theme is applied or not - /// and taking into account saved custom back color. + /// Gets back color respectively to the High Contrast theme is applied or not + /// and taking into account saved custom back color. /// /// Indicates whether High Contrast theme is applied or not. /// - /// Standard back color for PrintPreview control in standard theme (1), - /// contrasted color if there is High Contrast theme applied (2) and - /// custom color if this is set irrespectively to HC or not HC mode (3). + /// Standard back color for PrintPreview control in standard theme (1), + /// contrasted color if there is High Contrast theme applied (2) and + /// custom color if this is set irrespectively to HC or not HC mode (3). /// private Color GetBackColor(bool isHighContract) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewDialog.cs index 4235264643b..3081022a297 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewDialog.cs @@ -53,7 +53,7 @@ public class PrintPreviewDialog : Form readonly ImageList imageList; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public PrintPreviewDialog() { @@ -70,7 +70,7 @@ public PrintPreviewDialog() //subhag addition //------------------------------------------------------------------------------------------------------------- /// - /// Indicates the control on the form that is clicked when + /// Indicates the control on the form that is clicked when /// the user presses the ENTER key. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] @@ -1093,7 +1093,7 @@ public bool UseAntiAlias /// /// PrintPreviewDialog does not support AutoScaleBaseSize. /// - /// Keeping implementation of obsoleted AutoScaleBaseSize API + /// Keeping implementation of obsoleted AutoScaleBaseSize API #pragma warning disable 618 // disable csharp compiler warning #0809: obsolete member overrides non-obsolete member #pragma warning disable 0809 @@ -1148,8 +1148,8 @@ public PrintDocument Document } /// - /// Gets or sets a value indicating the - /// contained in this form. + /// Gets or sets a value indicating the + /// contained in this form. /// [ SRCategory(nameof(SR.CatBehavior)), diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ProfessionalColorTable.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ProfessionalColorTable.cs index 2a9517fc6e6..cd06aea4a43 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ProfessionalColorTable.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ProfessionalColorTable.cs @@ -554,9 +554,9 @@ private static Color GetAlphaBlendedColorHighRes(Graphics graphics, Color src, C private void InitCommonColors(ref Dictionary rgbTable) { - /// we need to calculate our own alpha blended color based on the Higlight and Window - /// colors on the system. Since terminalserver + alphablending doesnt work we cant just do a - /// FromARGB here. So we have a simple function which calculates the blending for us. + /// we need to calculate our own alpha blended color based on the Higlight and Window + /// colors on the system. Since terminalserver + alphablending doesnt work we cant just do a + /// FromARGB here. So we have a simple function which calculates the blending for us. if (!DisplayInformation.LowResolution) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBar.cs index 13ce2c17bde..6c14735f77a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBar.cs @@ -819,11 +819,11 @@ private void UserPreferenceChangedHandler(object o, UserPreferenceChangedEventAr } /// - /// Creates a new AccessibleObject for this ProgressBar instance. - /// The AccessibleObject instance returned by this method supports ControlType UIA property. + /// Creates a new AccessibleObject for this ProgressBar instance. + /// The AccessibleObject instance returned by this method supports ControlType UIA property. /// /// - /// AccessibleObject for this ProgressBar instance. + /// AccessibleObject for this ProgressBar instance. /// protected override AccessibleObject CreateAccessibilityInstance() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBarStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBarStyle.cs index 0a418cbfa76..2ab63a8c676 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBarStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ProgressBarStyle.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// This Enumeration represents the styles the ProgressBar can take. - /// Blocks and Continuous. + /// This Enumeration represents the styles the ProgressBar can take. + /// Blocks and Continuous. /// public enum ProgressBarStyle { /// - /// The progress bar displays the progress status as a segmented bar. + /// The progress bar displays the progress status as a segmented bar. /// Blocks, /// - /// The progress bar displays the progress status in a smooth scrolling bar. + /// The progress bar displays the progress status in a smooth scrolling bar. /// Continuous, /// - /// The progress bar displays the progress status in the marquee style. + /// The progress bar displays the progress status in the marquee style. /// Marquee } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs index 85a51d3f9c2..1c98519138d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs @@ -480,9 +480,9 @@ private bool CanUndo } /// - /// true if the commands pane will be can be made visible - /// for the currently selected objects. Objects that - /// expose verbs can show commands. + /// true if the commands pane will be can be made visible + /// for the currently selected objects. Objects that + /// expose verbs can show commands. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Advanced), SRDescription(nameof(SR.PropertyGridCanShowCommandsDesc))] @@ -495,7 +495,7 @@ public virtual bool CanShowCommands } /// - /// The text used color for category headings. The background color is determined by the LineColor property. + /// The text used color for category headings. The background color is determined by the LineColor property. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -519,7 +519,7 @@ public Color CategoryForeColor } /// - /// The background color for the hot commands region. + /// The background color for the hot commands region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -539,7 +539,7 @@ public Color CommandsBackColor } /// - /// The forground color for the hot commands region. + /// The forground color for the hot commands region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -559,7 +559,7 @@ public Color CommandsForeColor } /// - /// The link color for the hot commands region. + /// The link color for the hot commands region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -578,7 +578,7 @@ public Color CommandsLinkColor } /// - /// The active link color for the hot commands region. + /// The active link color for the hot commands region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -597,7 +597,7 @@ public Color CommandsActiveLinkColor } /// - /// The color for the hot commands region when the link is disabled. + /// The color for the hot commands region when the link is disabled. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -636,7 +636,7 @@ public Color CommandsBorderColor } /// - /// Returns true if the commands pane is currently shown. + /// Returns true if the commands pane is currently shown. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Advanced)] public virtual bool CommandsVisible @@ -648,8 +648,8 @@ public virtual bool CommandsVisible } /// - /// Returns true if the commands pane will be shown for objects - /// that expose verbs. + /// Returns true if the commands pane will be shown for objects + /// that expose verbs. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -676,10 +676,10 @@ public virtual bool CommandsVisibleIfAvailable } /// - /// Returns a default location for showing the context menu. This - /// location is the center of the active property label in the grid, and - /// is used useful to position the context menu when the menu is invoked - /// via the keyboard. + /// Returns a default location for showing the context menu. This + /// location is the center of the active property label in the grid, and + /// is used useful to position the context menu when the menu is invoked + /// via the keyboard. /// [ Browsable(false), EditorBrowsable(EditorBrowsableState.Advanced), @@ -800,7 +800,7 @@ private bool FreezePainting } /// - /// Gets the help control accessibility object. + /// Gets the help control accessibility object. /// internal AccessibleObject HelpAccessibleObject { @@ -811,7 +811,7 @@ internal AccessibleObject HelpAccessibleObject } /// - /// The background color for the help region. + /// The background color for the help region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -831,7 +831,7 @@ public Color HelpBackColor } /// - /// The forground color for the help region. + /// The forground color for the help region. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -871,7 +871,7 @@ public Color HelpBorderColor } /// - /// Sets or gets the visiblity state of the help pane. + /// Sets or gets the visiblity state of the help pane. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -897,7 +897,7 @@ public virtual bool HelpVisible } /// - /// Gets the hot commands control accessible object. + /// Gets the hot commands control accessible object. /// internal AccessibleObject HotCommandsAccessibleObject { @@ -908,7 +908,7 @@ internal AccessibleObject HotCommandsAccessibleObject } /// - /// Gets the main entry accessible object. + /// Gets the main entry accessible object. /// internal AccessibleObject GridViewAccessibleObject { @@ -919,7 +919,7 @@ internal AccessibleObject GridViewAccessibleObject } /// - /// Gets the value indicating whether the main entry is visible. + /// Gets the value indicating whether the main entry is visible. /// internal bool GridViewVisible { @@ -1103,8 +1103,8 @@ public Color LineColor } /// - /// Sets or gets the current property sort type, which can be - /// PropertySort.Categorized or PropertySort.Alphabetical. + /// Sets or gets the current property sort type, which can be + /// PropertySort.Categorized or PropertySort.Alphabetical. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -1176,9 +1176,9 @@ public PropertyTabCollection PropertyTabs } /// - /// Sets a single Object into the grid to be browsed. If multiple - /// objects are being browsed, this property will return the first - /// one in the list. If no objects are selected, null is returned. + /// Sets a single Object into the grid to be browsed. If multiple + /// objects are being browsed, this property will return the first + /// one in the list. If no objects are selected, null is returned. /// [ DefaultValue(null), @@ -1557,7 +1557,7 @@ public override ISite Site } /// - /// Gets the value indicating whether the Property grid is sorted by categories. + /// Gets the value indicating whether the Property grid is sorted by categories. /// internal bool SortedByCategories { @@ -1631,7 +1631,7 @@ public bool LargeButtons } /// - /// Gets the toolbar control accessibility object. + /// Gets the toolbar control accessibility object. /// internal AccessibleObject ToolbarAccessibleObject { @@ -1642,7 +1642,7 @@ internal AccessibleObject ToolbarAccessibleObject } /// - /// Sets or gets the visiblity state of the toolStrip. + /// Sets or gets the visiblity state of the toolStrip. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -2029,8 +2029,8 @@ internal void ClearValueCaches() } /// - /// Clears the tabs of the given scope or smaller. - /// tabScope must be PropertyTabScope.Component or PropertyTabScope.Document. + /// Clears the tabs of the given scope or smaller. + /// tabScope must be PropertyTabScope.Component or PropertyTabScope.Document. /// internal void ClearTabs(PropertyTabScope tabScope) { @@ -2046,7 +2046,7 @@ internal void ClearTabs(PropertyTabScope tabScope) #endif /// - /// Constructs the new instance of the accessibility object for current PropertyGrid control. + /// Constructs the new instance of the accessibility object for current PropertyGrid control. /// /// protected override AccessibleObject CreateAccessibilityInstance() @@ -2749,7 +2749,7 @@ internal GridEntry GetDefaultGridEntry() } /// - /// Gets the element from point. + /// Gets the element from point. /// /// The point where to search the element. /// The element found in the current point. @@ -2903,8 +2903,8 @@ private void OnActiveDesignerChanged(object sender, ActiveDesignerEventArgs e) } /// - /// Called when a property on an Ole32 Object changes. - /// See IPropertyNotifySink::OnChanged + /// Called when a property on an Ole32 Object changes. + /// See IPropertyNotifySink::OnChanged /// void UnsafeNativeMethods.IPropertyNotifySink.OnChanged(int dispID) { @@ -2945,8 +2945,8 @@ void UnsafeNativeMethods.IPropertyNotifySink.OnChanged(int dispID) } /// - /// We forward messages from several of our children - /// to our mouse move so we can put up the spliter over their borders + /// We forward messages from several of our children + /// to our mouse move so we can put up the spliter over their borders /// private void OnChildMouseMove(object sender, MouseEventArgs me) { @@ -2960,8 +2960,8 @@ private void OnChildMouseMove(object sender, MouseEventArgs me) } /// - /// We forward messages from several of our children - /// to our mouse move so we can put up the spliter over their borders + /// We forward messages from several of our children + /// to our mouse move so we can put up the spliter over their borders /// private void OnChildMouseDown(object sender, MouseEventArgs me) { @@ -3411,9 +3411,9 @@ protected override void OnMouseUp(MouseEventArgs me) } /// - /// Called when a property on an Ole32 Object that is tagged - /// with "requestedit" is about to be edited. - /// See IPropertyNotifySink::OnRequestEdit + /// Called when a property on an Ole32 Object that is tagged + /// with "requestedit" is about to be edited. + /// See IPropertyNotifySink::OnRequestEdit /// int UnsafeNativeMethods.IPropertyNotifySink.OnRequestEdit(int dispID) { @@ -3823,10 +3823,10 @@ protected override void OnVisibleChanged(EventArgs e) /* /// - /// Returns the first child control that can take focus + /// Returns the first child control that can take focus /// /// - /// Returns null if no control is able to take focus + /// Returns null if no control is able to take focus /// private Control FirstFocusableChild { get { @@ -3870,7 +3870,7 @@ private Control LastFocusableChild { */ /// - /// Returns the last child control that can take focus + /// Returns the last child control that can take focus /// protected override bool ProcessDialogKey(Keys keyData) { @@ -4090,8 +4090,8 @@ internal void RefreshProperties(bool clearCached) } /// - /// Refreshes the tabs of the given scope by deleting them and requerying objects and documents - /// for them. + /// Refreshes the tabs of the given scope by deleting them and requerying objects and documents + /// for them. /// public void RefreshTabs(PropertyTabScope tabScope) { @@ -4804,7 +4804,7 @@ protected void ShowEventsButton(bool value) } /// - /// This 16x16 Bitmap is applied to the button which orders properties alphabetically. + /// This 16x16 Bitmap is applied to the button which orders properties alphabetically. /// [ Browsable(false), @@ -4820,7 +4820,7 @@ protected virtual Bitmap SortByPropertyImage } /// - /// This 16x16 Bitmap is applied to the button which displays properties under the assigned categories. + /// This 16x16 Bitmap is applied to the button which displays properties under the assigned categories. /// [ Browsable(false), @@ -4836,7 +4836,7 @@ protected virtual Bitmap SortByCategoryImage } /// - /// This 16x16 Bitmap is applied to the button which displays property page in the designer pane. + /// This 16x16 Bitmap is applied to the button which displays property page in the designer pane. /// [ Browsable(false), @@ -5053,8 +5053,8 @@ public bool UseCompatibleTextRendering } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; @@ -5123,7 +5123,7 @@ protected override void OnSystemColorsChanged(EventArgs e) } /// - /// Rescaling constants. + /// Rescaling constants. /// private void RescaleConstants() { @@ -5134,7 +5134,7 @@ private void RescaleConstants() } /// - /// Rescale constants when DPI changed + /// Rescale constants when DPI changed /// /// old dpi /// new dpi @@ -5460,8 +5460,8 @@ public void AddTabType(Type propertyTabType, PropertyTabScope tabScope) } /// - /// Clears the tabs of the given scope or smaller. - /// tabScope must be PropertyTabScope.Component or PropertyTabScope.Document. + /// Clears the tabs of the given scope or smaller. + /// tabScope must be PropertyTabScope.Component or PropertyTabScope.Document. /// public void Clear(PropertyTabScope tabScope) { @@ -5727,8 +5727,8 @@ private static string GenerateLogFileName(ref IntPtr fileId) } /// - /// Represents the PropertyGrid accessibility object. - /// Is used only in Accessibility Improvements of level3 to show correct accessible hierarchy. + /// Represents the PropertyGrid accessibility object. + /// Is used only in Accessibility Improvements of level3 to show correct accessible hierarchy. /// [ComVisible(true)] internal class PropertyGridAccessibleObject : Control.ControlAccessibleObject @@ -5736,7 +5736,7 @@ internal class PropertyGridAccessibleObject : Control.ControlAccessibleObject private readonly PropertyGrid _owningPropertyGrid; /// - /// Initializes new instance of PropertyGridAccessibleObject + /// Initializes new instance of PropertyGridAccessibleObject /// /// The PropertyGrid owning control. public PropertyGridAccessibleObject(PropertyGrid owningPropertyGrid) : base(owningPropertyGrid) @@ -5745,15 +5745,15 @@ public PropertyGridAccessibleObject(PropertyGrid owningPropertyGrid) : base(owni } /// - /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// Return the child element at the specified point, if one exists, + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// /// x coordinate of point to check /// y coordinate of point to check /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProviderFromPoint(double x, double y) { @@ -5769,7 +5769,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProvide } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -5794,7 +5794,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Request to return the element in the specified direction regarding the provided child element. + /// Request to return the element in the specified direction regarding the provided child element. /// /// The child element regarding which the target element is searched. /// Indicates the direction in which to navigate. @@ -5830,7 +5830,7 @@ internal UnsafeNativeMethods.IRawElementProviderFragment ChildFragmentNavigate(A } /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -5841,7 +5841,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Gets the accessible child corresponding to the specified index. + /// Gets the accessible child corresponding to the specified index. /// /// The child index. /// The accessible child. @@ -5894,7 +5894,7 @@ internal AccessibleObject GetChildFragment(int index) } /// - /// Gets the number of children belonging to an accessible object. + /// Gets the number of children belonging to an accessible object. /// /// The number of children. internal int GetChildFragmentCount() @@ -5925,17 +5925,17 @@ internal int GetChildFragmentCount() } /// - /// Return the element in this fragment which has the keyboard focus, + /// Return the element in this fragment which has the keyboard focus, /// /// Return the element in this fragment which has the keyboard focus, - /// if any; otherwise return null. + /// if any; otherwise return null. internal override UnsafeNativeMethods.IRawElementProviderFragment GetFocus() { return GetFocused(); } /// - /// Gets the child control index. + /// Gets the child control index. /// /// The control accessible object which index should be found. /// The child accessible index or -1 if not found. @@ -5956,15 +5956,15 @@ internal int GetChildFragmentIndex(AccessibleObject controlAccessibleObject) } /// - /// Represents the PropertyGrid inner ToolStrip control. - /// Is used starting with Accessibility Improvements of level 3. + /// Represents the PropertyGrid inner ToolStrip control. + /// Is used starting with Accessibility Improvements of level 3. /// internal class PropertyGridToolStrip : ToolStrip { private readonly PropertyGrid _parentPropertyGrid; /// - /// Initializes new instance of PropertyGridToolStrip control. + /// Initializes new instance of PropertyGridToolStrip control. /// /// The parent PropertyGrid control. public PropertyGridToolStrip(PropertyGrid parentPropertyGrid) @@ -5973,13 +5973,13 @@ public PropertyGridToolStrip(PropertyGrid parentPropertyGrid) } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; /// - /// Constructs the new instance of the accessibility object for this control. + /// Constructs the new instance of the accessibility object for this control. /// /// The accessibility object for this control. protected override AccessibleObject CreateAccessibilityInstance() @@ -5989,7 +5989,7 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Represents the PropertyGridToolStrip control accessibility object. + /// Represents the PropertyGridToolStrip control accessibility object. /// [ComVisible(true)] internal class PropertyGridToolStripAccessibleObject : ToolStrip.ToolStripAccessibleObject @@ -5997,7 +5997,7 @@ internal class PropertyGridToolStripAccessibleObject : ToolStrip.ToolStripAccess private readonly PropertyGrid _parentPropertyGrid; /// - /// Constructs new instance of PropertyGridToolStripAccessibleObject + /// Constructs new instance of PropertyGridToolStripAccessibleObject /// /// The PropertyGridToolStrip owning control. /// The parent PropertyGrid control. @@ -6007,7 +6007,7 @@ public PropertyGridToolStripAccessibleObject(PropertyGridToolStrip owningPropert } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -6026,7 +6026,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/ArrayElementGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/ArrayElementGridEntry.cs index c9f88238092..bdffa27d32b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/ArrayElementGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/ArrayElementGridEntry.cs @@ -76,10 +76,10 @@ public override bool ShouldRenderReadOnly /* /// - /// Checks if the value of the current item can be modified by the user. + /// Checks if the value of the current item can be modified by the user. /// /// - /// True if the value can be modified + /// True if the value can be modified /// public override bool CanSetPropertyValue() { return this.ParentGridEntry.CanSetPropertyValue(); @@ -88,13 +88,13 @@ public override bool CanSetPropertyValue() { /* /// - /// Returns if it's an editable item. An example of a readonly - /// editable item is a collection property -- the property itself - /// can not be modified, but it's value (e.g. it's children) can, so - /// we don't want to draw it as readonly. + /// Returns if it's an editable item. An example of a readonly + /// editable item is a collection property -- the property itself + /// can not be modified, but it's value (e.g. it's children) can, so + /// we don't want to draw it as readonly. /// /// - /// True if the value associated with this property (e.g. it's children) can be modified even if it's readonly. + /// True if the value associated with this property (e.g. it's children) can be modified even if it's readonly. /// public override bool CanSetReadOnlyPropertyValue() { return this.ParentGridEntry.CanSetReadOnlyPropertyValue(); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/CategoryGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/CategoryGridEntry.cs index ed91622728b..2df8570a116 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/CategoryGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/CategoryGridEntry.cs @@ -58,7 +58,7 @@ public CategoryGridEntry(PropertyGrid ownerGrid, GridEntry peParent, string name } /// - /// Returns true if this GridEntry has a value field in the right hand column. + /// Returns true if this GridEntry has a value field in the right hand column. /// internal override bool HasValue { @@ -103,7 +103,7 @@ public override int PropertyDepth } /// - /// Gets the accessibility object for the current category grid entry. + /// Gets the accessibility object for the current category grid entry. /// /// protected override GridEntryAccessibleObject GetAccessibilityObject() @@ -194,8 +194,8 @@ public override Type PropertyType } /// - /// Gets the owner of the current value. This is usually the value of the - /// root entry, which is the object being browsed + /// Gets the owner of the current value. This is usually the value of the + /// root entry, which is the object being browsed /// public override object GetChildValueOwner(GridEntry childEntry) { @@ -269,7 +269,7 @@ internal override bool NotifyChildValue(GridEntry pe, int type) } /// - /// Defines the Category Grid Entry accessible object that is derived from Grid Entry accessible object. + /// Defines the Category Grid Entry accessible object that is derived from Grid Entry accessible object. /// [Runtime.InteropServices.ComVisible(true)] internal class CategoryGridEntryAccessibleObject : GridEntryAccessibleObject @@ -277,7 +277,7 @@ internal class CategoryGridEntryAccessibleObject : GridEntryAccessibleObject private readonly CategoryGridEntry _owningCategoryGridEntry; /// - /// Initializes new instance of CategoryGridEntryAccessibleObject. + /// Initializes new instance of CategoryGridEntryAccessibleObject. /// /// The owning Category Grid Entry object. public CategoryGridEntryAccessibleObject(CategoryGridEntry owningCategoryGridEntry) : base(owningCategoryGridEntry) @@ -286,7 +286,7 @@ public CategoryGridEntryAccessibleObject(CategoryGridEntry owningCategoryGridEnt } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DocComment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DocComment.cs index 75ecd0432d0..569145ea693 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DocComment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DocComment.cs @@ -140,7 +140,7 @@ protected override void OnResize(EventArgs e) } /// - /// Setting child label bounds + /// Setting child label bounds /// private void SetChildLabelsBounds() { @@ -171,7 +171,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Rescaling constants when DPi of the window changed. + /// Rescaling constants when DPi of the window changed. /// /// old dpi /// new dpi @@ -208,7 +208,7 @@ public override int SnapHeightRequest(int cyNew) } /// - /// Constructs the new instance of the accessibility object for this control. + /// Constructs the new instance of the accessibility object for this control. /// /// The accessibility object for this control. protected override AccessibleObject CreateAccessibilityInstance() @@ -217,8 +217,8 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; @@ -254,7 +254,7 @@ private void UpdateUIWithFont() } /// - /// Represents the DocComment control accessible object. + /// Represents the DocComment control accessible object. /// [Runtime.InteropServices.ComVisible(true)] internal class DocCommentAccessibleObject : Control.ControlAccessibleObject @@ -262,7 +262,7 @@ internal class DocCommentAccessibleObject : Control.ControlAccessibleObject private readonly PropertyGrid _parentPropertyGrid; /// - /// Initializes new instance of DocCommentAccessibleObject. + /// Initializes new instance of DocCommentAccessibleObject. /// /// The owning DocComment control. /// The parent PropertyGrid control. @@ -272,7 +272,7 @@ public DocCommentAccessibleObject(DocComment owningDocComment, PropertyGrid pare } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -291,7 +291,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DropDownButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DropDownButton.cs index 0d8c396bd3e..ceb222cc2e9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DropDownButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/DropDownButton.cs @@ -35,8 +35,8 @@ public bool IgnoreMouse } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; @@ -141,7 +141,7 @@ private void SetAccessibleName() } /// - /// Constructs the new instance of the accessibility object for this control. + /// Constructs the new instance of the accessibility object for this control. /// /// The accessibility object for this control. protected override AccessibleObject CreateAccessibilityInstance() @@ -233,8 +233,8 @@ internal override void DrawImageCore(Graphics graphics, Image image, Rectangle i } /// - /// Represents the accessibility object for the PropertyGrid DropDown button. - /// This DropDownButtonAccessibleObject is available in Level3 only. + /// Represents the accessibility object for the PropertyGrid DropDown button. + /// This DropDownButtonAccessibleObject is available in Level3 only. /// [Runtime.InteropServices.ComVisible(true)] internal class DropDownButtonAccessibleObject : Control.ControlAccessibleObject @@ -243,7 +243,7 @@ internal class DropDownButtonAccessibleObject : Control.ControlAccessibleObject private readonly PropertyGridView _owningPropertyGrid; /// - /// Constructs the new instance of DropDownButtonAccessibleObject. + /// Constructs the new instance of DropDownButtonAccessibleObject. /// /// public DropDownButtonAccessibleObject(DropDownButton owningDropDownButton) : base(owningDropDownButton) @@ -260,7 +260,7 @@ public override void DoDefaultAction() } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -281,7 +281,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Returns the element that is the root node of this fragment of UI. + /// Returns the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -292,7 +292,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. @@ -314,7 +314,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Indicates whether the specified pattern is supported. + /// Indicates whether the specified pattern is supported. /// /// The pattern ID. /// True if specified pattern is supported, otherwise false. @@ -329,7 +329,7 @@ internal override bool IsPatternSupported(int patternId) } /// - /// Gets the accessible role. + /// Gets the accessible role. /// public override AccessibleRole Role { @@ -340,10 +340,10 @@ public override AccessibleRole Role } /// - /// Request that focus is set to this item. - /// The UIAutomation framework will ensure that the UI hosting this fragment is already - /// focused before calling this method, so this method should only update its internal - /// focus state; it should not attempt to give its own HWND the focus, for example. + /// Request that focus is set to this item. + /// The UIAutomation framework will ensure that the UI hosting this fragment is already + /// focused before calling this method, so this method should only update its internal + /// focus state; it should not attempt to give its own HWND the focus, for example. /// internal override void SetFocus() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs index 81bc14652b6..a1fa47bcc3a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs @@ -155,7 +155,7 @@ protected GridEntry(PropertyGrid owner, GridEntry peParent) } /// - /// Outline Icon padding + /// Outline Icon padding /// private int OutlineIconPadding { @@ -199,8 +199,8 @@ protected virtual GridEntryAccessibleObject GetAccessibilityObject() } /// - /// specify that this grid entry should be allowed to be merged for. - /// multi-select. + /// specify that this grid entry should be allowed to be merged for. + /// multi-select. /// public virtual bool AllowMerge { @@ -227,9 +227,9 @@ internal virtual AttributeCollection Attributes } /// - /// Gets the value of the background brush to use. Override - /// this member to cause the entry to paint it's background in a different color. - /// The base implementation returns null. + /// Gets the value of the background brush to use. Override + /// this member to cause the entry to paint it's background in a different color. + /// The base implementation returns null. /// protected virtual Brush GetBackgroundBrush(Graphics g) { @@ -252,7 +252,7 @@ protected virtual Color LabelTextColor } /// - /// The set of attributes that will be used for browse filtering + /// The set of attributes that will be used for browse filtering /// public virtual AttributeCollection BrowsableAttributes { @@ -395,8 +395,8 @@ public virtual PropertyTab CurrentTab } /// - /// Returns the default child GridEntry of this item. Usually the default property - /// of the target object. + /// Returns the default child GridEntry of this item. Usually the default property + /// of the target object. /// internal virtual GridEntry DefaultChild { @@ -638,7 +638,7 @@ internal virtual int Flags } /// - /// Checks if the entry is currently expanded + /// Checks if the entry is currently expanded /// public bool Focus { @@ -686,8 +686,8 @@ public bool Focus } /// - /// Returns the label including the object name, and properties. For example, the value - /// of the Font size property on a Button called Button1 would be "Button1.Font.Size" + /// Returns the label including the object name, and properties. For example, the value + /// of the Font size property on a Button called Button1 would be "Button1.Font.Size" /// public string FullLabel { @@ -756,7 +756,7 @@ public override GridItemType GridItemType } /// - /// Returns true if this GridEntry has a value field in the right hand column. + /// Returns true if this GridEntry has a value field in the right hand column. /// internal virtual bool HasValue { @@ -901,7 +901,7 @@ public override PropertyDescriptor PropertyDescriptor } /// - /// Returns the pixel indent of the current GridEntry's label. + /// Returns the pixel indent of the current GridEntry's label. /// internal virtual int PropertyLabelIndent { @@ -950,8 +950,8 @@ public PropertyGrid OwnerGrid } /// - /// Returns rect that the outline icon (+ or - or arrow) will be drawn into, relative - /// to the upper left corner of the GridEntry. + /// Returns rect that the outline icon (+ or - or arrow) will be drawn into, relative + /// to the upper left corner of the GridEntry. /// public Rectangle OutlineRect { @@ -1027,7 +1027,7 @@ public override GridItem Parent } /// - /// Returns category name of the current property + /// Returns category name of the current property /// public virtual string PropertyCategory { @@ -1038,8 +1038,8 @@ public virtual string PropertyCategory } /// - /// Returns "depth" of this property. That is, how many parent's between - /// this property and the root property. The root property has a depth of -1. + /// Returns "depth" of this property. That is, how many parent's between + /// this property and the root property. The root property has a depth of -1. /// public virtual int PropertyDepth { @@ -1050,7 +1050,7 @@ public virtual int PropertyDepth } /// - /// Returns the description helpstring for this GridEntry. + /// Returns the description helpstring for this GridEntry. /// public virtual string PropertyDescription { @@ -1061,8 +1061,8 @@ public virtual string PropertyDescription } /// - /// Returns the label of this property. Usually - /// this is the property name. + /// Returns the label of this property. Usually + /// this is the property name. /// public virtual string PropertyLabel { @@ -1073,7 +1073,7 @@ public virtual string PropertyLabel } /// - /// Returns non-localized name of this property. + /// Returns non-localized name of this property. /// public virtual string PropertyName { @@ -1084,7 +1084,7 @@ public virtual string PropertyName } /// - /// Returns the Type of the value of this GridEntry, or null if the value is null. + /// Returns the Type of the value of this GridEntry, or null if the value is null. /// public virtual Type PropertyType { @@ -1103,8 +1103,8 @@ public virtual Type PropertyType } /// - /// Gets or sets the value for the property that is represented - /// by this GridEntry. + /// Gets or sets the value for the property that is represented + /// by this GridEntry. /// public virtual object PropertyValue { @@ -1138,7 +1138,7 @@ public virtual bool ShouldRenderReadOnly } /// - /// Returns the type converter for this entry. + /// Returns the type converter for this entry. /// internal virtual TypeConverter TypeConverter { @@ -1161,8 +1161,8 @@ internal virtual TypeConverter TypeConverter } /// - /// Returns the type editor for this entry. This may return null if there - /// is no type editor. + /// Returns the type editor for this entry. This may return null if there + /// is no type editor. /// internal virtual UITypeEditor UITypeEditor { @@ -1217,8 +1217,8 @@ internal int VisibleChildCount } /// - /// Add an event handler to be invoked when the label portion of - /// the prop entry is clicked + /// Add an event handler to be invoked when the label portion of + /// the prop entry is clicked /// public virtual void AddOnLabelClick(EventHandler h) { @@ -1226,8 +1226,8 @@ public virtual void AddOnLabelClick(EventHandler h) } /// - /// Add an event handler to be invoked when the label portion of - /// the prop entry is double + /// Add an event handler to be invoked when the label portion of + /// the prop entry is double /// public virtual void AddOnLabelDoubleClick(EventHandler h) { @@ -1235,8 +1235,8 @@ public virtual void AddOnLabelDoubleClick(EventHandler h) } /// - /// Add an event handler to be invoked when the value portion of - /// the prop entry is clicked + /// Add an event handler to be invoked when the value portion of + /// the prop entry is clicked /// public virtual void AddOnValueClick(EventHandler h) { @@ -1244,8 +1244,8 @@ public virtual void AddOnValueClick(EventHandler h) } /// - /// Add an event handler to be invoked when the value portion of - /// the prop entry is double-clicked + /// Add an event handler to be invoked when the value portion of + /// the prop entry is double-clicked /// public virtual void AddOnValueDoubleClick(EventHandler h) { @@ -1253,8 +1253,8 @@ public virtual void AddOnValueDoubleClick(EventHandler h) } /// - /// Add an event handler to be invoked when the outline icone portion of - /// the prop entry is clicked + /// Add an event handler to be invoked when the outline icone portion of + /// the prop entry is clicked /// public virtual void AddOnOutlineClick(EventHandler h) { @@ -1262,8 +1262,8 @@ public virtual void AddOnOutlineClick(EventHandler h) } /// - /// Add an event handler to be invoked when the outline icone portion of - /// the prop entry is double clicked + /// Add an event handler to be invoked when the outline icone portion of + /// the prop entry is double clicked /// public virtual void AddOnOutlineDoubleClick(EventHandler h) { @@ -1271,7 +1271,7 @@ public virtual void AddOnOutlineDoubleClick(EventHandler h) } /// - /// Add an event handler to be invoked when the children grid entries are re-created. + /// Add an event handler to be invoked when the children grid entries are re-created. /// public virtual void AddOnRecreateChildren(GridEntryRecreateChildrenEventHandler h) { @@ -1301,7 +1301,7 @@ internal void ClearCachedValues(bool clearChildren) } /// - /// Converts the given string of text to a value. + /// Converts the given string of text to a value. /// public object ConvertTextToValue(string text) { @@ -1313,7 +1313,7 @@ public object ConvertTextToValue(string text) } /// - /// Create the base prop entries given an object or set of objects + /// Create the base prop entries given an object or set of objects /// internal static IRootGridEntry Create(PropertyGridView view, object[] rgobjs, IServiceProvider baseProvider, IDesignerHost currentHost, PropertyTab tab, PropertySort initialSortType) { @@ -1345,7 +1345,7 @@ internal static IRootGridEntry Create(PropertyGridView view, object[] rgobjs, IS } /// - /// Populates the children of this grid entry + /// Populates the children of this grid entry /// protected virtual bool CreateChildren() { @@ -1353,7 +1353,7 @@ protected virtual bool CreateChildren() } /// - /// Populates the children of this grid entry + /// Populates the children of this grid entry /// protected virtual bool CreateChildren(bool diffOldChildren) { @@ -1466,7 +1466,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Disposes the array of children + /// Disposes the array of children /// public virtual void DisposeChildren() { @@ -1483,7 +1483,7 @@ public virtual void DisposeChildren() } /// - /// Invokes the type editor for editing this item. + /// Invokes the type editor for editing this item. /// internal virtual void EditPropertyValue(PropertyGridView iva) { @@ -1543,7 +1543,7 @@ internal virtual void EditPropertyValue(PropertyGridView iva) } /// - /// Tests two GridEntries for equality + /// Tests two GridEntries for equality /// public override bool Equals(object obj) { @@ -1555,7 +1555,7 @@ public override bool Equals(object obj) } /// - /// Searches for a value of a given property for a value editor user + /// Searches for a value of a given property for a value editor user /// public virtual object FindPropertyValue(string propertyName, Type propertyType) { @@ -1575,7 +1575,7 @@ public virtual object FindPropertyValue(string propertyName, Type propertyType) } /// - /// Returns the index of a child GridEntry + /// Returns the index of a child GridEntry /// internal virtual int GetChildIndex(GridEntry pe) { @@ -1583,9 +1583,9 @@ internal virtual int GetChildIndex(GridEntry pe) } /// - /// Gets the components that own the current value. This is usually the value of the - /// root entry, which is the object being browsed. Walks up the GridEntry tree - /// looking for an owner that is an IComponent + /// Gets the components that own the current value. This is usually the value of the + /// root entry, which is the object being browsed. Walks up the GridEntry tree + /// looking for an owner that is an IComponent /// public virtual IComponent[] GetComponents() { @@ -1649,8 +1649,8 @@ internal bool GetMultipleLines(string valueString) } } /// - /// Gets the owner of the current value. This is usually the value of the - /// root entry, which is the object being browsed + /// Gets the owner of the current value. This is usually the value of the + /// root entry, which is the object being browsed /// public virtual object GetValueOwner() { @@ -1663,8 +1663,8 @@ public virtual object GetValueOwner() } /// - /// Gets the owners of the current value. This is usually the value of the - /// root entry, which is the objects being browsed for a multiselect item + /// Gets the owners of the current value. This is usually the value of the + /// root entry, which is the objects being browsed for a multiselect item /// public virtual object[] GetValueOwners() { @@ -1677,8 +1677,8 @@ public virtual object[] GetValueOwners() } /// - /// Gets the owner of the current value. This is usually the value of the - /// root entry, which is the object being browsed + /// Gets the owner of the current value. This is usually the value of the + /// root entry, which is the object being browsed /// public virtual object GetChildValueOwner(GridEntry childEntry) { @@ -1695,7 +1695,7 @@ public virtual object GetChildValueOwner(GridEntry childEntry) } /// - /// Returns a string with info about the currently selected GridEntry + /// Returns a string with info about the currently selected GridEntry /// public virtual string GetTestingInfo() { @@ -1722,7 +1722,7 @@ public virtual string GetTestingInfo() } /// - /// Retrieves the type of the value for this GridEntry + /// Retrieves the type of the value for this GridEntry /// public virtual Type GetValueType() { @@ -1730,7 +1730,7 @@ public virtual Type GetValueType() } /// - /// Returns the child GridEntries for this item. + /// Returns the child GridEntries for this item. /// protected virtual GridEntry[] GetPropEntries(GridEntry peParent, object obj, Type objType) { @@ -1908,7 +1908,7 @@ protected virtual GridEntry[] GetPropEntries(GridEntry peParent, object obj, Typ } /// - /// Resets the current item + /// Resets the current item /// public virtual void ResetPropertyValue() { @@ -1918,10 +1918,10 @@ public virtual void ResetPropertyValue() /* /// - /// Checks if the value of the current item can be modified by the user. + /// Checks if the value of the current item can be modified by the user. /// /// - /// True if the value can be modified + /// True if the value can be modified /// public virtual bool CanSetPropertyValue() { return 0 != (Flags & (GridEntry.FLAG_DROPDOWN_EDITABLE | GridEntry.FLAG_TEXT_EDITABLE | GridEntry.FLAG_CUSTOM_EDITABLE | GridEntry.FLAG_ENUMERABLE)); @@ -1930,13 +1930,13 @@ public virtual bool CanSetPropertyValue() { /* /// - /// Returns if it's an editable item. An example of a readonly - /// editable item is a collection property -- the property itself - /// can not be modified, but it's value (e.g. it's children) can, so - /// we don't want to draw it as readonly. + /// Returns if it's an editable item. An example of a readonly + /// editable item is a collection property -- the property itself + /// can not be modified, but it's value (e.g. it's children) can, so + /// we don't want to draw it as readonly. /// /// - /// True if the value associated with this property (e.g. it's children) can be modified even if it's readonly. + /// True if the value associated with this property (e.g. it's children) can be modified even if it's readonly. /// public virtual bool CanSetReadOnlyPropertyValue() { return GetFlagSet(GridEntry.FLAG_READONLY_EDITABLE); @@ -1944,7 +1944,7 @@ public virtual bool CanSetReadOnlyPropertyValue() { */ /// - /// Returns if the property can be reset + /// Returns if the property can be reset /// public virtual bool CanResetPropertyValue() { @@ -1952,7 +1952,7 @@ public virtual bool CanResetPropertyValue() } /// - /// Called when the item is double clicked. + /// Called when the item is double clicked. /// public virtual bool DoubleClickPropertyValue() { @@ -1960,7 +1960,7 @@ public virtual bool DoubleClickPropertyValue() } /// - /// Returns the text value of this property. + /// Returns the text value of this property. /// public virtual string GetPropertyTextValue() { @@ -1968,7 +1968,7 @@ public virtual string GetPropertyTextValue() } /// - /// Returns the text value of this property. + /// Returns the text value of this property. /// public virtual string GetPropertyTextValue(object value) { @@ -1992,7 +1992,7 @@ public virtual string GetPropertyTextValue(object value) } /// - /// Returns the text values of this property. + /// Returns the text values of this property. /// public virtual object[] GetPropertyValueList() { @@ -2009,7 +2009,7 @@ public virtual object[] GetPropertyValueList() public override int GetHashCode() => HashCode.Combine(PropertyLabel, PropertyType, GetType()); /// - /// Checks if a given flag is set + /// Checks if a given flag is set /// protected virtual bool GetFlagSet(int flag) { @@ -2083,9 +2083,9 @@ internal virtual bool NonParentEquals(object obj) } /// - /// Paints the label portion of this GridEntry into the given Graphics object. This - /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is - /// to be painted. + /// Paints the label portion of this GridEntry into the given Graphics object. This + /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is + /// to be painted. /// public virtual void PaintLabel(Graphics g, Rectangle rect, Rectangle clipRect, bool selected, bool paintFullLabel) { @@ -2204,9 +2204,9 @@ public virtual void PaintLabel(Graphics g, Rectangle rect, Rectangle clipRect, b } /// - /// Paints the outline portion of this GridEntry into the given Graphics object. This - /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is - /// to be painted. + /// Paints the outline portion of this GridEntry into the given Graphics object. This + /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is + /// to be painted. /// public virtual void PaintOutline(Graphics g, Rectangle r) { @@ -2345,9 +2345,9 @@ private void PaintOutlineWithClassicStyle(Graphics g, Rectangle r) } /// - /// Paints the value portion of this GridEntry into the given Graphics object. This - /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is - /// to be painted. + /// Paints the value portion of this GridEntry into the given Graphics object. This + /// is called by the GridEntry host (the PropertyGridView) when this GridEntry is + /// to be painted. /// public virtual void PaintValue(object val, Graphics g, Rectangle rect, Rectangle clipRect, PaintValueFlags paintFlags) { @@ -2564,9 +2564,9 @@ public virtual void OnComponentChanged() } /// - /// Called when the label portion of this GridEntry is clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnLabelClick(e) if this is overrideen. + /// Called when the label portion of this GridEntry is clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnLabelClick(e) if this is overrideen. /// protected virtual void OnLabelClick(EventArgs e) { @@ -2574,9 +2574,9 @@ protected virtual void OnLabelClick(EventArgs e) } /// - /// Called when the label portion of this GridEntry is double-clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnLabelDoubleClick(e) if this is overrideen. + /// Called when the label portion of this GridEntry is double-clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnLabelDoubleClick(e) if this is overrideen. /// protected virtual void OnLabelDoubleClick(EventArgs e) { @@ -2584,7 +2584,7 @@ protected virtual void OnLabelDoubleClick(EventArgs e) } /// - /// Called when the GridEntry is clicked. + /// Called when the GridEntry is clicked. /// public virtual bool OnMouseClick(int x, int y, int count, MouseButtons button) { @@ -2651,9 +2651,9 @@ public virtual bool OnMouseClick(int x, int y, int count, MouseButtons button) } /// - /// Called when the outline icon portion of this GridEntry is clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnOutlineClick(e) if this is overrideen. + /// Called when the outline icon portion of this GridEntry is clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnOutlineClick(e) if this is overrideen. /// protected virtual void OnOutlineClick(EventArgs e) { @@ -2661,9 +2661,9 @@ protected virtual void OnOutlineClick(EventArgs e) } /// - /// Called when the outline icon portion of this GridEntry is double-clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnOutlineDoubleClick(e) if this is overrideen. + /// Called when the outline icon portion of this GridEntry is double-clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnOutlineDoubleClick(e) if this is overrideen. /// protected virtual void OnOutlineDoubleClick(EventArgs e) { @@ -2671,9 +2671,9 @@ protected virtual void OnOutlineDoubleClick(EventArgs e) } /// - /// Called when RecreateChildren is called. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnOutlineDoubleClick(e) if this is overrideen. + /// Called when RecreateChildren is called. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnOutlineDoubleClick(e) if this is overrideen. /// protected virtual void OnRecreateChildren(GridEntryRecreateChildrenEventArgs e) { @@ -2685,9 +2685,9 @@ protected virtual void OnRecreateChildren(GridEntryRecreateChildrenEventArgs e) } /// - /// Called when the value portion of this GridEntry is clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnValueClick(e) if this is overrideen. + /// Called when the value portion of this GridEntry is clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnValueClick(e) if this is overrideen. /// protected virtual void OnValueClick(EventArgs e) { @@ -2695,9 +2695,9 @@ protected virtual void OnValueClick(EventArgs e) } /// - /// Called when the value portion of this GridEntry is clicked. - /// Default implmentation fired the event to any listeners, so be sure - /// to call base.OnValueDoubleClick(e) if this is overrideen. + /// Called when the value portion of this GridEntry is clicked. + /// Default implmentation fired the event to any listeners, so be sure + /// to call base.OnValueDoubleClick(e) if this is overrideen. /// protected virtual void OnValueDoubleClick(EventArgs e) { @@ -2710,7 +2710,7 @@ internal bool OnValueReturnKey() } /// - /// Sets the specified flag + /// Sets the specified flag /// protected virtual void SetFlag(int flag, bool fVal) { @@ -2718,7 +2718,7 @@ protected virtual void SetFlag(int flag, bool fVal) } /// - /// Sets the default child of this entry, given a valid value mask. + /// Sets the default child of this entry, given a valid value mask. /// protected virtual void SetFlag(int flag_valid, int flag, bool fVal) { @@ -2727,7 +2727,7 @@ protected virtual void SetFlag(int flag_valid, int flag, bool fVal) } /// - /// Sets the value of a flag + /// Sets the value of a flag /// protected virtual void SetFlag(int flag, int val) { @@ -2753,7 +2753,7 @@ public override bool Select() } /// - /// Checks if this value should be persisited. + /// Checks if this value should be persisited. /// internal virtual bool ShouldSerializePropertyValue() { @@ -2815,7 +2815,7 @@ private PropertyDescriptor[] SortParenProperties(PropertyDescriptor[] props) } /// - /// Sends a notify message to this GridEntry, and returns the success result + /// Sends a notify message to this GridEntry, and returns the success result /// internal virtual bool NotifyValueGivenParent(object obj, int type) { @@ -2823,7 +2823,7 @@ internal virtual bool NotifyValueGivenParent(object obj, int type) } /// - /// Sends a notify message to the child GridEntry, and returns the success result + /// Sends a notify message to the child GridEntry, and returns the success result /// internal virtual bool NotifyChildValue(GridEntry pe, int type) { @@ -2874,7 +2874,7 @@ internal void RecreateChildren(int oldCount) } /// - /// Refresh the current GridEntry's value and it's children + /// Refresh the current GridEntry's value and it's children /// public virtual void Refresh() { @@ -2965,7 +2965,7 @@ protected void ResetState() } /// - /// Sets the value of this GridEntry from text + /// Sets the value of this GridEntry from text /// public virtual bool SetPropertyTextValue(string str) { @@ -3140,7 +3140,7 @@ public override string Help } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -3173,7 +3173,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/HotCommands.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/HotCommands.cs index a0bef2902be..40c997aef9f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/HotCommands.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/HotCommands.cs @@ -45,7 +45,7 @@ public virtual bool AllowVisible } /// - /// Constructs the new instance of the accessibility object for this control. + /// Constructs the new instance of the accessibility object for this control. /// /// The accessibility object for this control. protected override AccessibleObject CreateAccessibilityInstance() @@ -111,8 +111,8 @@ public override int SnapHeightRequest(int request) } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; @@ -249,7 +249,7 @@ private void SetupLabel() } /// - /// Represents the hot commands control accessible object. + /// Represents the hot commands control accessible object. /// [Runtime.InteropServices.ComVisible(true)] internal class HotCommandsAccessibleObject : Control.ControlAccessibleObject @@ -257,7 +257,7 @@ internal class HotCommandsAccessibleObject : Control.ControlAccessibleObject private readonly PropertyGrid _parentPropertyGrid; /// - /// Initializes new instance of DocCommentAccessibleObject. + /// Initializes new instance of DocCommentAccessibleObject. /// /// The owning HotCommands control. /// The parent PropertyGrid control. @@ -267,7 +267,7 @@ public HotCommandsAccessibleObject(HotCommands owningHotCommands, PropertyGrid p } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -286,7 +286,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MergePropertyDescriptor.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MergePropertyDescriptor.cs index 84233f13d82..e5891565f8c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MergePropertyDescriptor.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MergePropertyDescriptor.cs @@ -513,8 +513,8 @@ public IEnumerator GetEnumerator() } /// - /// Ensures that the new collection equals the exisitng one. - /// Otherwise, it wipes out the contents of the new collection. + /// Ensures that the new collection equals the exisitng one. + /// Otherwise, it wipes out the contents of the new collection. /// public bool MergeCollection(ICollection newCollection) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiPropertyDescriptorGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiPropertyDescriptorGridEntry.cs index 395b6ce5109..7275c48c236 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiPropertyDescriptorGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiPropertyDescriptorGridEntry.cs @@ -159,7 +159,7 @@ public override IComponent[] GetComponents() } /// - /// Returns the text value of this property. + /// Returns the text value of this property. /// public override string GetPropertyTextValue(object value) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiSelectRootGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiSelectRootGridEntry.cs index dcf56c68f53..c9075e075b3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiSelectRootGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/MultiSelectRootGridEntry.cs @@ -294,9 +294,9 @@ private static MultiPropertyDescriptorGridEntry[] SortParenEntries(MultiProperty } /// - /// merges an unsorted array of grid entries with a sorted array of grid entries that - /// have already been merged. The resulting array is the intersection of entries between the two, - /// but in the order of baseEntries. + /// merges an unsorted array of grid entries with a sorted array of grid entries that + /// have already been merged. The resulting array is the intersection of entries between the two, + /// but in the order of baseEntries. /// private static ArrayList UnsortedMerge(PropertyDescriptor[] baseEntries, ArrayList sortedMergedEntries) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyDescriptorGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyDescriptorGridEntry.cs index 8742fc2c298..e70c21bc5a6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyDescriptorGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyDescriptorGridEntry.cs @@ -58,8 +58,8 @@ internal PropertyDescriptorGridEntry(PropertyGrid ownerGrid, GridEntry peParent, } /// - /// specify that this grid entry should be allowed to be merged for. - /// multi-select. + /// specify that this grid entry should be allowed to be merged for. + /// multi-select. /// public override bool AllowMerge { @@ -291,7 +291,7 @@ public override string PropertyLabel } /// - /// Returns non-localized name of this property. + /// Returns non-localized name of this property. /// public override string PropertyName { @@ -314,8 +314,8 @@ public override Type PropertyType } /// - /// Gets or sets the value for the property that is represented - /// by this GridEntry. + /// Gets or sets the value for the property that is represented + /// by this GridEntry. /// public override object PropertyValue { @@ -405,7 +405,7 @@ public override bool ShouldRenderReadOnly } /// - /// Returns the type converter for this entry. + /// Returns the type converter for this entry. /// internal override TypeConverter TypeConverter { @@ -425,8 +425,8 @@ internal override TypeConverter TypeConverter } /// - /// Returns the type editor for this entry. This may return null if there - /// is no type editor. + /// Returns the type editor for this entry. This may return null if there + /// is no type editor. /// internal override UITypeEditor UITypeEditor { @@ -444,7 +444,7 @@ internal override UITypeEditor UITypeEditor } /// - /// Invokes the type editor for editing this item. + /// Invokes the type editor for editing this item. /// internal override void EditPropertyValue(PropertyGridView iva) { @@ -1127,11 +1127,11 @@ static private void ShowCodeIdle(object sender, EventArgs e) } /// - /// Creates a new AccessibleObject for this PropertyDescriptorGridEntry instance. - /// The AccessibleObject instance returned by this method supports IsEnabled UIA property. + /// Creates a new AccessibleObject for this PropertyDescriptorGridEntry instance. + /// The AccessibleObject instance returned by this method supports IsEnabled UIA property. /// /// - /// AccessibleObject for this PropertyDescriptorGridEntry instance. + /// AccessibleObject for this PropertyDescriptorGridEntry instance. /// protected override GridEntryAccessibleObject GetAccessibilityObject() { @@ -1151,7 +1151,7 @@ public PropertyDescriptorGridEntryAccessibleObject(PropertyDescriptorGridEntry o internal override bool IsIAccessibleExSupported() => true; /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyGridView.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyGridView.cs index 0149bb9e95f..b69df92cb55 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyGridView.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyGridView.cs @@ -380,7 +380,7 @@ private GridViewEdit Edit } /// - /// Represents the Editor's control accessible object. + /// Represents the Editor's control accessible object. /// internal AccessibleObject EditAccessibleObject { @@ -421,7 +421,7 @@ private GridViewListBox DropDownListBox } /// - /// Represents the DropDownListBox accessible object. + /// Represents the DropDownListBox accessible object. /// internal AccessibleObject DropDownListBoxAccessibleObject { @@ -598,10 +598,10 @@ protected int RowHeight } /// - /// Returns a default location for showing the context menu. This - /// location is the center of the active property label in the grid, and - /// is used useful to position the context menu when the menu is invoked - /// via the keyboard. + /// Returns a default location for showing the context menu. This + /// location is the center of the active property label in the grid, and + /// is used useful to position the context menu when the menu is invoked + /// via the keyboard. /// public Point ContextMenuDefaultLocation { @@ -681,10 +681,10 @@ public PropertyDescriptor SelectedPropertyDescriptor { /* /// - /// Returns the currently selected property name. - /// If no property or a category name is selected, "" is returned. - /// If the category is a sub property, it is concatenated onto its - /// parent property name with a ".". + /// Returns the currently selected property name. + /// If no property or a category name is selected, "" is returned. + /// If the category is a sub property, it is concatenated onto its + /// parent property name with a ".". /// public string SelectedPropertyName { get { @@ -754,8 +754,8 @@ public string SelectedPropertyName { */ /// - /// Returns or sets the IServiceProvider the PropertyGridView will use to obtain - /// services. This may be null. + /// Returns or sets the IServiceProvider the PropertyGridView will use to obtain + /// services. This may be null. /// public IServiceProvider ServiceProvider { @@ -782,8 +782,8 @@ public IServiceProvider ServiceProvider } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces. /// internal override bool SupportsUiaProviders => true; @@ -844,7 +844,7 @@ private GridToolTip ToolTip } /// - /// Gets the top level grid entries. + /// Gets the top level grid entries. /// internal GridEntryCollection TopLevelGridEntries { @@ -1703,7 +1703,7 @@ internal IntPtr GetBaseHfont() } /// - /// Gets the element from point. + /// Gets the element from point. /// /// The point x coordinate. /// The point y coordinate. @@ -2297,8 +2297,8 @@ public virtual int GetScrollOffset() } /// - /// returns an array of IPE specifying the current heirarchy of ipes from the given - /// gridEntry through its parents to the root. + /// returns an array of IPE specifying the current heirarchy of ipes from the given + /// gridEntry through its parents to the root. /// private GridEntryCollection GetGridEntryHierarchy(GridEntry gridEntry) { @@ -2487,9 +2487,9 @@ protected virtual bool GetScrollbarHidden() } /// - /// Returns a string containing test info about a given GridEntry. Requires an offset into the top-level - /// entry collection (ie. nested entries are not accessible). Or specify -1 to get info for the current - /// selected entry (which can be any entry, top-level or nested). + /// Returns a string containing test info about a given GridEntry. Requires an offset into the top-level + /// entry collection (ie. nested entries are not accessible). Or specify -1 to get info for the current + /// selected entry (which can be any entry, top-level or nested). /// public virtual string GetTestingInfo(int entry) { @@ -6238,7 +6238,7 @@ protected override void WndProc(ref Message m) } /// - /// rescale constants for the DPI change + /// rescale constants for the DPI change /// /// /// @@ -6249,7 +6249,7 @@ protected override void RescaleConstantsForDpi(int deviceDpiOld, int deviceDpiNe } /// - /// Rescale constants on this object + /// Rescale constants on this object /// private void RescaleConstants() { @@ -6274,7 +6274,7 @@ private void RescaleConstants() } /// - /// private method to recursively reset outlinerect for grid entries ( both visible and invisible) + /// private method to recursively reset outlinerect for grid entries ( both visible and invisible) /// private void ResetOutline(GridEntry entry) { @@ -6387,9 +6387,9 @@ public virtual bool HookMouseDown } /// - /// This gets set to true if there isn't enough space below the currently selected - /// row for the drop down, so it appears above the row. In this case, we make the resize - /// grip appear at the top left. + /// This gets set to true if there isn't enough space below the currently selected + /// row for the drop down, so it appears above the row. In this case, we make the resize + /// grip appear at the top left. /// public bool ResizeUp { @@ -6460,9 +6460,9 @@ public virtual Control Component } /// - /// Get an InstanceCreationEditor for this entry. First, we look on the property type, and if we - /// don't find that we'll go up to the editor type itself. That way people can associate the InstanceCreationEditor with - /// the type of DropDown UIType Editor. + /// Get an InstanceCreationEditor for this entry. First, we look on the property type, and if we + /// don't find that we'll go up to the editor type itself. That way people can associate the InstanceCreationEditor with + /// the type of DropDown UIType Editor. /// /// private InstanceCreationEditor GetInstanceCreationEditor(PropertyDescriptorGridEntry entry) @@ -6497,9 +6497,9 @@ private InstanceCreationEditor GetInstanceCreationEditor(PropertyDescriptorGridE } /// - /// Get a glyph for sizing the lower left hand grip. The code in ControlPaint only does lower-right glyphs - /// so we do some GDI+ magic to take that glyph and mirror it. That way we can still share the code (in case it changes for theming, etc), - /// not have any special cases, and possibly solve world hunger. + /// Get a glyph for sizing the lower left hand grip. The code in ControlPaint only does lower-right glyphs + /// so we do some GDI+ magic to take that glyph and mirror it. That way we can still share the code (in case it changes for theming, etc), + /// not have any special cases, and possibly solve world hunger. /// private Bitmap GetSizeGripGlyph(Graphics g) { @@ -6652,7 +6652,7 @@ private void OnNewLinkClicked(object sender, LinkLabelLinkClickedEventArgs e) } /// - /// Just figure out what kind of sizing we would do at a given drag location. + /// Just figure out what kind of sizing we would do at a given drag location. /// private int MoveTypeFromPoint(int x, int y) { @@ -6679,7 +6679,7 @@ private int MoveTypeFromPoint(int x, int y) } /// - /// Decide if we're going to be sizing at the given point, and if so, Capture and safe our current state. + /// Decide if we're going to be sizing at the given point, and if so, Capture and safe our current state. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -6701,7 +6701,7 @@ protected override void OnMouseDown(MouseEventArgs e) } /// - /// Either set the cursor or do a move, depending on what our currentMoveType is/ + /// Either set the cursor or do a move, depending on what our currentMoveType is/ /// protected override void OnMouseMove(MouseEventArgs e) { @@ -6810,7 +6810,7 @@ protected override void OnMouseUp(MouseEventArgs e) } /// - /// Just paint and draw our glyph. + /// Just paint and draw our glyph. /// protected override void OnPaint(PaintEventArgs pe) { @@ -7048,7 +7048,7 @@ protected override CreateParams CreateParams } /// - /// Gets the owning PropertyGridView. + /// Gets the owning PropertyGridView. /// internal PropertyGridView OwningPropertyGridView { @@ -7059,13 +7059,13 @@ internal PropertyGridView OwningPropertyGridView } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces /// internal override bool SupportsUiaProviders => true; /// - /// Constructs the new instance of the accessibility object for this control. + /// Constructs the new instance of the accessibility object for this control. /// /// The accessibility object instance. protected override AccessibleObject CreateAccessibilityInstance() @@ -7107,7 +7107,7 @@ public GridViewListBoxItemAccessibleObject(GridViewListBox owningGridViewListBox } /// - /// Gets the DropDown button bounds. + /// Gets the DropDown button bounds. /// public override Rectangle Bounds { @@ -7120,7 +7120,7 @@ public override Rectangle Bounds } /// - /// Gets the DropDown button default action. + /// Gets the DropDown button default action. /// public override string DefaultAction { @@ -7218,7 +7218,7 @@ internal override object GetPropertyValue(int propertyID) } /// - /// Gets the help text. + /// Gets the help text. /// public override string Help { @@ -7230,7 +7230,7 @@ public override string Help } /// - /// Gets the keyboard shortcut. + /// Gets the keyboard shortcut. /// public override string KeyboardShortcut { @@ -7242,7 +7242,7 @@ public override string KeyboardShortcut } /// - /// Indicates whether specified pattern is supported. + /// Indicates whether specified pattern is supported. /// /// The pattern ID. /// True if specified @@ -7258,7 +7258,7 @@ internal override bool IsPatternSupported(int patternId) } /// - /// Gets or sets the accessible name. + /// Gets or sets the accessible name. /// public override string Name { @@ -7279,7 +7279,7 @@ public override string Name } /// - /// Gets the accessible role. + /// Gets the accessible role. /// public override AccessibleRole Role { @@ -7291,7 +7291,7 @@ public override AccessibleRole Role } /// - /// Gets the runtime ID. + /// Gets the runtime ID. /// internal override int[] RuntimeId { @@ -7307,7 +7307,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible state. + /// Gets the accessible state. /// public override AccessibleStates State { @@ -7356,7 +7356,7 @@ public override object this[object key] } /// - /// Represents the PropertyGridView ListBox accessibility object. + /// Represents the PropertyGridView ListBox accessibility object. /// [ComVisible(true)] private class GridViewListBoxAccessibleObject : ControlAccessibleObject @@ -7366,7 +7366,7 @@ private class GridViewListBoxAccessibleObject : ControlAccessibleObject private readonly GridViewListBoxItemAccessibleObjectCollection _itemAccessibleObjects; /// - /// Constructs the new instance of GridViewListBoxAccessibleObject. + /// Constructs the new instance of GridViewListBoxAccessibleObject. /// /// The owning GridViewListBox. public GridViewListBoxAccessibleObject(GridViewListBox owningGridViewListBox) : base(owningGridViewListBox) @@ -7377,7 +7377,7 @@ public GridViewListBoxAccessibleObject(GridViewListBox owningGridViewListBox) : } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -7408,7 +7408,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -7435,7 +7435,7 @@ public int GetChildFragmentCount() } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. @@ -7503,8 +7503,8 @@ public virtual bool Filter } /// - /// Indicates whether or not the control supports UIA Providers via - /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces + /// Indicates whether or not the control supports UIA Providers via + /// IRawElementProviderFragment/IRawElementProviderFragmentRoot interfaces /// internal override bool SupportsUiaProviders => true; @@ -7566,11 +7566,11 @@ public GridViewEdit(PropertyGridView psheet) } /// - /// Creates a new AccessibleObject for this GridViewEdit instance. - /// The AccessibleObject instance returned by this method overrides several UIA properties. + /// Creates a new AccessibleObject for this GridViewEdit instance. + /// The AccessibleObject instance returned by this method overrides several UIA properties. /// /// - /// AccessibleObject for this GridViewEdit instance. + /// AccessibleObject for this GridViewEdit instance. /// protected override AccessibleObject CreateAccessibilityInstance() { @@ -7950,7 +7950,7 @@ public override AccessibleStates State internal override bool IsIAccessibleExSupported() => true; /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -7976,7 +7976,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -8352,15 +8352,15 @@ public PropertyGridViewAccessibleObject(PropertyGridView owner, PropertyGrid par } /// - /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// Return the child element at the specified point, if one exists, + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// /// x coordinate of point to check /// y coordinate of point to check /// Return the child element at the specified point, if one exists, - /// otherwise return this element if the point is on this element, - /// otherwise return null. + /// otherwise return this element if the point is on this element, + /// otherwise return null. /// internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProviderFromPoint(double x, double y) { @@ -8368,7 +8368,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment ElementProvide } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -8414,7 +8414,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -8425,7 +8425,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Gets the accessible object for the currently focused grid entry. + /// Gets the accessible object for the currently focused grid entry. /// /// The accessible object for the currently focused grid entry. internal override UnsafeNativeMethods.IRawElementProviderFragment GetFocus() @@ -8434,7 +8434,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment GetFocus() } /// - /// Request value of specified property from an element. + /// Request value of specified property from an element. /// /// Identifier indicating the property to return /// Returns a ValInfo indicating whether the element supports this property, or has no value for it. @@ -8525,7 +8525,7 @@ internal AccessibleObject GetLastCategory() } /// - /// Gets the previous grid entry accessibility object. + /// Gets the previous grid entry accessibility object. /// /// The current grid entry. /// The grid entry collection. @@ -8576,7 +8576,7 @@ internal AccessibleObject GetPreviousGridEntry(GridEntry currentGridEntry, GridE } /// - /// Gets the next grid entry. + /// Gets the next grid entry. /// /// The current grid entry. /// The grid entry collection. @@ -8619,7 +8619,7 @@ internal AccessibleObject GetNextGridEntry(GridEntry currentGridEntry, GridEntry } /// - /// Gets the first child property. + /// Gets the first child property. /// /// The current grid entry. /// The first child property. @@ -8648,7 +8648,7 @@ internal AccessibleObject GetFirstChildProperty(CategoryGridEntry current) } /// - /// Gets the last child property. + /// Gets the last child property. /// /// The current grid entry. /// The last child property. @@ -8677,7 +8677,7 @@ internal AccessibleObject GetLastChildProperty(CategoryGridEntry current) } /// - /// Gets the next category. + /// Gets the next category. /// /// The current grid entry. /// The next category. @@ -8712,7 +8712,7 @@ public AccessibleObject Previous(GridEntry current) } /// - /// Gets the previous category. + /// Gets the previous category. /// /// The current grid entry. /// The previous category. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/SingleSelectRootGridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/SingleSelectRootGridEntry.cs index ea632737ed6..33b830c9491 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/SingleSelectRootGridEntry.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/SingleSelectRootGridEntry.cs @@ -45,7 +45,7 @@ internal SingleSelectRootGridEntry(PropertyGridView view, object value, IService } /// - /// The set of attributes that will be used for browse filtering + /// The set of attributes that will be used for browse filtering /// public override AttributeCollection BrowsableAttributes { @@ -238,8 +238,8 @@ public override string PropertyLabel } /// - /// Gets or sets the value for the property that is represented - /// by this GridEntry. + /// Gets or sets the value for the property that is represented + /// by this GridEntry. /// public override object PropertyValue { @@ -295,7 +295,7 @@ public override object GetService(Type serviceType) } /// - /// Reset the Browsable attributes to the default (BrowsableAttribute.Yes) + /// Reset the Browsable attributes to the default (BrowsableAttribute.Yes) /// public void ResetBrowsableAttributes() { @@ -303,7 +303,7 @@ public void ResetBrowsableAttributes() } /// - /// Sets the value of this GridEntry from text + /// Sets the value of this GridEntry from text /// public virtual void ShowCategories(bool fCategories) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyManager.cs index 619ef4932b9..81ea6810646 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyManager.cs @@ -156,7 +156,7 @@ internal protected override void OnCurrentItemChanged(EventArgs ea) internal override bool IsBinding => _dataSource != null; /// - /// no op on the propertyManager + /// no op on the propertyManager /// public override int Position { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertySort.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertySort.cs index 5591f8ed018..9ce47032f35 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertySort.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertySort.cs @@ -7,31 +7,31 @@ namespace System.Windows.Forms { /// - /// Possible values for property grid sorting mode + /// Possible values for property grid sorting mode /// [ComVisible(true)] public enum PropertySort { /// - /// Properties will not be sorted, rather they will be displayed in the - /// order that they are retrieved from the TypeDescriptor. + /// Properties will not be sorted, rather they will be displayed in the + /// order that they are retrieved from the TypeDescriptor. /// NoSort = 0, /// - /// Properties are sorted as a flat, alphabetical list. + /// Properties are sorted as a flat, alphabetical list. /// Alphabetical = 1, /// - /// Properties are under category groups, which are defined by the - /// properties themselves. + /// Properties are under category groups, which are defined by the + /// properties themselves. /// Categorized = 2, /// - /// Properties are under category groups, which are defined by the - /// properties themselves, and are alphabetical within those groups. + /// Properties are under category groups, which are defined by the + /// properties themselves, and are alphabetical within those groups. /// CategorizedAlphabetical = Alphabetical | Categorized, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyStore.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyStore.cs index 7b820a49c7a..5658bbd2ac7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyStore.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyStore.cs @@ -8,9 +8,9 @@ namespace System.Windows.Forms { /// - /// This is a small class that can efficiently store property values. - /// It tries to optimize for size first, "get" access second, and - /// "set" access third. + /// This is a small class that can efficiently store property values. + /// It tries to optimize for size first, "get" access second, and + /// "set" access third. /// internal class PropertyStore { @@ -20,9 +20,9 @@ internal class PropertyStore private ObjectEntry[] s_objEntries; /// - /// Retrieves an integer value from our property list. - /// This will set value to zero and return false if the - /// list does not contain the given key. + /// Retrieves an integer value from our property list. + /// This will set value to zero and return false if the + /// list does not contain the given key. /// public bool ContainsInteger(int key) { @@ -31,9 +31,9 @@ public bool ContainsInteger(int key) } /// - /// Retrieves an integer value from our property list. - /// This will set value to zero and return false if the - /// list does not contain the given key. + /// Retrieves an integer value from our property list. + /// This will set value to zero and return false if the + /// list does not contain the given key. /// public bool ContainsObject(int key) { @@ -42,19 +42,19 @@ public bool ContainsObject(int key) } /// - /// Creates a new key for this property store. This is NOT - /// guarded by any thread safety so if you are calling it on - /// multiple threads you should guard. For our purposes, - /// we're fine because this is designed to be called in a class - /// initializer, and we never have the same class hierarchy - /// initializing on multiple threads at once. + /// Creates a new key for this property store. This is NOT + /// guarded by any thread safety so if you are calling it on + /// multiple threads you should guard. For our purposes, + /// we're fine because this is designed to be called in a class + /// initializer, and we never have the same class hierarchy + /// initializing on multiple threads at once. /// public static int CreateKey() => s_currentKey++; public Color GetColor(int key) => GetColor(key, out _); /// - /// A wrapper around GetObject designed to reduce the boxing hit + /// A wrapper around GetObject designed to reduce the boxing hit /// public Color GetColor(int key, out bool found) { @@ -74,7 +74,7 @@ public Color GetColor(int key, out bool found) } /// - /// A wrapper around GetObject designed to reduce the boxing hit. + /// A wrapper around GetObject designed to reduce the boxing hit. /// public Padding GetPadding(int key, out bool found) { @@ -94,7 +94,7 @@ public Padding GetPadding(int key, out bool found) } /// - /// A wrapper around GetObject designed to reduce the boxing hit. + /// A wrapper around GetObject designed to reduce the boxing hit. /// public Size GetSize(int key, out bool found) { @@ -114,7 +114,7 @@ public Size GetSize(int key, out bool found) } /// - /// A wrapper around GetObject designed to reduce the boxing hit. + /// A wrapper around GetObject designed to reduce the boxing hit. /// public Rectangle GetRectangle(int key, out bool found) { @@ -134,16 +134,16 @@ public Rectangle GetRectangle(int key, out bool found) } /// - /// Retrieves an integer value from our property list. - /// This will set value to zero and return false if the - /// list does not contain the given key. + /// Retrieves an integer value from our property list. + /// This will set value to zero and return false if the + /// list does not contain the given key. /// public int GetInteger(int key) => GetInteger(key, out _); /// - /// Retrieves an integer value from our property list. - /// This will set value to zero and return false if the - /// list does not contain the given key. + /// Retrieves an integer value from our property list. + /// This will set value to zero and return false if the + /// list does not contain the given key. /// public int GetInteger(int key, out bool found) { @@ -180,16 +180,16 @@ public int GetInteger(int key, out bool found) } /// - /// Retrieves an object value from our property list. - /// This will set value to null and return false if the - /// list does not contain the given key. + /// Retrieves an object value from our property list. + /// This will set value to null and return false if the + /// list does not contain the given key. /// public object GetObject(int key) => GetObject(key, out _); /// - /// Retrieves an object value from our property list. - /// This will set value to null and return false if the - /// list does not contain the given key. + /// Retrieves an object value from our property list. + /// This will set value to null and return false if the + /// list does not contain the given key. /// public object GetObject(int key, out bool found) { @@ -226,12 +226,12 @@ public object GetObject(int key, out bool found) } /// - /// Locates the requested entry in our array if entries. This does - /// not do the mask check to see if the entry is currently being used, - /// but it does locate the entry. If the entry is found, this returns - /// true and fills in index and element. If the entry is not found, - /// this returns false. If the entry is not found, index will contain - /// the insert point at which one would add a new element. + /// Locates the requested entry in our array if entries. This does + /// not do the mask check to see if the entry is currently being used, + /// but it does locate the entry. If the entry is found, this returns + /// true and fills in index and element. If the entry is not found, + /// this returns false. If the entry is not found, index will contain + /// the insert point at which one would add a new element. /// private bool LocateIntegerEntry(short entryKey, out int index) { @@ -341,12 +341,12 @@ private bool LocateIntegerEntry(short entryKey, out int index) } /// - /// Locates the requested entry in our array if entries. This does - /// not do the mask check to see if the entry is currently being used, - /// but it does locate the entry. If the entry is found, this returns - /// true and fills in index and element. If the entry is not found, - /// this returns false. If the entry is not found, index will contain - /// the insert point at which one would add a new element. + /// Locates the requested entry in our array if entries. This does + /// not do the mask check to see if the entry is currently being used, + /// but it does locate the entry. If the entry is found, this returns + /// true and fills in index and element. If the entry is not found, + /// this returns false. If the entry is not found, index will contain + /// the insert point at which one would add a new element. /// private bool LocateObjectEntry(short entryKey, out int index) { @@ -459,7 +459,7 @@ private bool LocateObjectEntry(short entryKey, out int index) } /// - /// Removes the given key from the array + /// Removes the given key from the array /// public void RemoveInteger(int key) { @@ -524,7 +524,7 @@ public void RemoveInteger(int key) } /// - /// Removes the given key from the array + /// Removes the given key from the array /// public void RemoveObject(int key) { @@ -687,7 +687,7 @@ public void SetSize(int key, Size value) } /// - /// Stores the given value in the key. + /// Stores the given value in the key. /// public void SetInteger(int key, int value) { @@ -748,7 +748,7 @@ public void SetInteger(int key, int value) } /// - /// Stores the given value in the key. + /// Stores the given value in the key. /// public void SetObject(int key, object value) { @@ -809,7 +809,7 @@ public void SetObject(int key, object value) } /// - /// Takes the given key and splits it into an index and an element. + /// Takes the given key and splits it into an index and an element. /// private short SplitKey(int key, out short element) { @@ -887,11 +887,11 @@ private void Debug_VerifyLocateObjectEntry(int index, short entryKey, int length } /// - /// Stores the relationship between a key and a value. - /// We do not want to be so inefficient that we require - /// four bytes for each four byte property, so use an algorithm - /// that uses the bottom two bits of the key to identify - /// one of four elements in an entry. + /// Stores the relationship between a key and a value. + /// We do not want to be so inefficient that we require + /// four bytes for each four byte property, so use an algorithm + /// that uses the bottom two bits of the key to identify + /// one of four elements in an entry. /// private struct IntegerEntry { @@ -904,11 +904,11 @@ private struct IntegerEntry } /// - /// Stores the relationship between a key and a value. - /// We do not want to be so inefficient that we require - /// four bytes for each four byte property, so use an algorithm - /// that uses the bottom two bits of the key to identify - /// one of four elements in an entry. + /// Stores the relationship between a key and a value. + /// We do not want to be so inefficient that we require + /// four bytes for each four byte property, so use an algorithm + /// that uses the bottom two bits of the key to identify + /// one of four elements in an entry. /// private struct ObjectEntry { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventArgs.cs index bef013b0667..b5ff7fa70d8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// The event class that is created when a property in the grid is modified by the user. + /// The event class that is created when a property in the grid is modified by the user. /// [ComVisible(true)] public class PropertyValueChangedEventArgs : EventArgs diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventHandler.cs index 116533d43b9..76624179690 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyValueChangedEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// The event handler class that is invoked when a property - /// in the grid is modified by the user. + /// The event handler class that is invoked when a property + /// in the grid is modified by the user. /// public delegate void PropertyValueChangedEventHandler(object s, PropertyValueChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/QueryAccessibilityHelpEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/QueryAccessibilityHelpEventArgs.cs index 5a4a0ef0b6b..72d876910cc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/QueryAccessibilityHelpEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/QueryAccessibilityHelpEventArgs.cs @@ -7,8 +7,8 @@ namespace System.Windows.Forms { /// - /// The QueryAccessibilityHelpEventArgs is fired when AccessibleObject is providing help - /// to accessibility applications. + /// The QueryAccessibilityHelpEventArgs is fired when AccessibleObject is providing help + /// to accessibility applications. /// [ComVisible(true)] public class QueryAccessibilityHelpEventArgs : EventArgs diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventArgs.cs index ba733806bb1..fdf43772fce 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class QueryContinueDragEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public QueryContinueDragEventArgs(int keyState, bool escapePressed, DragAction action) { @@ -23,17 +23,17 @@ public QueryContinueDragEventArgs(int keyState, bool escapePressed, DragAction a } /// - /// Gets a value indicating the current state of the SHIFT, CTRL, and ALT keys. + /// Gets a value indicating the current state of the SHIFT, CTRL, and ALT keys. /// public int KeyState { get; } /// - /// Gets a value indicating whether the user pressed the ESC key. + /// Gets a value indicating whether the user pressed the ESC key. /// public bool EscapePressed { get; } /// - /// Gets or sets the status of a drag-and-drop operation. + /// Gets or sets the status of a drag-and-drop operation. /// public DragAction Action { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventHandler.cs index 8b8919af801..d0bd2da600d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/QueryContinueDragEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void QueryContinueDragEventHandler(object sender, QueryContinueDragEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/QuestionEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/QuestionEventHandler.cs index 7b741910669..74dc9a7a9f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/QuestionEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/QuestionEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Describes a delegate for an event that has a QuestionEventArgs as - /// a parameter. + /// Describes a delegate for an event that has a QuestionEventArgs as + /// a parameter. /// public delegate void QuestionEventHandler(object sender, QuestionEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RadioButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RadioButton.cs index 88ecef45974..6706b3e7e8d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RadioButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RadioButton.cs @@ -64,9 +64,9 @@ public RadioButton() : base() } /// - /// Gets or sets a value indicating whether the - /// value and the appearance of - /// the control automatically change when the control is clicked. + /// Gets or sets a value indicating whether the + /// value and the appearance of + /// the control automatically change when the control is clicked. /// [ DefaultValue(true), @@ -278,11 +278,11 @@ protected override Size DefaultSize } /// - /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. - /// For RadioButton controls, scale the width of the system-style padding and height of the radio button image. - /// Must call the base class method to get the current DPI values. This method is invoked only when - /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has - /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. + /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. + /// For RadioButton controls, scale the width of the system-style padding and height of the radio button image. + /// Must call the base class method to get the current DPI values. This method is invoked only when + /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has + /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. /// /// Old DPI value /// New DPI value diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RadioButtonRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RadioButtonRenderer.cs index 00333541a03..b450ef5f8e2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RadioButtonRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RadioButtonRenderer.cs @@ -26,7 +26,7 @@ private RadioButtonRenderer() /// /// If this property is true, then the renderer will use the setting from Application.RenderWithVisualStyles to - /// determine how to render. + /// determine how to render. /// If this property is false, the renderer will always render with visualstyles. /// public static bool RenderMatchingApplicationState diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RelatedCurrencyManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RelatedCurrencyManager.cs index 10b5a6dcccf..2009b412fdc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RelatedCurrencyManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RelatedCurrencyManager.cs @@ -10,8 +10,8 @@ namespace System.Windows.Forms { /// - /// Represents the child version of the System.Windows.Forms.ListManager - /// that is used when a parent/child relationship exists in a System.Windows.Forms.DataSet. + /// Represents the child version of the System.Windows.Forms.ListManager + /// that is used when a parent/child relationship exists in a System.Windows.Forms.DataSet. /// internal class RelatedCurrencyManager : CurrencyManager { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RetrieveVirtualItemEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RetrieveVirtualItemEventHandler.cs index a3786a17be9..ff12d96138e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RetrieveVirtualItemEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RetrieveVirtualItemEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the RetrieveVirtualItem event - /// of a ListView. + /// Represents the method that will handle the RetrieveVirtualItem event + /// of a ListView. /// public delegate void RetrieveVirtualItemEventHandler(object sender, RetrieveVirtualItemEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBox.cs index 6648922c06e..39ea72653e6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBox.cs @@ -2823,7 +2823,7 @@ protected virtual void OnVScroll(EventArgs e) } /// - /// Pastes the contents of the clipboard in the given clipboard format. + /// Pastes the contents of the clipboard in the given clipboard format. /// public void Paste(DataFormats.Format clipFormat) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxFinds.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxFinds.cs index 6478f327f6d..b3e376827a0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxFinds.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxFinds.cs @@ -5,34 +5,34 @@ namespace System.Windows.Forms { /// - /// Specifies how the method works. + /// Specifies how the method works. /// [Flags] public enum RichTextBoxFinds { /// - /// Find the text without any special characteristics. + /// Find the text without any special characteristics. /// None = 0x00000000, /// - /// Match only a whole word. + /// Match only a whole word. /// WholeWord = 0x00000002, /// - /// Match the case exactly. + /// Match the case exactly. /// MatchCase = 0x00000004, /// - /// If the text is found, do not highlight it. + /// If the text is found, do not highlight it. /// NoHighlight = 0x00000008, /// - /// Search from the end of the current selection to the beginning of the - /// document. + /// Search from the end of the current selection to the beginning of the + /// document. /// Reverse = 0x00000010, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxLanguageOptions.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxLanguageOptions.cs index e89a88d5d9c..9f67be6e075 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxLanguageOptions.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxLanguageOptions.cs @@ -5,58 +5,58 @@ namespace System.Windows.Forms { /// - /// Rich edit control's option settings for Input Method Editor (IME) and - /// Asian language support + /// Rich edit control's option settings for Input Method Editor (IME) and + /// Asian language support /// [Flags] public enum RichTextBoxLanguageOptions { /// - /// If this flag is set, the control automatically changes fonts when the - /// user explicitly changes to a different keyboard layout. + /// If this flag is set, the control automatically changes fonts when the + /// user explicitly changes to a different keyboard layout. /// AutoFont = 0x0002, /// - /// Font-bound font sizes are scaled from insertion point size according to - /// a script. For example, Asian fonts are slightly larger than Western. - /// This is the default. + /// Font-bound font sizes are scaled from insertion point size according to + /// a script. For example, Asian fonts are slightly larger than Western. + /// This is the default. /// AutoFontSizeAdjust = 0x0010, /// - /// If this flag is set, the control automatically changes the keyboard - /// layout when the user explicitly changes to a different font, or when - /// the user explicitly changes the insertion point to a new location in - /// the text. + /// If this flag is set, the control automatically changes the keyboard + /// layout when the user explicitly changes to a different font, or when + /// the user explicitly changes the insertion point to a new location in + /// the text. /// AutoKeyboard = 0x0001, /// - /// Sets the control to dual-font mode. Used for Asian language text. - /// The control uses an English font for ASCII text and an Asian font for - /// Asian text. + /// Sets the control to dual-font mode. Used for Asian language text. + /// The control uses an English font for ASCII text and an Asian font for + /// Asian text. /// DualFont = 0x0080, /// - /// Controls how Rich Edit notifies the client during IME composition: - /// 0: No EN_CHANGE or EN_SELCHANGE notifications during undetermined state. + /// Controls how Rich Edit notifies the client during IME composition: + /// 0: No EN_CHANGE or EN_SELCHANGE notifications during undetermined state. /// Send notification when final string comes in. (default) - /// 1: Send EN_CHANGE and EN_SELCHANGE events during undetermined state. + /// 1: Send EN_CHANGE and EN_SELCHANGE events during undetermined state. /// ImeAlwaysSendNotify = 0x0008, /// - /// This flag determines how the control uses the composition string of an - /// IME if the user cancels it. If this flag is set, the control discards - /// the composition string. If this flag is not set, the control uses the - /// composition string as the result string. + /// This flag determines how the control uses the composition string of an + /// IME if the user cancels it. If this flag is set, the control discards + /// the composition string. If this flag is not set, the control uses the + /// composition string as the result string. /// ImeCancelComplete = 0x0004, /// - /// Use UI default fonts. This option is turned off by default. + /// Use UI default fonts. This option is turned off by default. /// UIFonts = 0x0020 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxScrollBars.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxScrollBars.cs index 6b9459ed83a..d51f13c7dc4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxScrollBars.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxScrollBars.cs @@ -5,42 +5,42 @@ namespace System.Windows.Forms { /// - /// Specifies how a control displays scroll bars. + /// Specifies how a control displays scroll bars. /// public enum RichTextBoxScrollBars { /// - /// Never display scroll bars. + /// Never display scroll bars. /// None = 0, /// - /// Display only a horizontal scroll bar when needed. + /// Display only a horizontal scroll bar when needed. /// Horizontal = RichTextBoxConstants.RTB_HORIZ, /// - /// Display only a vertical scroll bar when needed. + /// Display only a vertical scroll bar when needed. /// Vertical = RichTextBoxConstants.RTB_VERT, /// - /// Display both a horizontal and a vertical scroll bar when needed. + /// Display both a horizontal and a vertical scroll bar when needed. /// Both = Horizontal | Vertical, /// - /// Always display only a horizontal scroll bar. + /// Always display only a horizontal scroll bar. /// ForcedHorizontal = RichTextBoxConstants.RTB_FORCE | Horizontal, /// - /// Always display only a vertical scroll bar. + /// Always display only a vertical scroll bar. /// ForcedVertical = RichTextBoxConstants.RTB_FORCE | Vertical, /// - /// Always display both a horizontal and a vertical scroll bar. + /// Always display both a horizontal and a vertical scroll bar. /// ForcedBoth = ForcedHorizontal | ForcedVertical, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionAttribute.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionAttribute.cs index 3e9a1f22fc1..6d38400dcc9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionAttribute.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionAttribute.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies whether any characters in the - /// current selection have the style or attribute. + /// Specifies whether any characters in the + /// current selection have the style or attribute. /// public enum RichTextBoxSelectionAttribute { /// - /// Some but not all characters. + /// Some but not all characters. /// Mixed = -1, /// - /// No characters. + /// No characters. /// None = 0, /// - /// All characters. + /// All characters. /// All = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionTypes.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionTypes.cs index c6c6566d5e5..1df98c30d50 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionTypes.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxSelectionTypes.cs @@ -5,35 +5,35 @@ namespace System.Windows.Forms { /// - /// Defines the possible kinds selection types in a RichTextBox control. - /// The actual vale returned by RichTextBox.getSelType() is a combination - /// of any of the below options. + /// Defines the possible kinds selection types in a RichTextBox control. + /// The actual vale returned by RichTextBox.getSelType() is a combination + /// of any of the below options. /// [Flags] public enum RichTextBoxSelectionTypes { /// - /// The current selection is empty. + /// The current selection is empty. /// Empty = 0, /// - /// The current selection is text only. + /// The current selection is text only. /// Text = 1, /// - /// The current selection contains atleast one OLE object. + /// The current selection contains atleast one OLE object. /// Object = 2, /// - /// The current selection contains more than one character. + /// The current selection contains more than one character. /// MultiChar = 4, /// - /// The current selection contains more than one OLE object. + /// The current selection contains more than one OLE object. /// MultiObject = 8, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxStreamType.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxStreamType.cs index adf435b6e33..d3452abaea4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxStreamType.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxStreamType.cs @@ -5,34 +5,34 @@ namespace System.Windows.Forms { /// - /// Defines the possible kinds of input/output streams used by RichTextBox - /// control's load/save mechansim. These stream options are also used the - /// control's text modification methods. + /// Defines the possible kinds of input/output streams used by RichTextBox + /// control's load/save mechansim. These stream options are also used the + /// control's text modification methods. /// public enum RichTextBoxStreamType { /// - /// Rich Text Format (RTF). + /// Rich Text Format (RTF). /// RichText = 0, /// - /// Text with spaces in place of OLE objects. + /// Text with spaces in place of OLE objects. /// PlainText = 1, /// - /// RTF with spaces in place of OLE object (valid only for saveFile). + /// RTF with spaces in place of OLE object (valid only for saveFile). /// RichNoOleObjs = 2, /// - /// Text with a text representation of OLE objects (valid only for saveFile). + /// Text with a text representation of OLE objects (valid only for saveFile). /// TextTextOleObjs = 3, /// - /// Text with spaces in place of OLE objects, encoded in Unicode. + /// Text with spaces in place of OLE objects, encoded in Unicode. /// UnicodePlainText = 4, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxWordPunctuations.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxWordPunctuations.cs index 5a21aa31287..f463df4e76f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxWordPunctuations.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RichTextBoxWordPunctuations.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - /// This class defines the possible kinds of punctuation tables that - /// can be used with the RichTextBox word wrapping and word breaking features. + /// This class defines the possible kinds of punctuation tables that + /// can be used with the RichTextBox word wrapping and word breaking features. /// public enum RichTextBoxWordPunctuations { /// - /// Use pre-defined Level 1 punctuation table as default. + /// Use pre-defined Level 1 punctuation table as default. /// Level1 = 0x080, /// - /// Use pre-defined Level 2 punctuation table as default. + /// Use pre-defined Level 2 punctuation table as default. /// Level2 = 0x100, /// - /// Use a custom defined punctuation table. + /// Use a custom defined punctuation table. /// Custom = 0x200, /// - /// Used as a mask. + /// Used as a mask. /// All = Level1 | Level2 | Custom, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/RightToLeft.cs b/src/System.Windows.Forms/src/System/Windows/Forms/RightToLeft.cs index 1e04a09481e..7ef6f537bf6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/RightToLeft.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/RightToLeft.cs @@ -5,23 +5,23 @@ namespace System.Windows.Forms { /// - /// Specifies a value indicating whether the text appears from right to - /// left, as when using Hebrew or Arabic fonts. + /// Specifies a value indicating whether the text appears from right to + /// left, as when using Hebrew or Arabic fonts. /// public enum RightToLeft { /// - /// The text reads from left to right. This is the default. + /// The text reads from left to right. This is the default. /// No = 0, /// - /// The text reads from right to left. + /// The text reads from right to left. /// Yes = 1, /// - /// The direction the text appears in is inherited from the parent control. + /// The direction the text appears in is inherited from the parent control. /// Inherit = 2 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Screen.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Screen.cs index d939487be23..af7da168e1c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Screen.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Screen.cs @@ -328,14 +328,14 @@ public static Screen FromRectangle(Rectangle rect) } /// - /// Retrieves a for the monitor that contains - /// the largest region of the window of the control. + /// Retrieves a for the monitor that contains + /// the largest region of the window of the control. /// public static Screen FromControl(Control control) => FromHandle(control.Handle); /// - /// Retrieves a for the monitor that contains - /// the largest region of the window. + /// Retrieves a for the monitor that contains + /// the largest region of the window. /// public static Screen FromHandle(IntPtr hwnd) { @@ -400,7 +400,7 @@ public static Rectangle GetBounds(Control ctl) } /// - /// Computes and retrieves a hash code for an object. + /// Computes and retrieves a hash code for an object. /// public override int GetHashCode() => (int)hmonitor; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScreenOrientation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScreenOrientation.cs index 63bd4e8c45c..bc5950bbb27 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScreenOrientation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScreenOrientation.cs @@ -5,27 +5,27 @@ namespace System.Windows.Forms { /// - /// Specifies the angle of screen orientation + /// Specifies the angle of screen orientation /// public enum ScreenOrientation { /// - /// The screen is oriented at 0 degrees + /// The screen is oriented at 0 degrees /// Angle0 = 0, /// - /// The screen is oriented at 90 degrees + /// The screen is oriented at 90 degrees /// Angle90 = 1, /// - /// The screen is oriented at 180 degrees. + /// The screen is oriented at 180 degrees. /// Angle180 = 2, /// - /// The screen is oriented at 270 degrees. + /// The screen is oriented at 270 degrees. /// Angle270 = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBar.cs index 76d21e1d7ba..9518de53c72 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBar.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Implements the basic functionality of a scroll bar control. + /// Implements the basic functionality of a scroll bar control. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -30,7 +30,7 @@ public abstract class ScrollBar : Control private bool _scaleScrollBarForDpiChange = true; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ScrollBar() : base() { @@ -51,7 +51,7 @@ public ScrollBar() : base() } /// - /// Hide AutoSize: it doesn't make sense for this control + /// Hide AutoSize: it doesn't make sense for this control /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never), @@ -146,7 +146,7 @@ protected override void RescaleConstantsForDpi(int deviceDpiOld, int deviceDpiNe } /// - /// Gets or sets the foreground color of the scroll bar control. + /// Gets or sets the foreground color of the scroll bar control. /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] @@ -197,8 +197,8 @@ public override Font Font } /// - /// Gets or sets a value to be added or subtracted to the - /// property when the scroll box is moved a large distance. + /// Gets or sets a value to be added or subtracted to the + /// property when the scroll box is moved a large distance. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(10)] @@ -231,7 +231,7 @@ public int LargeChange } /// - /// Gets or sets the upper limit of values of the scrollable range. + /// Gets or sets the upper limit of values of the scrollable range. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(100)] @@ -260,7 +260,7 @@ public int Maximum } /// - /// Gets or sets the lower limit of values of the scrollable range. + /// Gets or sets the lower limit of values of the scrollable range. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(0)] @@ -289,8 +289,8 @@ public int Minimum } /// - /// Gets or sets the value to be added or subtracted to the - /// property when the scroll box is moved a small distance. + /// Gets or sets the value to be added or subtracted to the + /// property when the scroll box is moved a small distance. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(1)] @@ -345,8 +345,8 @@ public override string Text } /// - /// Gets or sets a numeric value that represents the current position of the scroll box - /// on the scroll bar control. + /// Gets or sets a numeric value that represents the current position of the scroll box + /// on the scroll bar control. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(0)] @@ -372,7 +372,7 @@ public int Value } /// - /// Get/Set flag to let scrollbar scale according to the DPI of the window. + /// Get/Set flag to let scrollbar scale according to the DPI of the window. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -450,7 +450,7 @@ public bool ScaleScrollBarForDpiChange } /// - /// Occurs when the scroll box has been moved by either a mouse or keyboard action. + /// Occurs when the scroll box has been moved by either a mouse or keyboard action. /// [SRCategory(nameof(SR.CatAction))] [SRDescription(nameof(SR.ScrollBarOnScrollDescr))] @@ -461,9 +461,9 @@ public event ScrollEventHandler Scroll } /// - /// Occurs when the property has - /// changed, either by a event - /// or programatically. + /// Occurs when the property has + /// changed, either by a event + /// or programatically. /// [SRCategory(nameof(SR.CatAction))] [SRDescription(nameof(SR.valueChangedEventDescr))] @@ -474,12 +474,12 @@ public event EventHandler ValueChanged } /// - /// This is a helper method that is called by ScaleControl to retrieve the bounds - /// that the control should be scaled by. You may override this method if you - /// wish to reuse ScaleControl's scaling logic but you need to supply your own - /// bounds. The default implementation returns scaled bounds that take into - /// account the BoundsSpecified, whether the control is top level, and whether - /// the control is fixed width or auto size, and any adornments the control may have. + /// This is a helper method that is called by ScaleControl to retrieve the bounds + /// that the control should be scaled by. You may override this method if you + /// wish to reuse ScaleControl's scaling logic but you need to supply your own + /// bounds. The default implementation returns scaled bounds that take into + /// account the BoundsSpecified, whether the control is top level, and whether + /// the control is fixed width or auto size, and any adornments the control may have. /// protected override Rectangle GetScaledBounds(Rectangle bounds, SizeF factor, BoundsSpecified specified) { @@ -509,7 +509,7 @@ protected override void OnEnabledChanged(EventArgs e) } /// - /// Creates the handle. overridden to help set up scrollbar information. + /// Creates the handle. overridden to help set up scrollbar information. /// protected override void OnHandleCreated(EventArgs e) { @@ -518,7 +518,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnScroll(ScrollEventArgs se) { @@ -527,11 +527,11 @@ protected virtual void OnScroll(ScrollEventArgs se) } /// - /// Converts mouse wheel movements into scrolling, when scrollbar has the focus. - /// Typically one wheel step will cause one small scroll increment, in either - /// direction. A single wheel message could represent either one wheel step, multiple - /// wheel steps (fast wheeling), or even a fraction of a step (smooth-wheeled mice). - /// So we accumulate the total wheel delta, and consume it in whole numbers of steps. + /// Converts mouse wheel movements into scrolling, when scrollbar has the focus. + /// Typically one wheel step will cause one small scroll increment, in either + /// direction. A single wheel message could represent either one wheel step, multiple + /// wheel steps (fast wheeling), or even a fraction of a step (smooth-wheeled mice). + /// So we accumulate the total wheel delta, and consume it in whole numbers of steps. /// protected override void OnMouseWheel(MouseEventArgs e) { @@ -575,7 +575,7 @@ protected override void OnMouseWheel(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnValueChanged(EventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBars.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBars.cs index d6229c356e5..712aaac9f92 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBars.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollBars.cs @@ -5,27 +5,27 @@ namespace System.Windows.Forms { /// - /// Specifies which scroll bars will be visible on a control. + /// Specifies which scroll bars will be visible on a control. /// public enum ScrollBars { /// - /// No scroll bars are shown. + /// No scroll bars are shown. /// None = 0, /// - /// Only horizontal scroll bars are shown. + /// Only horizontal scroll bars are shown. /// Horizontal = 1, /// - /// Only vertical scroll bars are shown. + /// Only vertical scroll bars are shown. /// Vertical = 2, /// - /// Both horizontal and vertical scroll bars are shown. + /// Both horizontal and vertical scroll bars are shown. /// Both = 3, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollButton.cs index b9f7d02469a..f3bb2679b5a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollButton.cs @@ -5,28 +5,28 @@ namespace System.Windows.Forms { /// - //// Specifies the type of scroll arrow to create on a scroll bar. + //// Specifies the type of scroll arrow to create on a scroll bar. //// /// public enum ScrollButton { /// - //// A down-scroll arrow. + //// A down-scroll arrow. /// Down = NativeMethods.DFCS_SCROLLDOWN, /// - //// A left-scroll arrow. + //// A left-scroll arrow. /// Left = NativeMethods.DFCS_SCROLLLEFT, /// - //// A right-scroll arrow. + //// A right-scroll arrow. /// Right = NativeMethods.DFCS_SCROLLRIGHT, /// - //// An up-scroll arrow. + //// An up-scroll arrow. /// Up = NativeMethods.DFCS_SCROLLUP, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventArgs.cs index 8b6cfc6bd97..9b499085cb4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventArgs.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. + /// Provides data for the + /// event. /// [ComVisible(true)] public class ScrollEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ScrollEventArgs(ScrollEventType type, int newValue) { @@ -24,7 +24,7 @@ public ScrollEventArgs(ScrollEventType type, int newValue) } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ScrollEventArgs(ScrollEventType type, int newValue, ScrollOrientation scroll) { @@ -50,22 +50,22 @@ public ScrollEventArgs(ScrollEventType type, int oldValue, int newValue, ScrollO } /// - /// Specifies the type of scroll event that occurred. + /// Specifies the type of scroll event that occurred. /// public ScrollEventType Type { get; } /// - /// Specifies the new location of the scroll box within the scroll bar. + /// Specifies the new location of the scroll box within the scroll bar. /// public int NewValue { get; set; } /// - /// Specifies the last position within the scroll bar. + /// Specifies the last position within the scroll bar. /// public int OldValue { get; } /// - /// Specifies the type of scroll event that occurred. + /// Specifies the type of scroll event that occurred. /// public ScrollOrientation ScrollOrientation { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventHandler.cs index 354eb4a1464..5495929c80e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that handles the event - /// of a , , - /// or . + /// Represents the method that handles the event + /// of a , , + /// or . /// public delegate void ScrollEventHandler(object sender, ScrollEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventType.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventType.cs index 8f0296d8067..34b5fe45ea3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventType.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollEventType.cs @@ -7,63 +7,63 @@ namespace System.Windows.Forms { /// - /// Specifies the type of action used to raise the event. + /// Specifies the type of action used to raise the event. /// [ComVisible(true)] public enum ScrollEventType { /// - /// The scroll box was moved a small distance. The user clicked the - /// left (horizontal) or top (vertical) scroll arrow or pressed - /// the UP ARROW + /// The scroll box was moved a small distance. The user clicked the + /// left (horizontal) or top (vertical) scroll arrow or pressed + /// the UP ARROW /// SmallDecrement = NativeMethods.SB_LINELEFT, /// - /// The scroll box was moved a small distance. The user clicked the - /// right (horizontal) or bottom (vertical) scroll arrow or pressed - /// the DOWN ARROW key. + /// The scroll box was moved a small distance. The user clicked the + /// right (horizontal) or bottom (vertical) scroll arrow or pressed + /// the DOWN ARROW key. /// SmallIncrement = NativeMethods.SB_LINERIGHT, /// - /// The scroll box moved a large distance. The user clicked the scroll bar - /// to the left (horizontal) or above (vertical) the scroll box, or pressed - /// the PAGE UP key. + /// The scroll box moved a large distance. The user clicked the scroll bar + /// to the left (horizontal) or above (vertical) the scroll box, or pressed + /// the PAGE UP key. /// LargeDecrement = NativeMethods.SB_PAGELEFT, /// - /// The scroll box moved a large distance. The user clicked the scroll bar - /// to the right (horizontal) or below (vertical) the scroll box, or pressed - /// the PAGE DOWN key. + /// The scroll box moved a large distance. The user clicked the scroll bar + /// to the right (horizontal) or below (vertical) the scroll box, or pressed + /// the PAGE DOWN key. /// LargeIncrement = NativeMethods.SB_PAGERIGHT, /// - /// The scroll box was moved. + /// The scroll box was moved. /// ThumbPosition = NativeMethods.SB_THUMBPOSITION, /// - /// The scroll box is currently being moved. + /// The scroll box is currently being moved. /// ThumbTrack = NativeMethods.SB_THUMBTRACK, /// - /// The scroll box was moved to the - /// position. + /// The scroll box was moved to the + /// position. /// First = NativeMethods.SB_LEFT, /// - /// The scroll box was moved to the - /// position. + /// The scroll box was moved to the + /// position. /// Last = NativeMethods.SB_RIGHT, /// - /// The scroll box has stopped moving. + /// The scroll box has stopped moving. /// EndScroll = NativeMethods.SB_ENDSCROLL } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollOrientation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollOrientation.cs index 7a508d34b7a..115b296d70c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollOrientation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollOrientation.cs @@ -5,18 +5,18 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. This enumeration gives the orientation of the scroll that took place + /// Provides data for the + /// event. This enumeration gives the orientation of the scroll that took place /// public enum ScrollOrientation { /// - /// Denotes that horizontal scrolling took place. + /// Denotes that horizontal scrolling took place. /// HorizontalScroll, /// - /// Denotes that vertical scrolling took place. + /// Denotes that vertical scrolling took place. /// VerticalScroll } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollProperties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollProperties.cs index d98e8c4b5f2..c31028585dc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollProperties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollProperties.cs @@ -8,7 +8,7 @@ namespace System.Windows.Forms { /// - /// Basic Properties for Scrollbars. + /// Basic Properties for Scrollbars. /// public abstract class ScrollProperties { @@ -35,7 +35,7 @@ protected ScrollProperties(ScrollableControl container) } /// - /// Gets or sets a bool value controlling whether the scrollbar is enabled. + /// Gets or sets a bool value controlling whether the scrollbar is enabled. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(true)] @@ -66,8 +66,8 @@ public bool Enabled } /// - /// Gets or sets a value to be added or subtracted to the - /// property when the scroll box is moved a large distance. + /// Gets or sets a value to be added or subtracted to the + /// property when the scroll box is moved a large distance. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(10)] @@ -100,7 +100,7 @@ public int LargeChange } /// - /// Gets or sets the upper limit of values of the scrollable range. + /// Gets or sets the upper limit of values of the scrollable range. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(100)] @@ -135,7 +135,7 @@ public int Maximum } /// - /// Gets or sets the lower limit of values of the scrollable range. + /// Gets or sets the lower limit of values of the scrollable range. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(0)] @@ -182,8 +182,8 @@ public int Minimum internal abstract int VerticalDisplayPosition { get; } /// - /// Gets or sets the value to be added or subtracted to the - /// property when the scroll box is moved a small distance. + /// Gets or sets the value to be added or subtracted to the + /// property when the scroll box is moved a small distance. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(1)] @@ -214,8 +214,8 @@ public int SmallChange } /// - /// Gets or sets a numeric value that represents the current position of the scroll box - /// on the scroll bar control. + /// Gets or sets a numeric value that represents the current position of the scroll box + /// on the scroll bar control. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(0)] @@ -241,7 +241,7 @@ public int Value } /// - /// Gets or sets a bool value controlling whether the scrollbar is showing. + /// Gets or sets a bool value controlling whether the scrollbar is showing. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollableControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollableControl.cs index 35c3e605062..2220c2a8c85 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ScrollableControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ScrollableControl.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// Defines a base class for controls that support auto-scrolling behavior. + /// Defines a base class for controls that support auto-scrolling behavior. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -37,22 +37,22 @@ public class ScrollableControl : Control, IArrangedElement private Size _userAutoScrollMinSize = Size.Empty; /// - /// Current size of the displayRect. + /// Current size of the displayRect. /// private Rectangle _displayRect = Rectangle.Empty; /// - /// Current margins for autoscrolling. + /// Current margins for autoscrolling. /// private Size _scrollMargin = Size.Empty; /// - /// User requested margins for autoscrolling. + /// User requested margins for autoscrolling. /// private Size _requestedScrollMargin = Size.Empty; /// - /// User requested autoscroll position - used for form creation only. + /// User requested autoscroll position - used for form creation only. /// private Point _scrollPosition = Point.Empty; @@ -67,13 +67,13 @@ public class ScrollableControl : Control, IArrangedElement private static readonly object s_scrollEvent = new object(); /// - /// Used to figure out what the horizontal scroll value should be set to when the horizontal - /// scrollbar is first shown. + /// Used to figure out what the horizontal scroll value should be set to when the horizontal + /// scrollbar is first shown. /// private bool resetRTLHScrollValue = false; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ScrollableControl() : base() { @@ -83,8 +83,8 @@ public ScrollableControl() : base() } /// - /// Gets or sets a value indicating whether the container will allow the user to - /// scroll to any controls placed outside of its visible boundaries. + /// Gets or sets a value indicating whether the container will allow the user to + /// scroll to any controls placed outside of its visible boundaries. /// [SRCategory(nameof(SR.CatLayout))] [Localizable(true)] @@ -106,7 +106,7 @@ public virtual bool AutoScroll } /// - /// Gets or sets the size of the auto-scroll margin. + /// Gets or sets the size of the auto-scroll margin. /// [SRCategory(nameof(SR.CatLayout))] [Localizable(true)] @@ -126,7 +126,7 @@ public Size AutoScrollMargin } /// - /// Gets or sets the location of the auto-scroll position. + /// Gets or sets the location of the auto-scroll position. /// [SRCategory(nameof(SR.CatLayout))] [Browsable(false)] @@ -169,8 +169,8 @@ public Size AutoScrollMinSize } /// - /// Retrieves the CreateParams used to create the window. - /// If a subclass overrides this function, it must call the base implementation. + /// Retrieves the CreateParams used to create the window. + /// If a subclass overrides this function, it must call the base implementation. /// protected override CreateParams CreateParams { @@ -200,9 +200,9 @@ protected override CreateParams CreateParams } /// - /// Retreives the current display rectangle. The display rectangle is the virtual - /// display area that is used to layout components. The position and dimensions of - /// the Form's display rectangle change during autoScroll. + /// Retreives the current display rectangle. The display rectangle is the virtual + /// display area that is used to layout components. The position and dimensions of + /// the Form's display rectangle change during autoScroll. /// public override Rectangle DisplayRectangle { @@ -244,7 +244,7 @@ Rectangle IArrangedElement.DisplayRectangle } /// - /// Gets or sets a value indicating whether the horizontal scroll bar is visible. + /// Gets or sets a value indicating whether the horizontal scroll bar is visible. /// protected bool HScroll { @@ -262,7 +262,7 @@ protected bool HScroll public HScrollProperties HorizontalScroll => _horizontalScroll ??= new HScrollProperties(this); /// - /// Gets or sets a value indicating whether the vertical scroll bar is visible. + /// Gets or sets a value indicating whether the vertical scroll bar is visible. /// protected bool VScroll { @@ -271,7 +271,7 @@ protected bool VScroll } /// - /// Gets the Veritcal Scroll bar for this ScrollableControl. + /// Gets the Veritcal Scroll bar for this ScrollableControl. /// [SRCategory(nameof(SR.CatLayout))] [SRDescription(nameof(SR.ScrollableControlVerticalScrollDescr))] @@ -280,7 +280,7 @@ protected bool VScroll public VScrollProperties VerticalScroll => _verticalScroll ??= new VScrollProperties(this); /// - /// Gets the dock padding settings for all edges of the control. + /// Gets the dock padding settings for all edges of the control. /// [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] [Browsable(false)] @@ -288,8 +288,8 @@ protected bool VScroll public DockPaddingEdges DockPadding => dockPadding ??= new DockPaddingEdges(this); /// - /// Adjusts the auto-scroll bars on the container based on the current control - /// positions and the control currently selected. + /// Adjusts the auto-scroll bars on the container based on the current control + /// positions and the control currently selected. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void AdjustFormScrollbars(bool displayScrollbars) @@ -580,13 +580,13 @@ private Rectangle GetDisplayRectInternal() } /// - /// Tests a given scroll state bit to determine if it is set. + /// Tests a given scroll state bit to determine if it is set. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected bool GetScrollState(int bit) => (bit & _scrollState) == bit; /// - /// Forces the layout of any docked or anchored child controls. + /// Forces the layout of any docked or anchored child controls. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnLayout(LayoutEventArgs levent) @@ -613,7 +613,7 @@ protected override void OnLayout(LayoutEventArgs levent) } /// - /// Handles mouse wheel processing for our scrollbars. + /// Handles mouse wheel processing for our scrollbars. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnMouseWheel(MouseEventArgs e) @@ -718,7 +718,7 @@ protected override void ScaleCore(float dx, float dy) } /// - /// Scale this form. Form overrides this to enforce a maximum / minimum size. + /// Scale this form. Form overrides this to enforce a maximum / minimum size. /// protected override void ScaleControl(SizeF factor, BoundsSpecified specified) { @@ -727,7 +727,7 @@ protected override void ScaleControl(SizeF factor, BoundsSpecified specified) } /// - /// Allows to set the to enable the visual scroll effect. + /// Allows to set the to enable the visual scroll effect. /// internal void SetDisplayFromScrollProps(int x, int y) { @@ -737,8 +737,8 @@ internal void SetDisplayFromScrollProps(int x, int y) } /// - /// Adjusts the displayRect to be at the offset x, y. The contents of the - /// Form is scrolled using Windows.ScrollWindowEx. + /// Adjusts the displayRect to be at the offset x, y. The contents of the + /// Form is scrolled using Windows.ScrollWindowEx. /// protected void SetDisplayRectLocation(int x, int y) { @@ -808,8 +808,8 @@ protected void SetDisplayRectLocation(int x, int y) } /// - /// Scrolls the currently active control into view if we are an AutoScroll - /// Form that has the Horiz or Vert scrollbar displayed... + /// Scrolls the currently active control into view if we are an AutoScroll + /// Form that has the Horiz or Vert scrollbar displayed... /// public void ScrollControlIntoView(Control activeControl) { @@ -840,11 +840,11 @@ public void ScrollControlIntoView(Control activeControl) } /// Allow containers to tweak autoscrolling. when you tab between controls contained in the scrollable control - /// this allows you to set the scroll location. This would allow you to scroll to the middle of a control, where as the default is - /// the top of the control. - /// Additionally there is a new AutoScrollOffset property on the child controls themselves. This lets them control where they want to - /// be scrolled to. E.g. In SelectedIndexChanged for a ListBox, you could do: - /// listBox1.AutoScrollOffset = parent.AutoScrollPosition; + /// this allows you to set the scroll location. This would allow you to scroll to the middle of a control, where as the default is + /// the top of the control. + /// Additionally there is a new AutoScrollOffset property on the child controls themselves. This lets them control where they want to + /// be scrolled to. E.g. In SelectedIndexChanged for a ListBox, you could do: + /// listBox1.AutoScrollOffset = parent.AutoScrollPosition; /// protected virtual Point ScrollToControl(Control activeControl) { @@ -907,7 +907,7 @@ private int ScrollThumbPosition(int fnBar) } /// - /// Occurs when the scroll box has been moved by either a mouse or keyboard action. + /// Occurs when the scroll box has been moved by either a mouse or keyboard action. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.ScrollBarOnScrollDescr))] public event ScrollEventHandler Scroll @@ -917,7 +917,7 @@ public event ScrollEventHandler Scroll } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnScroll(ScrollEventArgs se) { @@ -937,7 +937,7 @@ private void ResetScrollProperties(ScrollProperties scrollProperties) } /// - /// Sets the size of the auto-scroll margins. + /// Sets the size of the auto-scroll margins. /// public void SetAutoScrollMargin(int x, int y) { @@ -962,8 +962,8 @@ public void SetAutoScrollMargin(int x, int y) } /// - /// Actually displays or hides the horiz and vert autoscrollbars. This will - /// also adjust the values of formState to reflect the new state + /// Actually displays or hides the horiz and vert autoscrollbars. This will + /// also adjust the values of formState to reflect the new state /// private bool SetVisibleScrollbars(bool horiz, bool vert) { @@ -1028,9 +1028,9 @@ private bool SetVisibleScrollbars(bool horiz, bool vert) } /// - /// Sets the width and height of the virtual client area used in autoscrolling. - /// This will also adjust the x and y location of the virtual client area if the - /// new size forces it. + /// Sets the width and height of the virtual client area used in autoscrolling. + /// This will also adjust the x and y location of the virtual client area if the + /// new size forces it. /// private bool SetDisplayRectangleSize(int width, int height) { @@ -1080,7 +1080,7 @@ private bool SetDisplayRectangleSize(int width, int height) } /// - /// Sets a given scroll state bit. + /// Sets a given scroll state bit. /// protected void SetScrollState(int bit, bool value) { @@ -1095,8 +1095,8 @@ protected void SetScrollState(int bit, bool value) } /// - /// Indicates whether the property should - /// be persisted. + /// Indicates whether the property should + /// be persisted. /// private bool ShouldSerializeAutoScrollPosition() { @@ -1113,19 +1113,19 @@ private bool ShouldSerializeAutoScrollPosition() } /// - /// Indicates whether the property should be persisted. + /// Indicates whether the property should be persisted. /// private bool ShouldSerializeAutoScrollMargin() => !AutoScrollMargin.Equals(Size.Empty); /// - /// Indicates whether the - /// property should be persisted. + /// Indicates whether the + /// property should be persisted. /// private bool ShouldSerializeAutoScrollMinSize() => !AutoScrollMinSize.Equals(Size.Empty); /// - /// Updates the value of the autoscroll scrollbars based on the current form - /// state. This is a one-way sync, updating the scrollbars only. + /// Updates the value of the autoscroll scrollbars based on the current form + /// state. This is a one-way sync, updating the scrollbars only. /// private void SyncScrollbars(bool autoScroll) { @@ -1215,8 +1215,8 @@ private void OnSetScrollPosition(object sender, EventArgs e) } /// - /// Queries the system to determine the users preference for full drag - /// of windows. + /// Queries the system to determine the users preference for full drag + /// of windows. /// private void UpdateFullDrag() { @@ -1224,7 +1224,7 @@ private void UpdateFullDrag() } /// - /// WM_VSCROLL handler + /// WM_VSCROLL handler /// private void WmVScroll(ref Message m) { @@ -1314,7 +1314,7 @@ private void WmVScroll(ref Message m) } /// - /// WM_HSCROLL handler + /// WM_HSCROLL handler /// private void WmHScroll(ref Message m) { @@ -1401,8 +1401,8 @@ private void WmHScroll(ref Message m) } /// - /// This function gets called which populates the eventArgs and fires the OnScroll( ) event passing - /// the appropriate scroll event and scroll bar. + /// This function gets called which populates the eventArgs and fires the OnScroll( ) event passing + /// the appropriate scroll event and scroll bar. /// private void WmOnScroll(ref Message m, int oldValue, int value, ScrollOrientation scrollOrientation) { @@ -1421,9 +1421,9 @@ private void WmSettingChange(ref Message m) } /// - /// The button's window procedure. Inheriting classes can override this - /// to add extra functionality, but should not forget to call - /// base.wndProc(m); to ensure the button continues to function properly. + /// The button's window procedure. Inheriting classes can override this + /// to add extra functionality, but should not forget to call + /// base.wndProc(m); to ensure the button continues to function properly. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void WndProc(ref Message m) @@ -1446,7 +1446,7 @@ protected override void WndProc(ref Message m) } /// - /// Determines the border padding for docked controls. + /// Determines the border padding for docked controls. /// [TypeConverter(typeof(DockPaddingEdgesConverter))] public class DockPaddingEdges : ICloneable @@ -1458,8 +1458,8 @@ public class DockPaddingEdges : ICloneable private int _bottom; /// - /// Creates a new DockPaddingEdges. The specified owner will be notified when - /// the values are changed. + /// Creates a new DockPaddingEdges. The specified owner will be notified when + /// the values are changed. /// internal DockPaddingEdges(ScrollableControl owner) { @@ -1475,7 +1475,7 @@ internal DockPaddingEdges(int left, int right, int top, int bottom) } /// - /// Gets or ssets the padding width for all edges of a docked control. + /// Gets or ssets the padding width for all edges of a docked control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.PaddingAllDescr))] @@ -1528,7 +1528,7 @@ public int All } /// - /// Gets or sets the padding width for the bottom edge of a docked control. + /// Gets or sets the padding width for the bottom edge of a docked control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.PaddingBottomDescr))] @@ -1551,7 +1551,7 @@ public int Bottom } /// - /// Gets or sets the padding width for the left edge of a docked control. + /// Gets or sets the padding width for the left edge of a docked control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.PaddingLeftDescr))] @@ -1574,7 +1574,7 @@ public int Left } /// - /// Gets or sets the padding width for the right edge of a docked control. + /// Gets or sets the padding width for the right edge of a docked control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.PaddingRightDescr))] @@ -1597,7 +1597,7 @@ public int Right } /// - /// Gets or sets the padding width for the top edge of a docked control. + /// Gets or sets the padding width for the top edge of a docked control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.PaddingTopDescr))] @@ -1650,9 +1650,9 @@ public override bool Equals(object other) public class DockPaddingEdgesConverter : TypeConverter { /// - /// Retrieves the set of properties for this type. By default, a type has does - /// not return any properties. An easy implementation of this method can just - /// call TypeDescriptor.GetProperties for the correct data type. + /// Retrieves the set of properties for this type. By default, a type has does + /// not return any properties. An easy implementation of this method can just + /// call TypeDescriptor.GetProperties for the correct data type. /// public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes) { @@ -1661,7 +1661,7 @@ public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContex } /// - /// Determines if this object supports properties. By default, this is false. + /// Determines if this object supports properties. By default, this is false. /// public override bool GetPropertiesSupported(ITypeDescriptorContext context) => true; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SearchForVirtualItemEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SearchForVirtualItemEventHandler.cs index 4c1b339a0d4..a2fe9299705 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SearchForVirtualItemEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SearchForVirtualItemEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the SearchForVirtualItem event of a ListView. + /// Represents the method that will handle the SearchForVirtualItem event of a ListView. /// public delegate void SearchForVirtualItemEventHandler(object sender, SearchForVirtualItemEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SelectedGridItemChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SelectedGridItemChangedEventArgs.cs index 0138cf5a38f..ced33bf70f6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SelectedGridItemChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SelectedGridItemChangedEventArgs.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// The event class that is created when the selected GridItem in the PropertyGrid is changed by the user. + /// The event class that is created when the selected GridItem in the PropertyGrid is changed by the user. /// public class SelectedGridItemChangedEventArgs : EventArgs { /// - /// Constructs a SelectedGridItemChangedEventArgs object. + /// Constructs a SelectedGridItemChangedEventArgs object. /// public SelectedGridItemChangedEventArgs(GridItem oldSel, GridItem newSel) { @@ -19,12 +19,12 @@ public SelectedGridItemChangedEventArgs(GridItem oldSel, GridItem newSel) } /// - /// The previously selected GridItem object. This can be null. + /// The previously selected GridItem object. This can be null. /// public GridItem OldSelection { get; } /// - /// The newly selected GridItem object + /// The newly selected GridItem object /// public GridItem NewSelection { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SelectionMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SelectionMode.cs index e06da869156..11af1e6c90c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SelectionMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SelectionMode.cs @@ -10,24 +10,24 @@ namespace System.Windows.Forms public enum SelectionMode { /// - /// Indicates that no items can be selected. + /// Indicates that no items can be selected. /// None = 0, /// - /// Indicates that only one item at a time can be selected. + /// Indicates that only one item at a time can be selected. /// One = 1, /// - /// Indicates that more than one item at a time can be selected. + /// Indicates that more than one item at a time can be selected. /// MultiSimple = 2, /// - /// Indicates that more than one item at a time can be selected, and - /// keyboard combinations, such as SHIFT and CTRL can be used to help - /// in selection. + /// Indicates that more than one item at a time can be selected, and + /// keyboard combinations, such as SHIFT and CTRL can be used to help + /// in selection. /// MultiExtended = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Shortcut.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Shortcut.cs index d7efe042220..6cfe2fefbcc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Shortcut.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Shortcut.cs @@ -7,774 +7,774 @@ namespace System.Windows.Forms { /// - /// Specifies shortcut keys that can be used by menu items. + /// Specifies shortcut keys that can be used by menu items. /// [ComVisible(true)] public enum Shortcut { /// - /// No shortcut key is associated with the menu item. + /// No shortcut key is associated with the menu item. /// None = 0, /// - /// The shorcut keys CTRL+A. + /// The shorcut keys CTRL+A. /// CtrlA = Keys.Control + Keys.A, /// - /// The shorcut keys CTRL+B. + /// The shorcut keys CTRL+B. /// CtrlB = Keys.Control + Keys.B, /// - /// The shorcut keys CTRL+C. + /// The shorcut keys CTRL+C. /// CtrlC = Keys.Control + Keys.C, /// - /// The shorcut keys CTRL+D. + /// The shorcut keys CTRL+D. /// CtrlD = Keys.Control + Keys.D, /// - /// The shorcut keys CTRL+E. + /// The shorcut keys CTRL+E. /// CtrlE = Keys.Control + Keys.E, /// - /// The shorcut keys CTRL+F. + /// The shorcut keys CTRL+F. /// CtrlF = Keys.Control + Keys.F, /// - /// The shorcut keys CTRL+G. + /// The shorcut keys CTRL+G. /// CtrlG = Keys.Control + Keys.G, /// - /// The shorcut keys CTRL+H. + /// The shorcut keys CTRL+H. /// CtrlH = Keys.Control + Keys.H, /// - /// The shorcut keys CTRL+I. + /// The shorcut keys CTRL+I. /// CtrlI = Keys.Control + Keys.I, /// - /// The shorcut keys CTRL+J. + /// The shorcut keys CTRL+J. /// CtrlJ = Keys.Control + Keys.J, /// - /// The shorcut keys CTRL+K. + /// The shorcut keys CTRL+K. /// CtrlK = Keys.Control + Keys.K, /// - /// The shorcut keys CTRL+L. + /// The shorcut keys CTRL+L. /// CtrlL = Keys.Control + Keys.L, /// - /// The shorcut keys CTRL+M. + /// The shorcut keys CTRL+M. /// CtrlM = Keys.Control + Keys.M, /// - /// The shorcut keys CTRL+N. + /// The shorcut keys CTRL+N. /// CtrlN = Keys.Control + Keys.N, /// - /// The shorcut keys CTRL+O. + /// The shorcut keys CTRL+O. /// CtrlO = Keys.Control + Keys.O, /// - /// The shorcut keys CTRL+P. + /// The shorcut keys CTRL+P. /// CtrlP = Keys.Control + Keys.P, /// - /// The shorcut keys CTRL+Q. + /// The shorcut keys CTRL+Q. /// CtrlQ = Keys.Control + Keys.Q, /// - /// The shorcut keys CTRL+R. + /// The shorcut keys CTRL+R. /// CtrlR = Keys.Control + Keys.R, /// - /// The shorcut keys CTRL+S. + /// The shorcut keys CTRL+S. /// CtrlS = Keys.Control + Keys.S, /// - /// The shorcut keys CTRL+T. + /// The shorcut keys CTRL+T. /// CtrlT = Keys.Control + Keys.T, /// - /// The shorcut keys CTRL+U + /// The shorcut keys CTRL+U /// CtrlU = Keys.Control + Keys.U, /// - /// The shorcut keys CTRL+V. + /// The shorcut keys CTRL+V. /// CtrlV = Keys.Control + Keys.V, /// - /// The shorcut keys CTRL+W. + /// The shorcut keys CTRL+W. /// CtrlW = Keys.Control + Keys.W, /// - /// The shorcut keys CTRL+X. + /// The shorcut keys CTRL+X. /// CtrlX = Keys.Control + Keys.X, /// - /// The shorcut keys CTRL+Y. + /// The shorcut keys CTRL+Y. /// CtrlY = Keys.Control + Keys.Y, /// - /// The shorcut keys CTRL+Z. + /// The shorcut keys CTRL+Z. /// CtrlZ = Keys.Control + Keys.Z, /// - /// The shortcut keys CTRL+SHIFT+A. + /// The shortcut keys CTRL+SHIFT+A. /// CtrlShiftA = Keys.Control + Keys.Shift + Keys.A, /// - /// The shortcut keys CTRL+SHIFT+B. + /// The shortcut keys CTRL+SHIFT+B. /// CtrlShiftB = Keys.Control + Keys.Shift + Keys.B, /// - /// The shortcut keys CTRL+SHIFT+C. + /// The shortcut keys CTRL+SHIFT+C. /// CtrlShiftC = Keys.Control + Keys.Shift + Keys.C, /// - /// The shortcut keys CTRL+SHIFT+D. + /// The shortcut keys CTRL+SHIFT+D. /// CtrlShiftD = Keys.Control + Keys.Shift + Keys.D, /// - /// The shortcut keys CTRL+SHIFT+E. + /// The shortcut keys CTRL+SHIFT+E. /// CtrlShiftE = Keys.Control + Keys.Shift + Keys.E, /// - /// The shortcut keys CTRL+SHIFT+F. + /// The shortcut keys CTRL+SHIFT+F. /// CtrlShiftF = Keys.Control + Keys.Shift + Keys.F, /// - /// The shortcut keys CTRL+SHIFT+G. + /// The shortcut keys CTRL+SHIFT+G. /// CtrlShiftG = Keys.Control + Keys.Shift + Keys.G, /// - /// The shortcut keys CTRL+SHIFT+H. + /// The shortcut keys CTRL+SHIFT+H. /// CtrlShiftH = Keys.Control + Keys.Shift + Keys.H, /// - /// The shortcut keys CTRL+SHIFT+I. + /// The shortcut keys CTRL+SHIFT+I. /// CtrlShiftI = Keys.Control + Keys.Shift + Keys.I, /// - /// The shortcut keys CTRL+SHIFT+J. + /// The shortcut keys CTRL+SHIFT+J. /// CtrlShiftJ = Keys.Control + Keys.Shift + Keys.J, /// - /// The shortcut keys CTRL+SHIFT+K. + /// The shortcut keys CTRL+SHIFT+K. /// CtrlShiftK = Keys.Control + Keys.Shift + Keys.K, /// - /// The shortcut keys CTRL+SHIFT+L. + /// The shortcut keys CTRL+SHIFT+L. /// CtrlShiftL = Keys.Control + Keys.Shift + Keys.L, /// - /// The shortcut keys CTRL+SHIFT+M. + /// The shortcut keys CTRL+SHIFT+M. /// CtrlShiftM = Keys.Control + Keys.Shift + Keys.M, /// - /// The shortcut keys CTRL+SHIFT+N. + /// The shortcut keys CTRL+SHIFT+N. /// CtrlShiftN = Keys.Control + Keys.Shift + Keys.N, /// - /// The shortcut keys CTRL+SHIFT+O. + /// The shortcut keys CTRL+SHIFT+O. /// CtrlShiftO = Keys.Control + Keys.Shift + Keys.O, /// - /// The shortcut keys CTRL+SHIFT+P. + /// The shortcut keys CTRL+SHIFT+P. /// CtrlShiftP = Keys.Control + Keys.Shift + Keys.P, /// - /// The shortcut keys CTRL+SHIFT+Q. + /// The shortcut keys CTRL+SHIFT+Q. /// CtrlShiftQ = Keys.Control + Keys.Shift + Keys.Q, /// - /// The shortcut keys CTRL+SHIFT+R. + /// The shortcut keys CTRL+SHIFT+R. /// CtrlShiftR = Keys.Control + Keys.Shift + Keys.R, /// - /// The shortcut keys CTRL+SHIFT+S. + /// The shortcut keys CTRL+SHIFT+S. /// CtrlShiftS = Keys.Control + Keys.Shift + Keys.S, /// - /// The shortcut keys CTRL+SHIFT+T. + /// The shortcut keys CTRL+SHIFT+T. /// CtrlShiftT = Keys.Control + Keys.Shift + Keys.T, /// - /// The shortcut keys CTRL+SHIFT+U. + /// The shortcut keys CTRL+SHIFT+U. /// CtrlShiftU = Keys.Control + Keys.Shift + Keys.U, /// - /// The shortcut keys CTRL+SHIFT+V. + /// The shortcut keys CTRL+SHIFT+V. /// CtrlShiftV = Keys.Control + Keys.Shift + Keys.V, /// - /// The shortcut keys CTRL+SHIFT+W. + /// The shortcut keys CTRL+SHIFT+W. /// CtrlShiftW = Keys.Control + Keys.Shift + Keys.W, /// - /// The shortcut keys CTRL+SHIFT+X. + /// The shortcut keys CTRL+SHIFT+X. /// CtrlShiftX = Keys.Control + Keys.Shift + Keys.X, /// - /// The shortcut keys CTRL+SHIFT+Y. + /// The shortcut keys CTRL+SHIFT+Y. /// CtrlShiftY = Keys.Control + Keys.Shift + Keys.Y, /// - /// The shortcut keys CTRL+SHIFT+Z. + /// The shortcut keys CTRL+SHIFT+Z. /// CtrlShiftZ = Keys.Control + Keys.Shift + Keys.Z, /// - /// The shortcut key F1. + /// The shortcut key F1. /// F1 = Keys.F1, /// - /// The shortcut key F2. + /// The shortcut key F2. /// F2 = Keys.F2, /// - /// The shortcut key F3. + /// The shortcut key F3. /// F3 = Keys.F3, /// - /// The shortcut key F4. + /// The shortcut key F4. /// F4 = Keys.F4, /// - /// The shortcut key F5. + /// The shortcut key F5. /// F5 = Keys.F5, /// - /// The shortcut key F6. + /// The shortcut key F6. /// F6 = Keys.F6, /// - /// The shortcut key F7. + /// The shortcut key F7. /// F7 = Keys.F7, F8 = Keys.F8, /// - /// The shortcut key F9. + /// The shortcut key F9. /// F9 = Keys.F9, /// - /// The shortcut key F10. + /// The shortcut key F10. /// F10 = Keys.F10, /// - /// The shortcut key F11. + /// The shortcut key F11. /// F11 = Keys.F11, /// - /// The shortcut key F12. + /// The shortcut key F12. /// F12 = Keys.F12, /// - /// The shortcut keys SHIFT+F1. + /// The shortcut keys SHIFT+F1. /// ShiftF1 = Keys.Shift + Keys.F1, /// - /// The shortcut keys SHIFT+F2. + /// The shortcut keys SHIFT+F2. /// ShiftF2 = Keys.Shift + Keys.F2, /// - /// The shortcut keys SHIFT+F3. + /// The shortcut keys SHIFT+F3. /// ShiftF3 = Keys.Shift + Keys.F3, /// - /// The shortcut keys SHIFT+F4. + /// The shortcut keys SHIFT+F4. /// ShiftF4 = Keys.Shift + Keys.F4, /// - /// The shortcut keys SHIFT+F5. + /// The shortcut keys SHIFT+F5. /// ShiftF5 = Keys.Shift + Keys.F5, /// - /// The shortcut keys SHIFT+F6. + /// The shortcut keys SHIFT+F6. /// ShiftF6 = Keys.Shift + Keys.F6, /// - /// The shortcut keys SHIFT+F7. + /// The shortcut keys SHIFT+F7. /// ShiftF7 = Keys.Shift + Keys.F7, /// - /// The shortcut keys SHIFT+F8. + /// The shortcut keys SHIFT+F8. /// ShiftF8 = Keys.Shift + Keys.F8, /// - /// The shortcut keys SHIFT+F9. + /// The shortcut keys SHIFT+F9. /// ShiftF9 = Keys.Shift + Keys.F9, /// - /// The shortcut keys SHIFT+F10. + /// The shortcut keys SHIFT+F10. /// ShiftF10 = Keys.Shift + Keys.F10, /// - /// The shortcut keys SHIFT+F11. + /// The shortcut keys SHIFT+F11. /// ShiftF11 = Keys.Shift + Keys.F11, /// - /// The shortcut keys SHIFT+F12. + /// The shortcut keys SHIFT+F12. /// ShiftF12 = Keys.Shift + Keys.F12, /// - /// The shortcut keys CTRL+F1. + /// The shortcut keys CTRL+F1. /// CtrlF1 = Keys.Control + Keys.F1, /// - /// The shortcut keys CTRL+F2. + /// The shortcut keys CTRL+F2. /// CtrlF2 = Keys.Control + Keys.F2, /// - /// The shortcut keys CTRL+F3. + /// The shortcut keys CTRL+F3. /// CtrlF3 = Keys.Control + Keys.F3, /// - /// The shortcut keys CTRL+F4. + /// The shortcut keys CTRL+F4. /// CtrlF4 = Keys.Control + Keys.F4, /// - /// The shortcut keys CTRL+F5. + /// The shortcut keys CTRL+F5. /// CtrlF5 = Keys.Control + Keys.F5, /// - /// The shortcut keys CTRL+F6. + /// The shortcut keys CTRL+F6. /// CtrlF6 = Keys.Control + Keys.F6, /// - /// The shortcut keys CTRL+F7. + /// The shortcut keys CTRL+F7. /// CtrlF7 = Keys.Control + Keys.F7, /// - /// The shortcut keys CTRL+F8. + /// The shortcut keys CTRL+F8. /// CtrlF8 = Keys.Control + Keys.F8, /// - /// The shortcut keys CTRL+F9. + /// The shortcut keys CTRL+F9. /// CtrlF9 = Keys.Control + Keys.F9, /// - /// The shortcut keys CTRL+F10. + /// The shortcut keys CTRL+F10. /// CtrlF10 = Keys.Control + Keys.F10, /// - /// The shortcut keys CTRL+F11. + /// The shortcut keys CTRL+F11. /// CtrlF11 = Keys.Control + Keys.F11, /// - /// The shortcut keys CTRL+F12. + /// The shortcut keys CTRL+F12. /// CtrlF12 = Keys.Control + Keys.F12, /// - /// The shortcut keys CTRL+SHIFT+F1. + /// The shortcut keys CTRL+SHIFT+F1. /// CtrlShiftF1 = Keys.Control + Keys.Shift + Keys.F1, /// - /// The shortcut keys CTRL+SHIFT+F2. + /// The shortcut keys CTRL+SHIFT+F2. /// CtrlShiftF2 = Keys.Control + Keys.Shift + Keys.F2, /// - /// The shortcut keys CTRL+SHIFT+F3. + /// The shortcut keys CTRL+SHIFT+F3. /// CtrlShiftF3 = Keys.Control + Keys.Shift + Keys.F3, /// - /// The shortcut keys CTRL+SHIFT+F4. + /// The shortcut keys CTRL+SHIFT+F4. /// CtrlShiftF4 = Keys.Control + Keys.Shift + Keys.F4, /// - /// The shortcut keys CTRL+SHIFT+F5. + /// The shortcut keys CTRL+SHIFT+F5. /// CtrlShiftF5 = Keys.Control + Keys.Shift + Keys.F5, /// - /// The shortcut keys CTRL+SHIFT+F6. + /// The shortcut keys CTRL+SHIFT+F6. /// CtrlShiftF6 = Keys.Control + Keys.Shift + Keys.F6, /// - /// The shortcut keys CTRL+SHIFT+F7. + /// The shortcut keys CTRL+SHIFT+F7. /// CtrlShiftF7 = Keys.Control + Keys.Shift + Keys.F7, /// - /// The shortcut keys CTRL+SHIFT+F8. + /// The shortcut keys CTRL+SHIFT+F8. /// CtrlShiftF8 = Keys.Control + Keys.Shift + Keys.F8, /// - /// The shortcut keys CTRL+SHIFT+F9. + /// The shortcut keys CTRL+SHIFT+F9. /// CtrlShiftF9 = Keys.Control + Keys.Shift + Keys.F9, /// - /// The shortcut keys CTRL+SHIFT+F10. + /// The shortcut keys CTRL+SHIFT+F10. /// CtrlShiftF10 = Keys.Control + Keys.Shift + Keys.F10, /// - /// The shortcut keys CTRL+SHIFT+F11. + /// The shortcut keys CTRL+SHIFT+F11. /// CtrlShiftF11 = Keys.Control + Keys.Shift + Keys.F11, /// - /// The shortcut keys CTRL+SHIFT+F12. + /// The shortcut keys CTRL+SHIFT+F12. /// CtrlShiftF12 = Keys.Control + Keys.Shift + Keys.F12, /// - /// The shortcut key INSERT. + /// The shortcut key INSERT. /// Ins = Keys.Insert, /// - /// The shortcut keys CTRL+INSERT. + /// The shortcut keys CTRL+INSERT. /// CtrlIns = Keys.Control + Keys.Insert, /// - /// The shortcut keys SHIFT+INSERT. + /// The shortcut keys SHIFT+INSERT. /// ShiftIns = Keys.Shift + Keys.Insert, /// - /// The shortcut key DELETE. + /// The shortcut key DELETE. /// Del = Keys.Delete, /// - /// The shortcut keys CTRL+DELETE. + /// The shortcut keys CTRL+DELETE. /// CtrlDel = Keys.Control + Keys.Delete, /// - /// The shortcut keys SHIFT+DELETE. + /// The shortcut keys SHIFT+DELETE. /// ShiftDel = Keys.Shift + Keys.Delete, /// - /// The shortcut keys Alt + RightArrow. + /// The shortcut keys Alt + RightArrow. /// AltRightArrow = Keys.Alt + Keys.Right, /// - /// The shortcut keys ALT+LeftArrow. + /// The shortcut keys ALT+LeftArrow. /// AltLeftArrow = Keys.Alt + Keys.Left, /// - /// The shortcut keys ALT+UpArrow. + /// The shortcut keys ALT+UpArrow. /// AltUpArrow = Keys.Alt + Keys.Up, /// - /// The shortcut keys Alt + DownArrow. + /// The shortcut keys Alt + DownArrow. /// AltDownArrow = Keys.Alt + Keys.Down, /// - /// The shortcut keys ALT+BACKSPACE. + /// The shortcut keys ALT+BACKSPACE. /// AltBksp = Keys.Alt + Keys.Back, /// - /// The shortcut keys ALT+F1. + /// The shortcut keys ALT+F1. /// AltF1 = Keys.Alt + Keys.F1, /// - /// The shortcut keys ALT+F2. + /// The shortcut keys ALT+F2. /// AltF2 = Keys.Alt + Keys.F2, /// - /// The shortcut keys ALT+F3. + /// The shortcut keys ALT+F3. /// AltF3 = Keys.Alt + Keys.F3, /// - /// The shortcut keys ALT+F4. + /// The shortcut keys ALT+F4. /// AltF4 = Keys.Alt + Keys.F4, /// - /// The shortcut keys ALT+F5. + /// The shortcut keys ALT+F5. /// AltF5 = Keys.Alt + Keys.F5, /// - /// The shortcut keys ALT+F6. + /// The shortcut keys ALT+F6. /// AltF6 = Keys.Alt + Keys.F6, /// - /// The shortcut keys ALT+F7. + /// The shortcut keys ALT+F7. /// AltF7 = Keys.Alt + Keys.F7, /// - /// The shortcut keys ALT+F8. + /// The shortcut keys ALT+F8. /// AltF8 = Keys.Alt + Keys.F8, /// - /// The shortcut keys ALT+F9. + /// The shortcut keys ALT+F9. /// AltF9 = Keys.Alt + Keys.F9, /// - /// The shortcut keys ALT+F10. + /// The shortcut keys ALT+F10. /// AltF10 = Keys.Alt + Keys.F10, /// - /// The shortcut keys ALT+F11. + /// The shortcut keys ALT+F11. /// AltF11 = Keys.Alt + Keys.F11, /// - /// The shortcut keys ALT+F12. + /// The shortcut keys ALT+F12. /// AltF12 = Keys.Alt + Keys.F12, /// - /// The shortcut keys ALT+0. + /// The shortcut keys ALT+0. /// Alt0 = Keys.Alt + Keys.D0, /// - /// The shortcut keys ALT+1. + /// The shortcut keys ALT+1. /// Alt1 = Keys.Alt + Keys.D1, /// - /// The shortcut keys ALT+2. + /// The shortcut keys ALT+2. /// Alt2 = Keys.Alt + Keys.D2, /// - /// The shortcut keys ALT+3. + /// The shortcut keys ALT+3. /// Alt3 = Keys.Alt + Keys.D3, /// - /// The shortcut keys ALT+4. + /// The shortcut keys ALT+4. /// Alt4 = Keys.Alt + Keys.D4, /// - /// The shortcut keys ALT+5. + /// The shortcut keys ALT+5. /// Alt5 = Keys.Alt + Keys.D5, /// - /// The shortcut keys ALT+6. + /// The shortcut keys ALT+6. /// Alt6 = Keys.Alt + Keys.D6, /// - /// The shortcut keys ALT+7. + /// The shortcut keys ALT+7. /// Alt7 = Keys.Alt + Keys.D7, /// - /// The shortcut keys ALT+8. + /// The shortcut keys ALT+8. /// Alt8 = Keys.Alt + Keys.D8, /// - /// The shortcut keys ALT+9. + /// The shortcut keys ALT+9. /// Alt9 = Keys.Alt + Keys.D9, /// - /// The shortcut keys CTRL+0. + /// The shortcut keys CTRL+0. /// Ctrl0 = Keys.Control + Keys.D0, /// - /// The shortcut keys CTRL+1. + /// The shortcut keys CTRL+1. /// Ctrl1 = Keys.Control + Keys.D1, /// - /// The shortcut keys CTRL+2. + /// The shortcut keys CTRL+2. /// Ctrl2 = Keys.Control + Keys.D2, /// - /// The shortcut keys CTRL+3. + /// The shortcut keys CTRL+3. /// Ctrl3 = Keys.Control + Keys.D3, /// - /// The shortcut keys CTRL+4. + /// The shortcut keys CTRL+4. /// Ctrl4 = Keys.Control + Keys.D4, /// - /// The shortcut keys CTRL+5. + /// The shortcut keys CTRL+5. /// Ctrl5 = Keys.Control + Keys.D5, /// - /// The shortcut keys CTRL+6. + /// The shortcut keys CTRL+6. /// Ctrl6 = Keys.Control + Keys.D6, /// - /// The shortcut keys CTRL+7. + /// The shortcut keys CTRL+7. /// Ctrl7 = Keys.Control + Keys.D7, /// - /// The shortcut keys CTRL+8. + /// The shortcut keys CTRL+8. /// Ctrl8 = Keys.Control + Keys.D8, /// - /// The shortcut keys CTRL+9. + /// The shortcut keys CTRL+9. /// Ctrl9 = Keys.Control + Keys.D9, /// - /// The shortcut keys CTRL+SHIFT+0. + /// The shortcut keys CTRL+SHIFT+0. /// CtrlShift0 = Keys.Control + Keys.Shift + Keys.D0, /// - /// The shortcut keys CTRL+SHIFT+1. + /// The shortcut keys CTRL+SHIFT+1. /// CtrlShift1 = Keys.Control + Keys.Shift + Keys.D1, /// - /// The shortcut keys CTRL+SHIFT+2. + /// The shortcut keys CTRL+SHIFT+2. /// CtrlShift2 = Keys.Control + Keys.Shift + Keys.D2, /// - /// The shortcut keys CTRL+SHIFT+3. + /// The shortcut keys CTRL+SHIFT+3. /// CtrlShift3 = Keys.Control + Keys.Shift + Keys.D3, /// - /// The shortcut keys CTRL+SHIFT+4. + /// The shortcut keys CTRL+SHIFT+4. /// CtrlShift4 = Keys.Control + Keys.Shift + Keys.D4, /// - /// The shortcut keys CTRL+SHIFT+5. + /// The shortcut keys CTRL+SHIFT+5. /// CtrlShift5 = Keys.Control + Keys.Shift + Keys.D5, /// - /// The shortcut keys CTRL+SHIFT+6. + /// The shortcut keys CTRL+SHIFT+6. /// CtrlShift6 = Keys.Control + Keys.Shift + Keys.D6, /// - /// The shortcut keys CTRL+SHIFT+7. + /// The shortcut keys CTRL+SHIFT+7. /// CtrlShift7 = Keys.Control + Keys.Shift + Keys.D7, /// - /// The shortcut keys CTRL+SHIFT+8. + /// The shortcut keys CTRL+SHIFT+8. /// CtrlShift8 = Keys.Control + Keys.Shift + Keys.D8, /// - /// The shortcut keys CTRL+SHIFT+9. + /// The shortcut keys CTRL+SHIFT+9. /// CtrlShift9 = Keys.Control + Keys.Shift + Keys.D9, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SizeGripStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SizeGripStyle.cs index c1aaea3cc96..415fe10628e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SizeGripStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SizeGripStyle.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Specifies the style of the sizing grip on a . + /// Specifies the style of the sizing grip on a . /// public enum SizeGripStyle { /// - /// The size grip is automatically display when needed. + /// The size grip is automatically display when needed. /// Auto = 0, /// - /// The sizing grip is always shown on the form. + /// The sizing grip is always shown on the form. /// Show = 1, /// - /// The sizing grip is hidden. + /// The sizing grip is hidden. /// Hide = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SortOrder.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SortOrder.cs index ff64e12ee78..f79ed3f5ad4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SortOrder.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SortOrder.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Specifies how items in a list are sorted. + /// Specifies how items in a list are sorted. /// public enum SortOrder { /// - /// The items are not sorted. + /// The items are not sorted. /// None = 0, /// - /// The items are sorted in ascending order. + /// The items are sorted in ascending order. /// Ascending = 1, /// - /// The items are sorted in descending order. + /// The items are sorted in descending order. /// Descending = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SpecialFolderEnumConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SpecialFolderEnumConverter.cs index b5a9f9cf29a..4cdfe134c1d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SpecialFolderEnumConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SpecialFolderEnumConverter.cs @@ -14,8 +14,8 @@ public SpecialFolderEnumConverter(Type type) : base(type) } /// - /// Personal appears twice in type editor because its numeric value matches with MyDocuments. - /// This code filters out the duplicate value. + /// Personal appears twice in type editor because its numeric value matches with MyDocuments. + /// This code filters out the duplicate value. /// public override StandardValuesCollection GetStandardValues(ITypeDescriptorContext context) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitContainer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitContainer.cs index b8291867f7b..6c7e56ffaff 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitContainer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitContainer.cs @@ -151,7 +151,6 @@ public SplitContainer() //PROPERTIES START IN ALPHABETICAL ORDER // // // ///////////////////////////////////////////////////////////////////////////////////////////// - /// /// This property is overridden to allow the AutoScroll to be set on all the panels when /// The autoScroll on SplitContainer is shown. @@ -492,7 +491,7 @@ public FixedPanel FixedPanel } /// - /// This property determines whether the the splitter can move. + /// This property determines whether the the splitter can move. /// [ SRCategory(nameof(SR.CatLayout)), @@ -540,7 +539,7 @@ internal override bool IsContainerControl } /// - /// This Property sets or gets if the splitter is vertical or horizontal. + /// This Property sets or gets if the splitter is vertical or horizontal. /// [ SRCategory(nameof(SR.CatBehavior)), @@ -597,7 +596,7 @@ private Cursor OverrideCursor } /// - /// Indicates if either panel is collapsed + /// Indicates if either panel is collapsed /// private bool CollapsedMode { @@ -608,7 +607,7 @@ private bool CollapsedMode } /// - /// The Left or Top panel in the SplitContainer. + /// The Left or Top panel in the SplitContainer. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -665,7 +664,7 @@ private void CollapsePanel(SplitterPanel p, bool collapsing) } /// - /// Collapses or restores panel1 + /// Collapses or restores panel1 /// [ SRCategory(nameof(SR.CatLayout)), @@ -692,7 +691,7 @@ public bool Panel1Collapsed } /// - /// Collapses or restores panel2 + /// Collapses or restores panel2 /// [ SRCategory(nameof(SR.CatLayout)), @@ -719,7 +718,7 @@ public bool Panel2Collapsed } /// - /// This property determines the minimum distance of pixels of the splitter from the left or the top edge of Panel1. + /// This property determines the minimum distance of pixels of the splitter from the left or the top edge of Panel1. /// [ SRCategory(nameof(SR.CatLayout)), @@ -745,7 +744,7 @@ public int Panel1MinSize } /// - /// This is the Right or Bottom panel in the SplitContainer. + /// This is the Right or Bottom panel in the SplitContainer. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -762,7 +761,7 @@ public SplitterPanel Panel2 } /// - /// This property determines the minimum distance of pixels of the splitter from the right or the bottom edge of Panel2 + /// This property determines the minimum distance of pixels of the splitter from the right or the bottom edge of Panel2 /// [ SRCategory(nameof(SR.CatLayout)), @@ -788,7 +787,7 @@ public int Panel2MinSize } /// - /// This property determines pixel distance of the splitter from the left or top edge. + /// This property determines pixel distance of the splitter from the left or top edge. /// [ SRCategory(nameof(SR.CatLayout)), @@ -897,7 +896,7 @@ private int SplitterDistanceInternal } /// - /// This determines the number of pixels the splitter moves in increments.This is defaulted to 1. + /// This determines the number of pixels the splitter moves in increments.This is defaulted to 1. /// [ SRCategory(nameof(SR.CatLayout)), @@ -924,7 +923,7 @@ public int SplitterIncrement } /// - /// This property determines the rectangle bounds of the splitter. + /// This property determines the rectangle bounds of the splitter. /// [ SRCategory(nameof(SR.CatLayout)), @@ -943,7 +942,7 @@ public Rectangle SplitterRectangle } /// - /// This property determines the thickness of the splitter. + /// This property determines the thickness of the splitter. /// [ SRCategory(nameof(SR.CatLayout)), @@ -1024,13 +1023,11 @@ public override string Text //END PROPERTIES // // // ///////////////////////////////////////////////////////////////////////////////////////////// - ///////////////////////////////////////////////////////////////////////////////////////////// // // //Start PUBLIC FUNCTIONS // // // ///////////////////////////////////////////////////////////////////////////////////////////// - /// /// ISupportInitialize support. Disables splitter panel min size and splitter width /// validation during initialization. @@ -1068,13 +1065,11 @@ public void EndInit() //End PUBLIC FUNCTIONS // // // ///////////////////////////////////////////////////////////////////////////////////////////// - ///////////////////////////////////////////////////////////////////////////////////////////// // // //Start EVENT HANDLERS // // // ///////////////////////////////////////////////////////////////////////////////////////////// - [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)] new public event EventHandler BackgroundImageChanged { @@ -1115,13 +1110,11 @@ public event SplitterEventHandler SplitterMoved //End EVENT HANDLERS // // // ///////////////////////////////////////////////////////////////////////////////////////////// - ///////////////////////////////////////////////////////////////////////////////////////////// // // //start EVENT Delegates // // // ///////////////////////////////////////////////////////////////////////////////////////////// - /// /// Overides the Control.OnGotFocus to Invalidate... /// @@ -1271,7 +1264,7 @@ protected override void OnLostFocus(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnMouseMove(MouseEventArgs e) @@ -1329,7 +1322,7 @@ protected override void OnMouseMove(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseLeave(EventArgs e) { @@ -1342,7 +1335,7 @@ protected override void OnMouseLeave(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -1380,7 +1373,7 @@ protected override void OnMouseDown(MouseEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseUp(MouseEventArgs e) { @@ -1455,7 +1448,6 @@ public void OnSplitterMoved(SplitterEventArgs e) ///END DELEGATES // // // //////////////////////////////////////////////////////////////////////////////////////////////// - [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnRightToLeftChanged(EventArgs e) { @@ -1471,7 +1463,6 @@ protected override void OnRightToLeftChanged(EventArgs e) ///START PRIVATE FUNCTIONS // // // //////////////////////////////////////////////////////////////////////////////////////////////// - /// /// Validate and set the minimum size for Panel1. /// @@ -2492,13 +2483,11 @@ private void WmSetCursor(ref Message m) // END PRIVATE FUNCTIONS ... // // // /////////////////////////////////////////////////////////////////////////////////////////////////// - /////////////////////////////////////////////////////////////////////////////////////////////////// // // // Start PROTECTED OVERRIDE FUNCTIONS // // // /////////////////////////////////////////////////////////////////////////////////////////////////// - internal override Rectangle GetToolNativeScreenRectangle() { // Return splitter rectangle instead of the whole container rectangle to be consistent with the mouse ToolTip @@ -2567,7 +2556,7 @@ protected override bool ProcessDialogKey(Keys keyData) return base.ProcessDialogKey(keyData); } - /// /// + /// /// /// This will process the TabKey for the SplitContainer. The Focus needs to Shift from controls to the Left of the Splitter /// to the splitter and then to the controls on the right of the splitter. This override implements this Logic. /// @@ -2663,7 +2652,6 @@ protected override ControlCollection CreateControlsInstance() // End PROTECTED OVERRIDE FUNCTIONS // // // /////////////////////////////////////////////////////////////////////////////////////////////////// - private class SplitContainerMessageFilter : IMessageFilter { private readonly SplitContainer owner = null; @@ -2696,8 +2684,8 @@ bool IMessageFilter.PreFilterMessage(ref Message m) } /// - /// This control collection only allows a specific type of control - /// into the controls collection. It optionally supports readonlyness. + /// This control collection only allows a specific type of control + /// into the controls collection. It optionally supports readonlyness. /// internal class SplitContainerTypedControlCollection : WindowsFormsUtils.TypedControlCollection { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventArgs.cs index ac247ab48ab..f7cb692d17f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventArgs.cs @@ -7,13 +7,13 @@ namespace System.Windows.Forms { /// - /// Provides data for splitter events. + /// Provides data for splitter events. /// public class SplitterCancelEventArgs : CancelEventArgs { /// - /// Initializes an instance of the class with the specified coordinates - /// of the mouse pointer and the upper-left corner of the . + /// Initializes an instance of the class with the specified coordinates + /// of the mouse pointer and the upper-left corner of the . /// public SplitterCancelEventArgs(int mouseCursorX, int mouseCursorY, int splitX, int splitY) : base(false) { @@ -24,22 +24,22 @@ public SplitterCancelEventArgs(int mouseCursorX, int mouseCursorY, int splitX, i } /// - /// Gets the x-coordinate of the mouse pointer (in client coordinates). + /// Gets the x-coordinate of the mouse pointer (in client coordinates). /// public int MouseCursorX { get; } /// - /// Gets the y-coordinate of the mouse pointer (in client coordinates). + /// Gets the y-coordinate of the mouse pointer (in client coordinates). /// public int MouseCursorY { get; } /// - /// Gets the x-coordinate of the upper-left corner of the (in client coordinates). + /// Gets the x-coordinate of the upper-left corner of the (in client coordinates). /// public int SplitX { get; set; } /// - /// Gets the y-coordinate of the upper-left corner of the (in client coordinates). + /// Gets the y-coordinate of the upper-left corner of the (in client coordinates). /// public int SplitY { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventHandler.cs index a49aa714bf3..532ece26553 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterCancelEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle splitter events. + /// Represents a method that will handle splitter events. /// public delegate void SplitterCancelEventHandler(object sender, SplitterCancelEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventArgs.cs index 95ebfe5cb5e..00595cb2393 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventArgs.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides data for splitter events. + /// Provides data for splitter events. /// [ComVisible(true)] public class SplitterEventArgs : EventArgs { /// - /// Initializes an instance of the class with the specified coordinates - /// of the mouse pointer and the upper-left corner of the . + /// Initializes an instance of the class with the specified coordinates + /// of the mouse pointer and the upper-left corner of the . /// public SplitterEventArgs(int x, int y, int splitX, int splitY) { @@ -25,22 +25,22 @@ public SplitterEventArgs(int x, int y, int splitX, int splitY) } /// - /// Gets the x-coordinate of the mouse pointer (in client coordinates). + /// Gets the x-coordinate of the mouse pointer (in client coordinates). /// public int X { get; } /// - /// Gets the y-coordinate of the mouse pointer (in client coordinates). + /// Gets the y-coordinate of the mouse pointer (in client coordinates). /// public int Y { get; } /// - /// Gets the x-coordinate of the upper-left corner of the (in client coordinates). + /// Gets the x-coordinate of the upper-left corner of the (in client coordinates). /// public int SplitX { get; set; } /// - /// Gets the y-coordinate of the upper-left corner of the (in client coordinates). + /// Gets the y-coordinate of the upper-left corner of the (in client coordinates). /// public int SplitY { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventHandler.cs index be000550ea1..e062c4e16d8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle splitter events. + /// Represents a method that will handle splitter events. /// public delegate void SplitterEventHandler(object sender, SplitterEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterPanel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterPanel.cs index 6cd372268e3..30963ae7692 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SplitterPanel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SplitterPanel.cs @@ -223,8 +223,8 @@ internal int HeightInternal } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected override Padding DefaultMargin { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventArgs.cs index f086227e449..a101b2e1396 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventArgs.cs @@ -7,14 +7,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. + /// Provides data for the + /// event. /// public class StatusBarDrawItemEventArgs : DrawItemEventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public StatusBarDrawItemEventArgs(Graphics g, Font font, Rectangle r, int itemId, DrawItemState itemState, StatusBarPanel panel) @@ -24,8 +24,8 @@ public StatusBarDrawItemEventArgs(Graphics g, Font font, Rectangle r, int itemId } /// - /// Initializes a new instance of the - /// class using the Forecolor and Backcolor. + /// Initializes a new instance of the + /// class using the Forecolor and Backcolor. /// public StatusBarDrawItemEventArgs(Graphics g, Font font, Rectangle r, int itemId, DrawItemState itemState, StatusBarPanel panel, @@ -36,7 +36,7 @@ public StatusBarDrawItemEventArgs(Graphics g, Font font, Rectangle r, int itemId } /// - /// Specifies the to draw. + /// Specifies the to draw. /// public StatusBarPanel Panel { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventHandler.cs index 2768c07a70d..2e7d14bfdd0 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarDrawItemEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void StatusBarDrawItemEventHandler(object sender, StatusBarDrawItemEventArgs sbdevent); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelAutoSize.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelAutoSize.cs index ca22b24bbdf..a3c6dde8a54 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelAutoSize.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelAutoSize.cs @@ -5,24 +5,24 @@ namespace System.Windows.Forms { /// - /// Specifies how a panel on a status bar changes when the status bar resizes. + /// Specifies how a panel on a status bar changes when the status bar resizes. /// public enum StatusBarPanelAutoSize { /// - /// The panel does not change its size when the status bar resizes. + /// The panel does not change its size when the status bar resizes. /// None = 1, /// - /// The panel shares the available status bar space (the space not taken - /// up by panels with the and - /// settings) with other panels that have the setting. + /// The panel shares the available status bar space (the space not taken + /// up by panels with the and + /// settings) with other panels that have the setting. /// Spring = 2, /// - /// The width of the panel is determined by its contents. + /// The width of the panel is determined by its contents. /// Contents = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelBorderStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelBorderStyle.cs index 960ab1e8d65..d339f8f2d99 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelBorderStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelBorderStyle.cs @@ -10,17 +10,17 @@ namespace System.Windows.Forms public enum StatusBarPanelBorderStyle { /// - /// No border. + /// No border. /// None = 1, /// - /// A raised border. + /// A raised border. /// Raised = 2, /// - /// A sunken border. + /// A sunken border. /// Sunken = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelClickEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelClickEventArgs.cs index 3a5aafe26cd..bc7de6d276d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelClickEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelClickEventArgs.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. + /// Provides data for the + /// event. /// public class StatusBarPanelClickEventArgs : MouseEventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public StatusBarPanelClickEventArgs(StatusBarPanel statusBarPanel, MouseButtons button, int clicks, int x, int y) : base(button, clicks, x, y, 0) { @@ -20,7 +20,7 @@ public StatusBarPanelClickEventArgs(StatusBarPanel statusBarPanel, MouseButtons } /// - /// Specifies the that represents the clicked panel. + /// Specifies the that represents the clicked panel. /// public StatusBarPanel StatusBarPanel { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelStyle.cs index b29c69ea287..577bd23650f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusBarPanelStyle.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Specifies whether a panel on a status bar is owner drawn or system drawn. + /// Specifies whether a panel on a status bar is owner drawn or system drawn. /// public enum StatusBarPanelStyle { /// - /// The panel is drawn by the system. + /// The panel is drawn by the system. /// Text = 1, /// - /// The panel is drawn by the owner. + /// The panel is drawn by the owner. /// OwnerDraw = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/StatusStrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/StatusStrip.cs index 748b971025c..3a72257158c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/StatusStrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/StatusStrip.cs @@ -488,9 +488,9 @@ internal override bool ShouldSerializeRenderMode() } /// - /// Override this function if you want to do custom table layouts for the - /// StatusStrip. The default layoutstyle is tablelayout, and we need to play - /// with the row/column styles + /// Override this function if you want to do custom table layouts for the + /// StatusStrip. The default layoutstyle is tablelayout, and we need to play + /// with the row/column styles /// protected virtual void OnSpringTableLayoutCore() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/SystemParameter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/SystemParameter.cs index 9f5b53944c8..996f2b35857 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/SystemParameter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/SystemParameter.cs @@ -10,57 +10,57 @@ namespace System.Windows.Forms public enum SystemParameter { /// - /// DropShadow. + /// DropShadow. /// DropShadow = 0, /// - /// Flat Menu. + /// Flat Menu. /// FlatMenu = 1, /// - /// FontSmoothingContrastMetric. + /// FontSmoothingContrastMetric. /// FontSmoothingContrastMetric = 2, /// - /// FontSmoothingTypeMetric. + /// FontSmoothingTypeMetric. /// FontSmoothingTypeMetric = 3, /// - /// MenuFadeEnabled. + /// MenuFadeEnabled. /// MenuFadeEnabled = 4, /// - /// SelectionFade. + /// SelectionFade. /// SelectionFade = 5, /// - /// ToolTipAnimationMetric. + /// ToolTipAnimationMetric. /// ToolTipAnimationMetric = 6, /// - /// UIEffects. + /// UIEffects. /// UIEffects = 7, /// - /// CaretWidthMetric. + /// CaretWidthMetric. /// CaretWidthMetric = 8, /// - /// VerticalFocusThicknessMetric. + /// VerticalFocusThicknessMetric. /// VerticalFocusThicknessMetric = 9, /// - /// HorizontalFocusThicknessMetric. + /// HorizontalFocusThicknessMetric. /// HorizontalFocusThicknessMetric = 10, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabAlignment.cs index 4ffbcae0dab..62f5d539e13 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabAlignment.cs @@ -5,27 +5,27 @@ namespace System.Windows.Forms { /// - /// Controls where the tabs will be located in a Tab Control. + /// Controls where the tabs will be located in a Tab Control. /// public enum TabAlignment { /// - /// Tabs will be located across the top of the control. + /// Tabs will be located across the top of the control. /// Top = 0, /// - /// Tabs will be located across the bottom of the control. + /// Tabs will be located across the bottom of the control. /// Bottom = 1, /// - /// Tabs will be located along the left edge of the control. + /// Tabs will be located along the left edge of the control. /// Left = 2, /// - /// Tabs will be located along the right edge of the control. + /// Tabs will be located along the right edge of the control. /// Right = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabAppearance.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabAppearance.cs index bc1d3a8e62d..621cd45751f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabAppearance.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabAppearance.cs @@ -5,26 +5,26 @@ namespace System.Windows.Forms { /// - /// The various tab controls will let you configure their appearance. - /// This enumeration contains the possible values. + /// The various tab controls will let you configure their appearance. + /// This enumeration contains the possible values. /// public enum TabAppearance { /// - /// Indicates that the tabs look like normal tabs typically seen in Property - /// page type situations. + /// Indicates that the tabs look like normal tabs typically seen in Property + /// page type situations. /// Normal = 0, /// - /// Indicates that the tabs look like buttons as seen on the taskbar found - /// in Windows 95 or Windows NT. + /// Indicates that the tabs look like buttons as seen on the taskbar found + /// in Windows 95 or Windows NT. /// Buttons = 1, /// - /// Indicates that buttons should be draw flat instead of like regular - /// windows pushbuttons. + /// Indicates that buttons should be draw flat instead of like regular + /// windows pushbuttons. /// FlatButtons = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControl.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControl.cs index bce98062291..698ade8e085 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControl.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControl.cs @@ -2225,9 +2225,9 @@ protected override void WndProc(ref Message m) public class TabPageCollection : IList { private readonly TabControl owner; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; public TabPageCollection(TabControl owner) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlAction.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlAction.cs index b0256cf47a4..cb9c1551729 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlAction.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlAction.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// This enum is used to specify the action that caused a TreeViewEventArgs. + /// This enum is used to specify the action that caused a TreeViewEventArgs. /// public enum TabControlAction { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventArgs.cs index bf8b375f2d6..6cb93a6fdf5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the , + /// Provides data for the , /// event. /// public class TabControlCancelEventArgs : CancelEventArgs @@ -20,17 +20,17 @@ public TabControlCancelEventArgs(TabPage tabPage, int tabPageIndex, bool cancel, } /// - /// Stores the referemce to the tabpage that is undergoing the TabControl event. + /// Stores the referemce to the tabpage that is undergoing the TabControl event. /// public TabPage TabPage { get; } /// - /// Stores the index to the tabpage that is undergoing the TabControl event. + /// Stores the index to the tabpage that is undergoing the TabControl event. /// public int TabPageIndex { get; } /// - /// Stores the TabControl action which instigated the TabControl event. + /// Stores the TabControl action which instigated the TabControl event. /// public TabControlAction Action { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventHandler.cs index a8325a66a4f..2cd03fdf641 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlCancelEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that handles the , + /// Represents the method that handles the , /// event of a /// public delegate void TabControlCancelEventHandler(object sender, TabControlCancelEventArgs e); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventArgs.cs index 6b644c2e175..7b15f7e8e64 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventArgs.cs @@ -5,13 +5,13 @@ namespace System.Windows.Forms { /// - /// Provides data for the , - /// event. + /// Provides data for the , + /// event. /// public class TabControlEventArgs : EventArgs { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public TabControlEventArgs(TabPage tabPage, int tabPageIndex, TabControlAction action) { @@ -21,17 +21,17 @@ public TabControlEventArgs(TabPage tabPage, int tabPageIndex, TabControlAction a } /// - /// Stores the referemce to the tabpage that is undergoing the TabControl event. + /// Stores the referemce to the tabpage that is undergoing the TabControl event. /// public TabPage TabPage { get; } /// - /// Stores the index to the tabpage that is undergoing the TabControl event. + /// Stores the index to the tabpage that is undergoing the TabControl event. /// public int TabPageIndex { get; } /// - /// Stores the TabControl action which instigated the TabControl event. + /// Stores the TabControl action which instigated the TabControl event. /// public TabControlAction Action { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventHandler.cs index 924ed60cd01..e8fae0cc3c6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabControlEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents the method that handles the , + /// Represents the method that handles the , /// event of a /// public delegate void TabControlEventHandler(object sender, TabControlEventArgs e); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabDrawMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabDrawMode.cs index 3fe4e53978a..412735592d4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabDrawMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabDrawMode.cs @@ -5,20 +5,20 @@ namespace System.Windows.Forms { /// - /// The TabStrip and TabControl both support ownerdraw functionality, but - /// only one type, in which you can paint the tabs individually. This - /// enumeration contains the valid values for it's drawMode property. + /// The TabStrip and TabControl both support ownerdraw functionality, but + /// only one type, in which you can paint the tabs individually. This + /// enumeration contains the valid values for it's drawMode property. /// public enum TabDrawMode { /// - /// All the items in the control are painted by the system and are of the - /// same size + /// All the items in the control are painted by the system and are of the + /// same size /// Normal = 0, /// - /// The user paints the items in the control manually + /// The user paints the items in the control manually /// OwnerDrawFixed = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TabSizeMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TabSizeMode.cs index 3a8b661c59f..96d852a8b87 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TabSizeMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TabSizeMode.cs @@ -5,26 +5,26 @@ namespace System.Windows.Forms { /// - /// Controls the automatic sizing of certain objects. This is typically - /// used for the sizing of Tabs in a TabStrip control. + /// Controls the automatic sizing of certain objects. This is typically + /// used for the sizing of Tabs in a TabStrip control. /// public enum TabSizeMode { /// - /// Indicates that items are only as wide as they need to be to display - /// their information. Empty space on the right is left as such + /// Indicates that items are only as wide as they need to be to display + /// their information. Empty space on the right is left as such /// Normal = 0, /// - /// indicates that the tags are stretched to ensure they reach the far - /// right of the strip, if necesary. This is only applicable to tab - /// strips with more than one row. + /// indicates that the tags are stretched to ensure they reach the far + /// right of the strip, if necesary. This is only applicable to tab + /// strips with more than one row. /// FillToRight = 1, /// - /// Indicates that all tabs are the same width. period. + /// Indicates that all tabs are the same width. period. /// Fixed = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutCellPaintEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutCellPaintEventArgs.cs index 0a5242badd3..deb6d9e45dd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutCellPaintEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutCellPaintEventArgs.cs @@ -7,9 +7,9 @@ namespace System.Windows.Forms { /// - /// This is the overrided PaintEventArgs for painting the cell of the table - /// It contains additional information indicating the row/column of the cell - /// as well as the bound of the cell + /// This is the overrided PaintEventArgs for painting the cell of the table + /// It contains additional information indicating the row/column of the cell + /// as well as the bound of the cell /// public class TableLayoutCellPaintEventArgs : PaintEventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanel.cs index a97445efd4f..e307a86a530 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanel.cs @@ -122,9 +122,9 @@ private int CellBorderWidth } /// - /// This sets the maximum number of columns allowed on this table instead of allocating - /// actual spaces for these columns. So it is OK to set ColumnCount to Int32.MaxValue without - /// causing out of memory exception + /// This sets the maximum number of columns allowed on this table instead of allocating + /// actual spaces for these columns. So it is OK to set ColumnCount to Int32.MaxValue without + /// causing out of memory exception /// [SRDescription(nameof(SR.GridPanelColumnsDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -161,9 +161,9 @@ public TableLayoutPanelGrowStyle GrowStyle } /// - /// This sets the maximum number of rows allowed on this table instead of allocating - /// actual spaces for these rows. So it is OK to set RowCount to Int32.MaxValue without - /// causing out of memory exception + /// This sets the maximum number of rows allowed on this table instead of allocating + /// actual spaces for these rows. So it is OK to set RowCount to Int32.MaxValue without + /// causing out of memory exception /// [SRDescription(nameof(SR.GridPanelRowsDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -301,7 +301,7 @@ public void SetColumn(Control control, int column) } /// - /// get the control which covers the specified row and column. return null if we can't find one + /// get the control which covers the specified row and column. return null if we can't find one /// public Control GetControlFromPosition(int column, int row) { @@ -314,7 +314,7 @@ public TableLayoutPanelCellPosition GetPositionFromControl(Control control) } /// - /// This returns an array representing the widths (in pixels) of the columns in the TableLayoutPanel. + /// This returns an array representing the widths (in pixels) of the columns in the TableLayoutPanel. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] public int[] GetColumnWidths() @@ -334,7 +334,7 @@ public int[] GetColumnWidths() } /// - /// This returns an array representing the heights (in pixels) of the rows in the TableLayoutPanel. + /// This returns an array representing the heights (in pixels) of the rows in the TableLayoutPanel. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] public int[] GetRowHeights() @@ -568,7 +568,7 @@ private void ScaleAbsoluteStyles(SizeF factor) } /// - /// Represents a collection of controls on the TableLayoutPanel. + /// Represents a collection of controls on the TableLayoutPanel. /// [ListBindable(false)] [DesignerSerializer("System.Windows.Forms.Design.TableLayoutControlCollectionCodeDomSerializer, " + AssemblyRef.SystemDesign, "System.ComponentModel.Design.Serialization.CodeDomSerializer, " + AssemblyRef.SystemDesign)] @@ -583,7 +583,7 @@ public TableLayoutControlCollection(TableLayoutPanel container) : base(container public TableLayoutPanel Container { get; } /// - /// Add control to cell (x, y) on the table. The control becomes absolutely positioned if neither x nor y is equal to -1 + /// Add control to cell (x, y) on the table. The control becomes absolutely positioned if neither x nor y is equal to -1 /// public virtual void Add(Control control, int column, int row) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanelGrowStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanelGrowStyle.cs index 62bfb5192b7..7e2329b5dfe 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanelGrowStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutPanelGrowStyle.cs @@ -5,26 +5,26 @@ namespace System.Windows.Forms { /// - /// Specifies if a TableLayoutPanel will gain additional rows or columns once - /// its existing cells become full. If the value is 'None' then the - /// TableLayoutPanel will throw an exception when the TableLayoutPanel is - /// over-filled. + /// Specifies if a TableLayoutPanel will gain additional rows or columns once + /// its existing cells become full. If the value is 'None' then the + /// TableLayoutPanel will throw an exception when the TableLayoutPanel is + /// over-filled. /// public enum TableLayoutPanelGrowStyle { /// - /// The TableLayoutPanel will not allow additional rows or columns once - /// it is full. + /// The TableLayoutPanel will not allow additional rows or columns once + /// it is full. /// FixedSize = 0, /// - /// The TableLayoutPanel will gain additional rows once it becomes full. + /// The TableLayoutPanel will gain additional rows once it becomes full. /// AddRows = 1, /// - /// The TableLayoutPanel will gain additional columns once it becomes full. + /// The TableLayoutPanel will gain additional columns once it becomes full. /// AddColumns = 2 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutSettings.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutSettings.cs index 67ebd291ffb..d06739bc422 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutSettings.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TableLayoutSettings.cs @@ -89,9 +89,9 @@ internal int CellBorderWidth } /// - /// This sets the maximum number of columns allowed on this table instead of allocating - /// actual spaces for these columns. So it is OK to set ColumnCount to Int32.MaxValue without - /// causing out of memory exception + /// This sets the maximum number of columns allowed on this table instead of allocating + /// actual spaces for these columns. So it is OK to set ColumnCount to Int32.MaxValue without + /// causing out of memory exception /// [SRDescription(nameof(SR.GridPanelColumnsDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -119,9 +119,9 @@ public int ColumnCount } /// - /// This sets the maximum number of rows allowed on this table instead of allocating - /// actual spaces for these rows. So it is OK to set RowCount to Int32.MaxValue without - /// causing out of memory exception + /// This sets the maximum number of rows allowed on this table instead of allocating + /// actual spaces for these rows. So it is OK to set RowCount to Int32.MaxValue without + /// causing out of memory exception /// [SRDescription(nameof(SR.GridPanelRowsDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -344,7 +344,7 @@ public void SetRowSpan(object control, int value) } /// - /// Get the row position of the element + /// Get the row position of the element /// [SRDescription(nameof(SR.GridPanelRowDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -369,9 +369,9 @@ public int GetRow(object control) } /// - /// Set the row position of the element - /// If we set the row position to -1, it will automatically switch the control from - /// absolutely positioned to non-absolutely positioned + /// Set the row position of the element + /// If we set the row position to -1, it will automatically switch the control from + /// absolutely positioned to non-absolutely positioned /// public void SetRow(object control, int row) { @@ -388,7 +388,7 @@ public void SetRow(object control, int row) } /// - /// Get the column position of the element + /// Get the column position of the element /// [SRDescription(nameof(SR.TableLayoutSettingsGetCellPositionDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -404,7 +404,7 @@ public TableLayoutPanelCellPosition GetCellPosition(object control) } /// - /// Set the column position of the element + /// Set the column position of the element /// [SRDescription(nameof(SR.TableLayoutSettingsSetCellPositionDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -420,7 +420,7 @@ public void SetCellPosition(object control, TableLayoutPanelCellPosition cellPos } /// - /// Get the column position of the element + /// Get the column position of the element /// [SRDescription(nameof(SR.GridPanelColumnDescr))] [SRCategory(nameof(SR.CatLayout))] @@ -445,9 +445,9 @@ public int GetColumn(object control) } /// - /// Set the column position of the element - /// If we set the column position to -1, it will automatically switch the control from - /// absolutely positioned to non-absolutely positioned + /// Set the column position of the element + /// If we set the column position to -1, it will automatically switch the control from + /// absolutely positioned to non-absolutely positioned /// public void SetColumn(object control, int column) { @@ -506,7 +506,7 @@ private void SetCellPosition(object control, int row, int column, bool rowSpecif } /// - /// Get the element which covers the specified row and column. return null if we can't find one + /// Get the element which covers the specified row and column. return null if we can't find one /// internal IArrangedElement GetControlFromPosition(int column, int row) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TextBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TextBox.cs index a5c4bc1b71b..4618b8e1aff 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TextBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TextBox.cs @@ -683,11 +683,11 @@ protected virtual void OnTextAlignChanged(EventArgs e) } /// - /// Process a command key. - /// Native "EDIT" control does not support "Select All" shorcut represented by Ctrl-A keys, when in multiline mode, - /// Winforms TextBox supports this in .NET. + /// Process a command key. + /// Native "EDIT" control does not support "Select All" shorcut represented by Ctrl-A keys, when in multiline mode, + /// Winforms TextBox supports this in .NET. /// m - the current windows message - /// keyData - bitmask containing one or more keys + /// keyData - bitmask containing one or more keys /// protected override bool ProcessCmdKey(ref Message m, Keys keyData) { @@ -882,7 +882,7 @@ public virtual string PlaceholderText //------------------------------------------------------------------------------------------------- /// - /// Draws the PlaceholderText in the client area of the TextBox using the default font and color. + /// Draws the PlaceholderText in the client area of the TextBox using the default font and color. /// private void DrawPlaceholderText(Graphics graphics) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TextBoxBase.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TextBoxBase.cs index 5038b487c2c..fb47a875222 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TextBoxBase.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TextBoxBase.cs @@ -57,8 +57,8 @@ public abstract class TextBoxBase : Control private BorderStyle borderStyle = System.Windows.Forms.BorderStyle.Fixed3D; /// - /// Controls the maximum length of text in the edit control. - /// Matches the Windows limit. + /// Controls the maximum length of text in the edit control. + /// Matches the Windows limit. /// private int maxLength = 32767; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TextDataFormat.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TextDataFormat.cs index e182c8fdb3e..d18a4f4a19e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TextDataFormat.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TextDataFormat.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Specifies the formats that can be used with Clipboard.GetText and - /// Clipboard.SetText methods + /// Specifies the formats that can be used with Clipboard.GetText and + /// Clipboard.SetText methods /// public enum TextDataFormat { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TextImageRelation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TextImageRelation.cs index 3d2dc0ab422..e181e202f7f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TextImageRelation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TextImageRelation.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Defined in such a way that you can cast the relation to an AnchorStyle and - /// the direction of the AnchorStyle points to where the image goes. - /// (e.g., (AnchorStyle)ImageBeforeText -> Left)) + /// Defined in such a way that you can cast the relation to an AnchorStyle and + /// the direction of the AnchorStyle points to where the image goes. + /// (e.g., (AnchorStyle)ImageBeforeText -> Left)) /// public enum TextImageRelation { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ThreadExceptionDialog.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ThreadExceptionDialog.cs index 8234dfc2174..230f3f87347 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ThreadExceptionDialog.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ThreadExceptionDialog.cs @@ -378,7 +378,7 @@ private void ThreadExceptionDialog_DpiChanged(object sender, DpiChangedEventArgs } /// - /// Hide the property + /// Hide the property /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TickStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TickStyle.cs index 543348d9890..474d65587cc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TickStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TickStyle.cs @@ -5,30 +5,30 @@ namespace System.Windows.Forms { /// - /// Specifies the location of tick marks in a - /// control. + /// Specifies the location of tick marks in a + /// control. /// public enum TickStyle { /// - /// No tick marks appear in the control. + /// No tick marks appear in the control. /// None = 0, /// - /// Tick marks are located on the top of horizontal control or on the - /// left of a vertical control. + /// Tick marks are located on the top of horizontal control or on the + /// left of a vertical control. /// TopLeft = 1, /// - /// Tick marks are located on the bottom of a horizontal control or on the - /// right side of a vertical control. + /// Tick marks are located on the bottom of a horizontal control or on the + /// right side of a vertical control. /// BottomRight = 2, /// - /// Tick marks are located on both sides of the control. + /// Tick marks are located on both sides of the control. /// Both = 3, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Timer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Timer.cs index e01d80b14c1..542f9531d6a 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/Timer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/Timer.cs @@ -9,8 +9,8 @@ namespace System.Windows.Forms { /// - /// Implements a Windows-based timer that raises an event at user-defined intervals. - /// This timer is optimized for use in Win Forms applications and must be used in a window. + /// Implements a Windows-based timer that raises an event at user-defined intervals. + /// This timer is optimized for use in Win Forms applications and must be used in a window. /// [DefaultProperty(nameof(Interval))] [DefaultEvent(nameof(Tick))] @@ -32,14 +32,14 @@ public class Timer : Component private readonly object _syncObj = new object(); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public Timer() : base() { } /// - /// Initializes a new instance of the class with the specified container. + /// Initializes a new instance of the class with the specified container. /// public Timer(IContainer container) : this() { @@ -60,7 +60,7 @@ public Timer(IContainer container) : this() public object Tag { get; set; } /// - /// Occurs when the specified timer interval has elapsed and the timer is enabled. + /// Occurs when the specified timer interval has elapsed and the timer is enabled. /// [SRCategory(nameof(SR.CatBehavior))] [SRDescription(nameof(SR.TimerTimerDescr))] @@ -71,7 +71,7 @@ public event EventHandler Tick } /// - /// Disposes of the resources (other than memory) used by the timer. + /// Disposes of the resources (other than memory) used by the timer. /// protected override void Dispose(bool disposing) { @@ -86,7 +86,7 @@ protected override void Dispose(bool disposing) } /// - /// Indicates whether the timer is running. + /// Indicates whether the timer is running. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -132,7 +132,7 @@ public virtual bool Enabled } /// - /// Indicates the time, in milliseconds, between timer ticks. + /// Indicates the time, in milliseconds, between timer ticks. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(100)] @@ -166,17 +166,17 @@ public int Interval } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnTick(EventArgs e) => _onTimer?.Invoke(this, e); /// - /// Starts the timer. + /// Starts the timer. /// public void Start() => Enabled = true; /// - /// Stops the timer. + /// Stops the timer. /// public void Stop() => Enabled = false; @@ -235,7 +235,7 @@ private bool EnsureHandle() } /// - /// Returns true if we need to marshal across threads to access this timer's HWND. + /// Returns true if we need to marshal across threads to access this timer's HWND. /// private bool GetInvokeRequired(IntPtr hWnd) { @@ -249,7 +249,7 @@ private bool GetInvokeRequired(IntPtr hWnd) } /// - /// Changes the interval of the timer without destroying the HWND. + /// Changes the interval of the timer without destroying the HWND. /// public void RestartTimer(int newInterval) { @@ -271,7 +271,7 @@ public void StartTimer(int interval) public void StopTimer() => StopTimer(IntPtr.Zero, destroyHwnd: true); /// - /// Stop the timer and optionally destroy the HWND. + /// Stop the timer and optionally destroy the HWND. /// public void StopTimer(IntPtr hWnd, bool destroyHwnd) { @@ -317,7 +317,7 @@ public void StopTimer(IntPtr hWnd, bool destroyHwnd) } /// - /// Destroy the handle, stopping the timer first. + /// Destroy the handle, stopping the timer first. /// public override void DestroyHandle() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBar.cs index e3c06195469..e85e97d3aee 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBar.cs @@ -98,7 +98,7 @@ public class ToolBar : Control private ToolBarButtonClickEventHandler onButtonDropDown = null; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ToolBar() : base() @@ -830,7 +830,7 @@ public override RightToLeft RightToLeft } /// - /// We need to track the current scale factor so that we can tell the + /// We need to track the current scale factor so that we can tell the /// unmanaged control how to scale its buttons. /// [EditorBrowsable(EditorBrowsableState.Never)] @@ -843,7 +843,7 @@ protected override void ScaleCore(float dx, float dy) } /// - /// We need to track the current scale factor so that we can tell the + /// We need to track the current scale factor so that we can tell the /// unmanaged control how to scale its buttons. /// protected override void ScaleControl(SizeF factor, BoundsSpecified specified) @@ -982,7 +982,7 @@ public bool Wrappable } /// - /// Occurs when a on the is clicked. + /// Occurs when a on the is clicked. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.ToolBarButtonClickDescr))] public event ToolBarButtonClickEventHandler ButtonClick @@ -992,7 +992,7 @@ public event ToolBarButtonClickEventHandler ButtonClick } /// - /// Occurs when a drop-down style or its down arrow is clicked. + /// Occurs when a drop-down style or its down arrow is clicked. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.ToolBarButtonDropDownDescr))] public event ToolBarButtonClickEventHandler ButtonDropDown @@ -1283,8 +1283,8 @@ internal void InternalSetButton(int index, ToolBarButton value, bool recreate, b } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnButtonClick(ToolBarButtonClickEventArgs e) { @@ -1292,8 +1292,8 @@ protected virtual void OnButtonClick(ToolBarButtonClickEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnButtonDropDown(ToolBarButtonClickEventArgs e) { @@ -1472,7 +1472,7 @@ private void ResetButtonSize() RecreateHandle(); } - /// Sends a TB_SETBUTTONSIZE message to the unmanaged control, with size arguments properly scaled. + /// Sends a TB_SETBUTTONSIZE message to the unmanaged control, with size arguments properly scaled. private void SendToolbarButtonSizeMessage() { SendMessage(NativeMethods.TB_SETBUTTONSIZE, 0, NativeMethods.Util.MAKELPARAM((int)(buttonSize.Width * currentScaleDX), (int)(buttonSize.Height * currentScaleDY))); @@ -1532,7 +1532,7 @@ protected override void SetBoundsCore(int x, int y, int width, int height, Bound } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// private bool ShouldSerializeButtonSize() { @@ -1819,20 +1819,20 @@ protected override void WndProc(ref Message m) } /// - /// Encapsulates a collection of controls for use by the + /// Encapsulates a collection of controls for use by the /// class. /// public class ToolBarButtonCollection : IList { private readonly ToolBar owner; private bool suspendUpdate; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; /// - /// Initializes a new instance of the class and assigns it to the specified toolbar. + /// Initializes a new instance of the class and assigns it to the specified toolbar. /// public ToolBarButtonCollection(ToolBar owner) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarAppearance.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarAppearance.cs index fd2c9f10dfc..464c456837b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarAppearance.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarAppearance.cs @@ -5,18 +5,18 @@ namespace System.Windows.Forms { /// - /// Specifies the type of toolbar to display. + /// Specifies the type of toolbar to display. /// public enum ToolBarAppearance { /// - /// The toolbar and buttons appear as standard three dimensional controls. + /// The toolbar and buttons appear as standard three dimensional controls. /// Normal = 0, /// - /// The toolbar and buttons appear flat, but the buttons change to three - /// dimensional as the mouse pointer moves over them. + /// The toolbar and buttons appear flat, but the buttons change to three + /// dimensional as the mouse pointer moves over them. /// Flat = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButton.cs index 383d600c9ab..ae648d64b23 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButton.cs @@ -58,7 +58,7 @@ public class ToolBarButton : Component internal Menu dropDownMenu = null; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public ToolBarButton() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventArgs.cs index db4808526ed..0256dfba763 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventArgs.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// event. + /// Provides data for the + /// event. /// public class ToolBarButtonClickEventArgs : EventArgs { /// - /// Initializes a new instance of the - /// class. + /// Initializes a new instance of the + /// class. /// public ToolBarButtonClickEventArgs(ToolBarButton button) { @@ -20,8 +20,8 @@ public ToolBarButtonClickEventArgs(ToolBarButton button) } /// - /// Specifies the - /// that was clicked. + /// Specifies the + /// that was clicked. /// public ToolBarButton Button { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventHandler.cs index 1cb0e14b093..df8053bd914 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonClickEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void ToolBarButtonClickEventHandler(object sender, ToolBarButtonClickEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonStyle.cs index d60449605cb..ea4872efb30 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarButtonStyle.cs @@ -7,26 +7,26 @@ namespace System.Windows.Forms public enum ToolBarButtonStyle { /// - /// A standard, three-dimensional button. + /// A standard, three-dimensional button. /// PushButton = 1, /// - /// A toggle button that appears sunken when clicked and retains the - /// sunken appearance until clicked again. + /// A toggle button that appears sunken when clicked and retains the + /// sunken appearance until clicked again. /// ToggleButton = 2, /// - /// A space or line between toolbar buttons. The appearance depends on - /// the value of the - /// property. + /// A space or line between toolbar buttons. The appearance depends on + /// the value of the + /// property. /// Separator = 3, /// - /// A drop down control that displays a menu or other window when - /// clicked. + /// A drop down control that displays a menu or other window when + /// clicked. /// DropDownButton = 4, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarTextAlign.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarTextAlign.cs index 17f72e0e160..72dcf8156c9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarTextAlign.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolBarTextAlign.cs @@ -5,17 +5,17 @@ namespace System.Windows.Forms { /// - /// Specifies the alignment of text on the toolbar button control. + /// Specifies the alignment of text on the toolbar button control. /// public enum ToolBarTextAlign { /// - /// The text is aligned underneath the toolbar button image. + /// The text is aligned underneath the toolbar button image. /// Underneath = 0, /// - /// The text is aligned to the right of the toolbar button image. + /// The text is aligned to the right of the toolbar button image. /// Right = 1, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStrip.cs index 7c4d1f9b66e..7efa0443b74 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStrip.cs @@ -154,7 +154,7 @@ public class ToolStrip : ScrollableControl, IArrangedElement, ISupportToolStripP internal Action rescaleConstsCallbackDelegate; /// - /// Summary of ToolStrip. + /// Summary of ToolStrip. /// public ToolStrip() { @@ -341,7 +341,7 @@ public override bool AutoScroll } /// - /// Summary of AllowDrop. + /// Summary of AllowDrop. /// public override bool AllowDrop { @@ -448,7 +448,7 @@ public override AnchorStyles Anchor } /// - /// Just here so we can implement ShouldSerializeBackColor + /// Just here so we can implement ShouldSerializeBackColor /// [ SRDescription(nameof(SR.ToolStripBackColorDescr)), @@ -507,7 +507,7 @@ public override BindingContext BindingContext } /// - /// Summary of CanOverflow. + /// Summary of CanOverflow. /// [ DefaultValue(true), @@ -647,8 +647,8 @@ public override Font Font } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected override Size DefaultSize => DpiHelper.IsPerMonitorV2Awareness ? @@ -775,7 +775,7 @@ public virtual ToolStripDropDownDirection DefaultDropDownDirection } } /// - /// Just here so we can add the default value attribute + /// Just here so we can add the default value attribute /// [DefaultValue(DockStyle.Top)] public override DockStyle Dock @@ -831,9 +831,9 @@ internal virtual NativeWindow DropDownOwnerWindow } /// - /// Returns the drop target manager that all the hwndless - /// items and this ToolStrip share. this is necessary as - /// RegisterDragDrop requires an HWND. + /// Returns the drop target manager that all the hwndless + /// items and this ToolStrip share. this is necessary as + /// RegisterDragDrop requires an HWND. /// internal ToolStripDropTargetManager DropTargetManager { @@ -853,7 +853,7 @@ internal ToolStripDropTargetManager DropTargetManager } /// - /// Just here so we can add the default value attribute + /// Just here so we can add the default value attribute /// protected internal virtual ToolStripItemCollection DisplayedItems { @@ -868,10 +868,10 @@ protected internal virtual ToolStripItemCollection DisplayedItems } /// - /// Retreives the current display rectangle. The display rectangle - /// is the virtual display area that is used to layout components. - /// The position and dimensions of the Form's display rectangle - /// change during autoScroll. + /// Retreives the current display rectangle. The display rectangle + /// is the virtual display area that is used to layout components. + /// The position and dimensions of the Form's display rectangle + /// change during autoScroll. /// public override Rectangle DisplayRectangle { @@ -902,7 +902,7 @@ public override Rectangle DisplayRectangle } /// - /// Forecolor really has no meaning for ToolStrips - so lets hide it + /// Forecolor really has no meaning for ToolStrips - so lets hide it /// [Browsable(false)] public new Color ForeColor @@ -938,7 +938,7 @@ private bool HasKeyboardInput } /// - /// Summary of ToolStripGrip. + /// Summary of ToolStripGrip. /// internal ToolStripGrip Grip { @@ -959,7 +959,7 @@ internal ToolStripGrip Grip } } /// - /// Summary of GripStyle. + /// Summary of GripStyle. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -990,7 +990,7 @@ public ToolStripGripStyle GripStyle } /// - /// Summary of GripStyle. + /// Summary of GripStyle. /// [ Browsable(false) @@ -1005,7 +1005,7 @@ public ToolStripGripDisplayStyle GripDisplayStyle } /// - /// The external spacing between the grip and the padding of the ToolStrip and the first item in the collection + /// The external spacing between the grip and the padding of the ToolStrip and the first item in the collection /// [ SRCategory(nameof(SR.CatLayout)), @@ -1024,7 +1024,7 @@ public Padding GripMargin } /// - /// The boundaries of the grip on the ToolStrip. If it is invisible - returns Rectangle.Empty. + /// The boundaries of the grip on the ToolStrip. If it is invisible - returns Rectangle.Empty. /// [ Browsable(false) @@ -1129,7 +1129,7 @@ internal virtual Size ImageScalingSizeInternal } /// - /// Gets or sets the that contains the displayed on a label control. + /// Gets or sets the that contains the displayed on a label control. /// [ DefaultValue(null), @@ -1219,13 +1219,13 @@ private bool IsLocationChanging } /// - /// The items that belong to this ToolStrip. - /// Note - depending on space and layout preferences, not all items - /// in this collection will be displayed. They may not even be displayed - /// on this ToolStrip (say in the case where we're overflowing the item). - /// The collection of _Displayed_ items is the DisplayedItems collection. - /// The displayed items collection also includes things like the OverflowButton - /// and the Grip. + /// The items that belong to this ToolStrip. + /// Note - depending on space and layout preferences, not all items + /// in this collection will be displayed. They may not even be displayed + /// on this ToolStrip (say in the case where we're overflowing the item). + /// The collection of _Displayed_ items is the DisplayedItems collection. + /// The displayed items collection also includes things like the OverflowButton + /// and the Grip. /// [ DesignerSerializationVisibility(DesignerSerializationVisibility.Content), @@ -1253,7 +1253,7 @@ public event ToolStripItemEventHandler ItemAdded } /// - /// Occurs when the control is clicked. + /// Occurs when the control is clicked. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.ToolStripItemOnClickDescr))] public event ToolStripItemClickedEventHandler ItemClicked @@ -1309,10 +1309,10 @@ internal bool IsDisposingItems } } /// - /// The OnDrag[blah] methods that will be called if AllowItemReorder is true. + /// The OnDrag[blah] methods that will be called if AllowItemReorder is true. /// - /// This allows us to have methods that handle drag/drop of the ToolStrip items - /// without calling back on the user's code + /// This allows us to have methods that handle drag/drop of the ToolStrip items + /// without calling back on the user's code /// internal IDropTarget ItemReorderDropTarget { @@ -1327,11 +1327,11 @@ internal IDropTarget ItemReorderDropTarget } /// - /// The OnQueryContinueDrag and OnGiveFeedback methods that will be called if - /// AllowItemReorder is true. + /// The OnQueryContinueDrag and OnGiveFeedback methods that will be called if + /// AllowItemReorder is true. /// - /// This allows us to have methods that handle drag/drop of the ToolStrip items - /// without calling back on the user's code + /// This allows us to have methods that handle drag/drop of the ToolStrip items + /// without calling back on the user's code /// internal ISupportOleDropSource ItemReorderDropSource { @@ -1391,7 +1391,7 @@ public LayoutSettings LayoutSettings } /// - /// Specifies whether we're horizontal or vertical + /// Specifies whether we're horizontal or vertical /// [ SRDescription(nameof(SR.ToolStripLayoutStyle)), @@ -1582,7 +1582,7 @@ private MouseHoverTimer MouseHoverTimer } /// - /// Summary of OverflowButton. + /// Summary of OverflowButton. /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Advanced)] public ToolStripOverflowButton OverflowButton @@ -1752,10 +1752,10 @@ public bool Stretch internal override bool SupportsUiaProviders => true; /// - /// The renderer is used to paint the hwndless ToolStrip items. If someone wanted to - /// change the "Hot" look of all of their buttons to be a green triangle, they should - /// create a class that derives from ToolStripRenderer, assign it to this property and call - /// invalidate. + /// The renderer is used to paint the hwndless ToolStrip items. If someone wanted to + /// change the "Hot" look of all of their buttons to be a green triangle, they should + /// create a class that derives from ToolStripRenderer, assign it to this property and call + /// invalidate. /// [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -1869,9 +1869,9 @@ public ToolStripRenderMode RenderMode } /// - /// ToolStripItems need to access this to determine if they should be showing underlines - /// for their accelerators. Since they are not HWNDs, and this method is protected on control - /// we need a way for them to get at it. + /// ToolStripItems need to access this to determine if they should be showing underlines + /// for their accelerators. Since they are not HWNDs, and this method is protected on control + /// we need a way for them to get at it. /// internal bool ShowKeyboardCuesInternal { @@ -1938,8 +1938,8 @@ internal Hashtable Shortcuts } /// - /// Indicates whether the user can give the focus to this control using the TAB - /// key. This property is read-only. + /// Indicates whether the user can give the focus to this control using the TAB + /// key. This property is read-only. /// [ SRCategory(nameof(SR.CatBehavior)), @@ -2108,7 +2108,7 @@ protected internal virtual ToolStripItem CreateDefaultItem(string text, Image im } /// - /// Summary of ClearAllSelections. + /// Summary of ClearAllSelections. /// private void ClearAllSelections() { @@ -2116,7 +2116,7 @@ private void ClearAllSelections() } /// - /// Summary of ClearAllSelectionsExcept. + /// Summary of ClearAllSelectionsExcept. /// /// private void ClearAllSelectionsExcept(ToolStripItem item) @@ -2219,7 +2219,7 @@ private void ClearLastMouseDownedItem() } /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// protected override void Dispose(bool disposing) { @@ -2398,7 +2398,7 @@ internal virtual ToolStripItem GetNextItem(ToolStripItem start, ArrowDirection d } /// - /// Gets the next item from the given start item in the direction specified. + /// Gets the next item from the given start item in the direction specified. /// - This function wraps if at the end /// - This function will only surf the items in the current container /// - Overriding this function will change the tab ordering and accessible child ordering. @@ -2423,7 +2423,7 @@ public virtual ToolStripItem GetNextItem(ToolStripItem start, ArrowDirection dir } /// - /// Helper function for GetNextItem - do not directly call this. + /// Helper function for GetNextItem - do not directly call this. /// private ToolStripItem GetNextItemHorizontal(ToolStripItem start, bool forward) { @@ -2803,7 +2803,7 @@ internal static Graphics GetMeasurementGraphics() } #endregion /// - /// Summary of GetSelectedItem. + /// Summary of GetSelectedItem. /// internal ToolStripItem GetSelectedItem() { @@ -2832,7 +2832,7 @@ internal virtual ToolStrip GetToplevelOwnerToolStrip() return this; } - /// In the case of a + /// In the case of a /// toolstrip -> toolstrip /// contextmenustrip -> the control that is showing it /// toolstripdropdown -> top most toolstrip @@ -2866,7 +2866,7 @@ private void HandleMouseLeave() } /// - /// Summary of HandleItemClick. + /// Summary of HandleItemClick. /// internal void HandleItemClick(ToolStripItem dismissingItem) { @@ -2963,7 +2963,7 @@ internal void InvalidateTextItems() } } /// - /// Summary of IsInputKey. + /// Summary of IsInputKey. /// /// protected override bool IsInputKey(Keys keyData) @@ -2976,7 +2976,7 @@ protected override bool IsInputKey(Keys keyData) return base.IsInputKey(keyData); } /// - /// Summary of IsInputChar. + /// Summary of IsInputChar. /// /// protected override bool IsInputChar(char charCode) @@ -3105,7 +3105,7 @@ internal override void PrintToMetaFileRecursive(HandleRef hDC, IntPtr lParam, Re } /// - /// Summary of ProcessCmdKey. + /// Summary of ProcessCmdKey. /// /// /// @@ -3172,13 +3172,13 @@ protected override bool ProcessCmdKey(ref Message m, Keys keyData) } /// - /// Processes a dialog key. Overrides Control.processDialogKey(). This - /// method implements handling of the TAB, LEFT, RIGHT, UP, and DOWN - /// keys in dialogs. - /// The method performs no processing on keys that include the ALT or - /// CONTROL modifiers. For the TAB key, the method selects the next control - /// on the form. For the arrow keys, - /// !!! + /// Processes a dialog key. Overrides Control.processDialogKey(). This + /// method implements handling of the TAB, LEFT, RIGHT, UP, and DOWN + /// keys in dialogs. + /// The method performs no processing on keys that include the ALT or + /// CONTROL modifiers. For the TAB key, the method selects the next control + /// on the form. For the arrow keys, + /// !!! /// protected override bool ProcessDialogKey(Keys keyData) { @@ -3436,7 +3436,7 @@ private bool ProcessMnemonicInternal(char charCode) } /// - /// Summary of ProcessTabKey. + /// Summary of ProcessTabKey. /// /// private bool ProcessTabKey(bool forward) @@ -3466,11 +3466,11 @@ private bool ProcessTabKey(bool forward) } /// - /// Summary of ProcessArrowKey: this is more useful than overriding ProcessDialogKey because usually - /// the difference between ToolStrip/ToolStripDropDown is arrow key handling. ProcessDialogKey first gives - /// the selected ToolStripItem the chance to process the message... so really a proper inheritor would - /// call down to the base first. Unfortunately doing this would cause the the arrow keys would be eaten - /// in the base class. Instead we're providing a separate place to override all arrow key handling. + /// Summary of ProcessArrowKey: this is more useful than overriding ProcessDialogKey because usually + /// the difference between ToolStrip/ToolStripDropDown is arrow key handling. ProcessDialogKey first gives + /// the selected ToolStripItem the chance to process the message... so really a proper inheritor would + /// call down to the base first. Unfortunately doing this would cause the the arrow keys would be eaten + /// in the base class. Instead we're providing a separate place to override all arrow key handling. /// internal virtual bool ProcessArrowKey(Keys keyCode) { @@ -3525,7 +3525,7 @@ private bool ProcessLeftRightArrowKey(bool right) } /// - /// Summary of NotifySelectionChange. + /// Summary of NotifySelectionChange. /// /// internal void NotifySelectionChange(ToolStripItem item) @@ -3584,7 +3584,7 @@ protected virtual void OnRendererChanged(EventArgs e) ((EventHandler)Events[EventRendererChanged])?.Invoke(this, e); } /// - /// Summary of OnEnabledChanged. + /// Summary of OnEnabledChanged. /// protected override void OnEnabledChanged(EventArgs e) { @@ -3648,7 +3648,7 @@ protected override void OnInvalidated(InvalidateEventArgs e) #endif } /// - /// Summary of OnHandleCreated. + /// Summary of OnHandleCreated. /// protected override void OnHandleCreated(EventArgs e) { @@ -3663,7 +3663,7 @@ protected override void OnHandleCreated(EventArgs e) } /// - /// Summary of OnHandleDestroyed. + /// Summary of OnHandleDestroyed. /// protected override void OnHandleDestroyed(EventArgs e) { @@ -3689,7 +3689,7 @@ protected internal virtual void OnItemAdded(ToolStripItemEventArgs e) } /// - /// Called when an item has been clicked on the ToolStrip. + /// Called when an item has been clicked on the ToolStrip. /// protected virtual void OnItemClicked(ToolStripItemClickedEventArgs e) { @@ -3786,7 +3786,7 @@ internal virtual void OnLocationChanging(ToolStripLocationCancelEventArgs e) } /// - /// Delegate mouse down to the ToolStrip and its affected items + /// Delegate mouse down to the ToolStrip and its affected items /// protected override void OnMouseDown(MouseEventArgs mea) { @@ -3823,7 +3823,7 @@ protected override void OnMouseDown(MouseEventArgs mea) } /// - /// Delegate mouse moves to the ToolStrip and its affected items + /// Delegate mouse moves to the ToolStrip and its affected items /// protected override void OnMouseMove(MouseEventArgs mea) { @@ -3888,7 +3888,7 @@ protected override void OnMouseMove(MouseEventArgs mea) } /// - /// Delegate mouse leave to the ToolStrip and its affected items + /// Delegate mouse leave to the ToolStrip and its affected items /// protected override void OnMouseLeave(EventArgs e) { @@ -3909,7 +3909,7 @@ protected override void OnMouseCaptureChanged(EventArgs e) } /// - /// Delegate mouse up to the ToolStrip and its affected items + /// Delegate mouse up to the ToolStrip and its affected items /// protected override void OnMouseUp(MouseEventArgs mea) { @@ -4141,10 +4141,10 @@ protected override void OnRightToLeftChanged(EventArgs e) } /// - /// Inheriting classes should override this method to handle the erase - /// background request from windows. It is not necessary to call - /// base.onPaintBackground, however if you do not want the default - /// Windows behavior you must set event.handled to true. + /// Inheriting classes should override this method to handle the erase + /// background request from windows. It is not necessary to call + /// base.onPaintBackground, however if you do not want the default + /// Windows behavior you must set event.handled to true. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnPaintBackground(PaintEventArgs e) @@ -4193,7 +4193,7 @@ private void EraseCorners(PaintEventArgs e, Region transparentRegion) } /// - /// Summary of OnPaint. + /// Summary of OnPaint. /// internal protected virtual void OnPaintGrip(PaintEventArgs e) { @@ -4235,10 +4235,10 @@ protected override void OnTabStopChanged(EventArgs e) } /// - /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. - /// Must call the base class method to get the current DPI values. This method is invoked only when - /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has - /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. + /// When overridden in a derived class, handles rescaling of any magic numbers used in control painting. + /// Must call the base class method to get the current DPI values. This method is invoked only when + /// Application opts-in into the Per-monitor V2 support, targets .NETFX 4.7 and has + /// EnableDpiChangedMessageHandling and EnableDpiChangedHighDpiImprovements config switches turned on. /// /// Old DPI value /// New DPI value @@ -4269,8 +4269,8 @@ protected override void RescaleConstantsForDpi(int deviceDpiOld, int deviceDpiNe } /// - /// Resets the scaling (only in PerMonitorV2 scenarios). - /// Do only call from code which is quirked with PerMonitorV2 quirks for the ToolStrip. + /// Resets the scaling (only in PerMonitorV2 scenarios). + /// Do only call from code which is quirked with PerMonitorV2 quirks for the ToolStrip. /// /// The new DPI passed by WmDpiChangedBeforeParent. internal virtual void ResetScaling(int newDpi) @@ -4284,7 +4284,7 @@ internal virtual void ResetScaling(int newDpi) } /// - /// Paints the I beam when items are being reordered + /// Paints the I beam when items are being reordered /// internal void PaintInsertionMark(Graphics g) { @@ -4340,7 +4340,7 @@ internal void PaintInsertionMark(Graphics g) } /// - /// Paints the I beam when items are being reordered + /// Paints the I beam when items are being reordered /// internal void PaintInsertionMark(Rectangle insertionRect) { @@ -4372,8 +4372,8 @@ internal override Control GetFirstChildControlInTabOrder(bool forward) return null; } /// - /// Finds the ToolStripItem contained within a specified client coordinate point - /// If item not found - returns null + /// Finds the ToolStripItem contained within a specified client coordinate point + /// If item not found - returns null /// public ToolStripItem GetItemAt(int x, int y) { @@ -4381,8 +4381,8 @@ public ToolStripItem GetItemAt(int x, int y) } /// - /// Finds the ToolStripItem contained within a specified client coordinate point - /// If item not found - returns null + /// Finds the ToolStripItem contained within a specified client coordinate point + /// If item not found - returns null /// public ToolStripItem GetItemAt(Point point) { @@ -4547,7 +4547,7 @@ internal virtual void ScrollInternal(int delta) } /// - /// Summary of SetItemLocation + /// Summary of SetItemLocation /// /// protected internal void SetItemLocation(ToolStripItem item, Point location) @@ -4564,7 +4564,7 @@ protected internal void SetItemLocation(ToolStripItem item, Point location) item.SetBounds(new Rectangle(location, item.Size)); } /// - /// This is needed so that people doing custom layout engines can change the "Parent" property of the item. + /// This is needed so that people doing custom layout engines can change the "Parent" property of the item. /// protected static void SetItemParent(ToolStripItem item, ToolStrip parent) { @@ -4624,7 +4624,7 @@ internal bool ShouldSelectItem() return false; } /// - /// Summary of Select. + /// Summary of Select. /// /// /// @@ -4648,12 +4648,11 @@ protected override void Select(bool directed, bool forward) } /// - /// Summary of SelectNextToolStripItem. + /// Summary of SelectNextToolStripItem. /// /// /// /// - internal ToolStripItem SelectNextToolStripItem(ToolStripItem start, bool forward) { ToolStripItem nextItem = GetNextItem(start, (forward) ? ArrowDirection.Right : ArrowDirection.Left, /*RTLAware=*/true); @@ -4742,8 +4741,8 @@ internal void SetLargestItemSize(Size size) } /// - /// Afer we've performed a layout we need to reset the DisplayedItems and the OverflowItems collection. - /// OverflowItems are not supported in layouts other than ToolStripSplitStack + /// Afer we've performed a layout we need to reset the DisplayedItems and the OverflowItems collection. + /// OverflowItems are not supported in layouts other than ToolStripSplitStack /// protected virtual void SetDisplayedItems() { @@ -5125,7 +5124,7 @@ private void UpdateOrientation(Orientation newOrientation) } /// - /// Summary of WndProc. + /// Summary of WndProc. /// /// protected override void WndProc(ref Message m) @@ -5256,7 +5255,7 @@ public ToolStripAccessibleObject(ToolStrip owner) : base(owner) } /// - /// Return the child object at the given screen coordinates. + /// Return the child object at the given screen coordinates. /// public override AccessibleObject HitTest(int x, int y) { @@ -5269,8 +5268,8 @@ public override AccessibleObject HitTest(int x, int y) } /// - /// When overridden in a derived class, gets the accessible child corresponding to the specified - /// index. + /// When overridden in a derived class, gets the accessible child corresponding to the specified + /// index. /// // public override AccessibleObject GetChild(int index) @@ -5347,7 +5346,7 @@ public override AccessibleObject GetChild(int index) /// /// When overridden in a derived class, gets the number of children - /// belonging to an accessible object. + /// belonging to an accessible object. /// public override int GetChildCount() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripButton.cs index 86660c10623..539e4612729 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripButton.cs @@ -22,7 +22,7 @@ public class ToolStripButton : ToolStripItem private static readonly object EventCheckStateChanged = new object(); /// - /// Summary of ToolStripButton. + /// Summary of ToolStripButton. /// public ToolStripButton() { @@ -63,7 +63,7 @@ public ToolStripButton(string text, Image image, EventHandler onClick, string na } /// - /// Summary of CanSelect. + /// Summary of CanSelect. /// public override bool CanSelect { @@ -91,7 +91,7 @@ public bool CheckOnClick } /// - /// Gets or sets a value indicating whether the item is checked. + /// Gets or sets a value indicating whether the item is checked. /// [ DefaultValue(false), @@ -117,8 +117,8 @@ public bool Checked } /// - /// Gets - /// or sets a value indicating whether the check box is checked. + /// Gets + /// or sets a value indicating whether the check box is checked. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -151,9 +151,9 @@ public CheckState CheckState } /// - /// Occurs when the - /// value of the - /// property changes. + /// Occurs when the + /// value of the + /// property changes. /// [SRDescription(nameof(SR.CheckBoxOnCheckedChangedDescr))] public event EventHandler CheckedChanged @@ -162,9 +162,9 @@ public event EventHandler CheckedChanged remove => Events.RemoveHandler(EventCheckedChanged, value); } /// - /// Occurs when the - /// value of the - /// property changes. + /// Occurs when the + /// value of the + /// property changes. /// [SRDescription(nameof(SR.CheckBoxOnCheckStateChangedDescr))] public event EventHandler CheckStateChanged @@ -200,8 +200,8 @@ internal override int DeviceDpi /// /// - /// constructs the new instance of the accessibility object for this ToolStripItem. Subclasses - /// should not call base.CreateAccessibilityObject. + /// constructs the new instance of the accessibility object for this ToolStripItem. Subclasses + /// should not call base.CreateAccessibilityObject. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override AccessibleObject CreateAccessibilityInstance() @@ -217,7 +217,7 @@ public override Size GetPreferredSize(Size constrainingSize) } /// - /// Called by all constructors of ToolStripButton. + /// Called by all constructors of ToolStripButton. /// private void Initialize() { @@ -229,8 +229,8 @@ private void Initialize() } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnCheckedChanged(EventArgs e) { @@ -238,7 +238,7 @@ protected virtual void OnCheckedChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnCheckStateChanged(EventArgs e) { @@ -247,7 +247,7 @@ protected virtual void OnCheckStateChanged(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected override void OnPaint(PaintEventArgs e) { @@ -283,7 +283,7 @@ protected override void OnClick(EventArgs e) } /// - /// An implementation of AccessibleChild for use with ToolStripItems + /// An implementation of AccessibleChild for use with ToolStripItems /// [Runtime.InteropServices.ComVisible(true)] internal class ToolStripButtonAccessibleObject : ToolStripItemAccessibleObject diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripComboBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripComboBox.cs index 7590080c481..d6c307983d3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripComboBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripComboBox.cs @@ -148,8 +148,8 @@ protected override Size DefaultSize } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected internal override Padding DefaultMargin { @@ -265,7 +265,7 @@ public bool IntegralHeight set { ComboBox.IntegralHeight = value; } } /// - /// Collection of the items contained in this ComboBox. + /// Collection of the items contained in this ComboBox. /// [ SRCategory(nameof(SR.CatData)), diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContainer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContainer.cs index 4a04089abb1..69ac3d640cf 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContainer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContainer.cs @@ -7,7 +7,7 @@ using System.Globalization; using System.Runtime.InteropServices; -/// this is the UBER container for ToolStripPanels. +/// this is the UBER container for ToolStripPanels. namespace System.Windows.Forms { [ComVisible(true)] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventArgs.cs index e6e19d6a70a..3d6ef273c63 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventArgs.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms public class ToolStripContentPanelRenderEventArgs : EventArgs { /// - /// This class represents all the information to render the toolStrip + /// This class represents all the information to render the toolStrip /// public ToolStripContentPanelRenderEventArgs(Graphics g, ToolStripContentPanel contentPanel) { @@ -18,12 +18,12 @@ public ToolStripContentPanelRenderEventArgs(Graphics g, ToolStripContentPanel co } /// - /// The graphics object to draw with + /// The graphics object to draw with /// public Graphics Graphics { get; } /// - /// Represents which toolStrip was affected by the click + /// Represents which toolStrip was affected by the click /// public ToolStripContentPanel ToolStripContentPanel { get; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventHandler.cs index f29c2b72435..2151684f58d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripContentPanelRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of the ToolStripPanel is being rendered + /// Called when the background of the ToolStripPanel is being rendered /// public delegate void ToolStripContentPanelRenderEventHandler(object sender, ToolStripContentPanelRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripControlHost.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripControlHost.cs index 37472e3b614..4646784c41e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripControlHost.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripControlHost.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// ToolStripItem that can host Controls. + /// ToolStripItem that can host Controls. /// public class ToolStripControlHost : ToolStripItem { @@ -32,7 +32,7 @@ public class ToolStripControlHost : ToolStripItem internal static readonly object EventValidating = new object(); /// - /// Constructs a ToolStripControlHost + /// Constructs a ToolStripControlHost /// public ToolStripControlHost(Control c) { @@ -67,7 +67,7 @@ public override Color BackColor } /// - /// Gets or sets the image that is displayed on a . + /// Gets or sets the image that is displayed on a . /// [ Localizable(true), @@ -105,7 +105,7 @@ public override ImageLayout BackgroundImageLayout } } /// - /// Overriden to return value from Control.CanSelect. + /// Overriden to return value from Control.CanSelect. /// public override bool CanSelect { @@ -149,7 +149,7 @@ public ContentAlignment ControlAlign } /// - /// The control that this item is hosting. + /// The control that this item is hosting. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public Control Control @@ -169,8 +169,8 @@ internal AccessibleObject ControlAccessibilityObject } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected override Size DefaultSize { @@ -208,8 +208,8 @@ protected override Size DefaultSize /// // For control hosts, this property has no effect - /// as they get their own clicks. Use ControlStyles.StandardClick - /// instead. + /// as they get their own clicks. Use ControlStyles.StandardClick + /// instead. /// [DefaultValue(false), Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] public new bool DoubleClickEnabled @@ -364,7 +364,7 @@ public event EventHandler Leave } /// - /// Occurs when the control loses focus. + /// Occurs when the control loses focus. /// [ SRCategory(nameof(SR.CatFocus)), @@ -379,7 +379,7 @@ public event EventHandler LostFocus } /// - /// Occurs when a key is pressed down while the control has focus. + /// Occurs when a key is pressed down while the control has focus. /// [SRCategory(nameof(SR.CatKey)), SRDescription(nameof(SR.ControlOnKeyDownDescr))] public event KeyEventHandler KeyDown @@ -409,9 +409,9 @@ public event KeyEventHandler KeyUp } /// - /// This is used for international applications where the language - /// is written from RightToLeft. When this property is true, - /// control placement and text will be from right to left. + /// This is used for international applications where the language + /// is written from RightToLeft. When this property is true, + /// control placement and text will be from right to left. /// public override RightToLeft RightToLeft { @@ -494,7 +494,7 @@ public override Size Size } /// - /// Overriden to set the Site for the control hosted. This is set at DesignTime when the component is added to the Container. + /// Overriden to set the Site for the control hosted. This is set at DesignTime when the component is added to the Container. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public override ISite Site @@ -518,7 +518,7 @@ public override ISite Site } /// - /// Overriden to modify hosted control's text. + /// Overriden to modify hosted control's text. /// [DefaultValue("")] public override string Text @@ -587,7 +587,7 @@ public event EventHandler Validated } /// - /// Cleans up and destroys the hosted control. + /// Cleans up and destroys the hosted control. /// protected override void Dispose(bool disposing) { @@ -626,7 +626,6 @@ public override Size GetPreferredSize(Size constrainingSize) /// Handle* wrappers: /// We sync the event from the hosted control and call resurface it on ToolStripItem. /// - private void HandleClick(object sender, EventArgs e) { OnClick(e); @@ -806,7 +805,7 @@ protected virtual void OnEnter(EventArgs e) } /// - /// called when the control has lost focus + /// called when the control has lost focus /// protected virtual void OnGotFocus(EventArgs e) { @@ -819,7 +818,7 @@ protected virtual void OnLeave(EventArgs e) } /// - /// called when the control has lost focus + /// called when the control has lost focus /// protected virtual void OnLostFocus(EventArgs e) { @@ -838,7 +837,7 @@ protected virtual void OnKeyUp(KeyEventArgs e) RaiseKeyEvent(EventKeyUp, e); } /// - /// Called when the items bounds are changed. Here, we update the Control's bounds. + /// Called when the items bounds are changed. Here, we update the Control's bounds. /// protected override void OnBoundsChanged() { @@ -869,7 +868,7 @@ protected override void OnBoundsChanged() } /// - /// Called when the control fires its Paint event. + /// Called when the control fires its Paint event. /// protected override void OnPaint(PaintEventArgs e) { @@ -882,7 +881,7 @@ protected internal override void OnLayout(LayoutEventArgs e) } /// - /// Called when the item's parent has been changed. + /// Called when the item's parent has been changed. /// protected override void OnParentChanged(ToolStrip oldParent, ToolStrip newParent) { @@ -906,9 +905,9 @@ WindowsFormsUtils.ReadOnlyControlCollection oldControlCollection } /// - /// The events from the hosted control are subscribed here. - /// Override to add/prevent syncing of control events. - /// NOTE: if you override and hook up events here, you should unhook in OnUnsubscribeControlEvents. + /// The events from the hosted control are subscribed here. + /// Override to add/prevent syncing of control events. + /// NOTE: if you override and hook up events here, you should unhook in OnUnsubscribeControlEvents. /// protected virtual void OnSubscribeControlEvents(Control control) { @@ -955,8 +954,8 @@ protected virtual void OnSubscribeControlEvents(Control control) } /// - /// The events from the hosted control are unsubscribed here. - /// Override to unhook events subscribed in OnSubscribeControlEvents. + /// The events from the hosted control are unsubscribed here. + /// Override to unhook events subscribed in OnSubscribeControlEvents. /// protected virtual void OnUnsubscribeControlEvents(Control control) { @@ -1155,7 +1154,7 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Defines the ToolStripControlHost AccessibleObject. + /// Defines the ToolStripControlHost AccessibleObject. /// [Runtime.InteropServices.ComVisible(true)] internal class ToolStripControlHostAccessibleObject : ToolStripItemAccessibleObject @@ -1163,7 +1162,7 @@ internal class ToolStripControlHostAccessibleObject : ToolStripItemAccessibleObj private readonly ToolStripControlHost _ownerItem = null; /// - /// Initializes the new instance of ToolStripControlHostAccessibleObject. + /// Initializes the new instance of ToolStripControlHostAccessibleObject. /// /// The owning ToolStripControlHost. public ToolStripControlHostAccessibleObject(ToolStripControlHost ownerItem) : base(ownerItem) @@ -1172,7 +1171,7 @@ public ToolStripControlHostAccessibleObject(ToolStripControlHost ownerItem) : ba } /// - /// Gets a description of the default action for an object. + /// Gets a description of the default action for an object. /// public override string DefaultAction { @@ -1186,7 +1185,7 @@ public override string DefaultAction } /// - /// Performs the default action associated with this accessible object. + /// Performs the default action associated with this accessible object. /// public override void DoDefaultAction() { @@ -1194,7 +1193,7 @@ public override void DoDefaultAction() } /// - /// Gets the role of this accessible object. + /// Gets the role of this accessible object. /// public override AccessibleRole Role { @@ -1211,7 +1210,7 @@ public override AccessibleRole Role } /// - /// Request to return the element in the specified direction. + /// Request to return the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. @@ -1228,7 +1227,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragment FragmentNaviga } /// - /// Return the element that is the root node of this fragment of UI. + /// Return the element that is the root node of this fragment of UI. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -1267,7 +1266,7 @@ IComponent ISite.Component // The container in which the component is sited. /// - /// When implemented by a class, gets the container associated with the . + /// When implemented by a class, gets the container associated with the . /// IContainer ISite.Container { @@ -1386,9 +1385,9 @@ void IDictionaryService.SetValue(object key, object value) } /// - /// Represents the ToolStrip hosted control accessible object which is responsible - /// for accessible navigation within the ToolStrip standard items and hosted controls - /// like TextBox, ComboBox, ProgressBar, etc. + /// Represents the ToolStrip hosted control accessible object which is responsible + /// for accessible navigation within the ToolStrip standard items and hosted controls + /// like TextBox, ComboBox, ProgressBar, etc. /// public class ToolStripHostedControlAccessibleObject : Control.ControlAccessibleObject { @@ -1396,7 +1395,7 @@ public class ToolStripHostedControlAccessibleObject : Control.ControlAccessibleO private Control _toolStripHostedControl; /// - /// Creates the new instance of ToolStripHostedControlAccessibleObject. + /// Creates the new instance of ToolStripHostedControlAccessibleObject. /// /// The ToolStrip control hosted in the ToolStripControlHost container. /// The ToolStripControlHost container which hosts the control. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDown.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDown.cs index 25146098ac5..6a6d0696343 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDown.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDown.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms { /// - /// Summary of ToolStripDropDown. + /// Summary of ToolStripDropDown. /// [Designer("System.Windows.Forms.Design.ToolStripDropDownDesigner, " + AssemblyRef.SystemDesign)] [ComVisible(true)] @@ -171,8 +171,8 @@ public override bool AutoSize } /// - /// specifies whether the dropdown should automatically close when the dropdown has lost - /// activation. If you want a dropdown that always stays open, specify AutoClose = false; + /// specifies whether the dropdown should automatically close when the dropdown has lost + /// activation. If you want a dropdown that always stays open, specify AutoClose = false; /// [ DefaultValue(true), @@ -272,10 +272,10 @@ public bool AutoClose } /// - /// This is called when creating a window. Inheriting classes can overide - /// this to add extra functionality, but should not forget to first call - /// base.CreateParams() to make sure the control continues to work - /// correctly. + /// This is called when creating a window. Inheriting classes can overide + /// this to add extra functionality, but should not forget to first call + /// base.CreateParams() to make sure the control continues to work + /// correctly. /// protected override CreateParams CreateParams { @@ -335,7 +335,7 @@ protected override Padding DefaultPadding } /// We want this to default to true... This way tooltips on overflows and custom dropdowns will show. - /// Since menu items don't show tooltips by default we can savely leave it on + /// Since menu items don't show tooltips by default we can savely leave it on protected override bool DefaultShowItemToolTips { get @@ -385,7 +385,7 @@ public override DockStyle Dock } } - /// changed the browsable attribute + /// changed the browsable attribute [Browsable(false), EditorBrowsable(EditorBrowsableState.Always)] public new event EventHandler DockChanged { @@ -560,7 +560,7 @@ public override Font Font } /// - /// determines whether this dropdown was autogenerated. + /// determines whether this dropdown was autogenerated. /// [Browsable(false)] public bool IsAutoGenerated @@ -677,7 +677,7 @@ public event CancelEventHandler Opening } /// - /// Occurs when the control is clicked. + /// Occurs when the control is clicked. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.ToolStripDropDownOpenedDescr))] public event EventHandler Opened @@ -695,8 +695,8 @@ protected internal override Size MaxItemSize } /// - /// Determines the opacity of the form. This can only be set on top level controls. - /// Opacity requires Windows 2000 or later, and is ignored on earlier operating systems. + /// Determines the opacity of the form. This can only be set on top level controls. + /// Opacity requires Windows 2000 or later, and is ignored on earlier operating systems. /// [SRCategory(nameof(SR.CatWindowStyle))] [TypeConverter(typeof(OpacityConverter))] @@ -766,7 +766,7 @@ private byte OpacityAsByte } /// - /// Summary of OwnerItem. + /// Summary of OwnerItem. /// [DefaultValue(null), Browsable(false)] public ToolStripItem OwnerItem @@ -1008,8 +1008,8 @@ public bool TopLevel // it's not robust enough for our needs // } - /// Override base TabIndex property in order to avoid serialization - /// (since a dropdown shouldn't participate in the taborder...) + /// Override base TabIndex property in order to avoid serialization + /// (since a dropdown shouldn't participate in the taborder...) [ EditorBrowsable(EditorBrowsableState.Never), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), @@ -1053,7 +1053,7 @@ public bool TopLevel remove => base.Validating -= value; } - /// Override base Visible property in order to control serialization by setting default value + /// Override base Visible property in order to control serialization by setting default value [ SRCategory(nameof(SR.CatBehavior)), Localizable(true), @@ -1205,7 +1205,7 @@ public void Close(ToolStripDropDownCloseReason reason) } /// - /// Summary of GetBaseDropDownBounds. + /// Summary of GetBaseDropDownBounds. /// // called by ToolStripDropDownMenu, internal Rectangle GetDropDownBounds(Rectangle suggestedBounds) @@ -1302,7 +1302,7 @@ internal Size GetSuggestedSize() } /// - /// Returns the ToolStrip from which all the dropdowns started from. This can be null. + /// Returns the ToolStrip from which all the dropdowns started from. This can be null. /// internal override ToolStrip GetToplevelOwnerToolStrip() { @@ -1328,7 +1328,7 @@ internal override void HandleItemClicked(ToolStripItem dismissingItem) base.HandleItemClicked(dismissingItem); } /// - /// Set some common properties + /// Set some common properties /// internal virtual void Initialize() { @@ -1350,7 +1350,7 @@ internal virtual void Initialize() } /// - /// Summary of OnLayout. + /// Summary of OnLayout. /// /// protected virtual void OnClosed(ToolStripDropDownClosedEventArgs e) @@ -1371,8 +1371,8 @@ protected virtual void OnClosing(ToolStripDropDownClosingEventArgs e) ((ToolStripDropDownClosingEventHandler)Events[EventClosing])?.Invoke(this, e); } /// - /// When our handle is being created, suspend the deactivation - /// portion of the WndProc, as we'll never be shown. + /// When our handle is being created, suspend the deactivation + /// portion of the WndProc, as we'll never be shown. /// protected override void OnHandleCreated(EventArgs e) { @@ -1417,7 +1417,7 @@ protected virtual void OnOpening(CancelEventArgs e) } /// - /// Summary of OnLayout. + /// Summary of OnLayout. /// /// protected virtual void OnOpened(EventArgs e) @@ -1809,7 +1809,7 @@ internal void SetAutoGeneratedInternal(bool autoGenerated) } /// - /// Sync sizes with the ToolStripDropDown + /// Sync sizes with the ToolStripDropDown /// protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified) { @@ -2314,7 +2314,7 @@ private void WmNCActivate(ref Message m) } #endregion /// - /// Determines if this is the first dropDown in the dropDown chain + /// Determines if this is the first dropDown in the dropDown chain /// internal bool IsFirstDropDown { @@ -2325,7 +2325,7 @@ internal bool IsFirstDropDown } /// - /// returns the root dropdown in the chain. + /// returns the root dropdown in the chain. /// internal ToolStripDropDown GetFirstDropDown() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownButton.cs index de373689f47..33f31dcafae 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownButton.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// A ToolStripButton that can display a popup. + /// A ToolStripButton that can display a popup. /// [ToolStripItemDesignerAvailability(ToolStripItemDesignerAvailability.ToolStrip | ToolStripItemDesignerAvailability.StatusStrip)] public class ToolStripDropDownButton : ToolStripDropDownItem @@ -20,7 +20,7 @@ public class ToolStripDropDownButton : ToolStripDropDownItem private byte openMouseId = 0; /// - /// Constructs a ToolStripButton that can display a popup. + /// Constructs a ToolStripButton that can display a popup. /// public ToolStripDropDownButton() { @@ -98,8 +98,8 @@ public bool ShowDropDownArrow } } /// - /// Creates an instance of the object that defines how image and text - /// gets laid out in the ToolStripItem + /// Creates an instance of the object that defines how image and text + /// gets laid out in the ToolStripItem /// internal override ToolStripItemInternalLayout CreateInternalLayout() { @@ -113,7 +113,7 @@ protected override ToolStripDropDown CreateDefaultDropDown() } /// - /// Called by all constructors of ToolStripButton. + /// Called by all constructors of ToolStripButton. /// private void Initialize() { @@ -121,7 +121,7 @@ private void Initialize() } /// - /// Overriden to invoke displaying the popup. + /// Overriden to invoke displaying the popup. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -166,7 +166,7 @@ protected override void OnMouseLeave(EventArgs e) base.OnMouseLeave(e); } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected override void OnPaint(PaintEventArgs e) { @@ -217,7 +217,7 @@ protected internal override bool ProcessMnemonic(char charCode) } /// - /// An implementation of Accessibleobject for use with ToolStripDropDownButton + /// An implementation of Accessibleobject for use with ToolStripDropDownButton /// [Runtime.InteropServices.ComVisible(true)] internal class ToolStripDropDownButtonAccessibleObject : ToolStripDropDownItemAccessibleObject diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownItem.cs index 9b98448aceb..61e779f85e3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownItem.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms { /// - /// Base class for ToolStripItems that display DropDown windows. + /// Base class for ToolStripItems that display DropDown windows. /// [Designer("System.Windows.Forms.Design.ToolStripMenuItemDesigner, " + AssemblyRef.SystemDesign)] [DefaultProperty(nameof(DropDownItems))] @@ -25,7 +25,7 @@ public abstract class ToolStripDropDownItem : ToolStripItem private static readonly object EventDropDownItemClicked = new object(); /// - /// Protected ctor so you can't create one of these without deriving from it. + /// Protected ctor so you can't create one of these without deriving from it. /// protected ToolStripDropDownItem() { @@ -48,7 +48,7 @@ protected ToolStripDropDownItem(string text, Image image, params ToolStripItem[] } /// - /// The ToolStripDropDown that will be displayed when this item is clicked. + /// The ToolStripDropDown that will be displayed when this item is clicked. /// [ TypeConverter(typeof(ReferenceConverter)), @@ -183,7 +183,7 @@ public ToolStripDropDownDirection DropDownDirection } /// - /// Occurs when the dropdown is closed + /// Occurs when the dropdown is closed /// [ SRCategory(nameof(SR.CatAction)), @@ -219,7 +219,7 @@ public event EventHandler DropDownOpening remove => Events.RemoveHandler(EventDropDownShow, value); } /// - /// Occurs when the dropdown is opened + /// Occurs when the dropdown is opened /// [ SRCategory(nameof(SR.CatAction)), @@ -232,7 +232,7 @@ public event EventHandler DropDownOpened } /// - /// Returns the DropDown's items collection. + /// Returns the DropDown's items collection. /// [ DesignerSerializationVisibility(DesignerSerializationVisibility.Content), @@ -243,7 +243,7 @@ public ToolStripItemCollection DropDownItems => DropDown.Items; /// - /// Occurs when the dropdown is opened + /// Occurs when the dropdown is opened /// [SRCategory(nameof(SR.CatAction))] public event ToolStripItemClickedEventHandler DropDownItemClicked @@ -343,7 +343,7 @@ private void DropDown_ItemClicked(object sender, ToolStripItemClickedEventArgs e => OnDropDownItemClicked(e); /// - /// Make sure we unhook dropdown events. + /// Make sure we unhook dropdown events. /// protected override void Dispose(bool disposing) { @@ -395,7 +395,7 @@ private Rectangle GetDropDownBounds(ToolStripDropDownDirection dropDownDirection } /// - /// Hides the DropDown, if it is visible. + /// Hides the DropDown, if it is visible. /// public void HideDropDown() { @@ -458,7 +458,7 @@ internal override void OnImageScalingSizeChanged(EventArgs e) } /// - /// Called as a response to HideDropDown + /// Called as a response to HideDropDown /// protected virtual void OnDropDownHide(EventArgs e) { @@ -468,7 +468,7 @@ protected virtual void OnDropDownHide(EventArgs e) } /// - /// Last chance to stick in the DropDown before it is shown. + /// Last chance to stick in the DropDown before it is shown. /// protected virtual void OnDropDownShow(EventArgs e) { @@ -476,7 +476,7 @@ protected virtual void OnDropDownShow(EventArgs e) } /// - /// called when the default item is clicked + /// called when the default item is clicked /// protected internal virtual void OnDropDownOpened(EventArgs e) { @@ -489,7 +489,7 @@ protected internal virtual void OnDropDownOpened(EventArgs e) } /// - /// called when the default item is clicked + /// called when the default item is clicked /// protected internal virtual void OnDropDownClosed(EventArgs e) { @@ -508,7 +508,7 @@ protected internal virtual void OnDropDownClosed(EventArgs e) } /// - /// called when the default item is clicked + /// called when the default item is clicked /// protected internal virtual void OnDropDownItemClicked(ToolStripItemClickedEventArgs e) { @@ -639,7 +639,7 @@ private ToolStripDropDownDirection RTLTranslateDropDownDirection(ToolStripDropDo } /// - /// Shows the DropDown, if one is set. + /// Shows the DropDown, if one is set. /// public void ShowDropDown() => ShowDropDown(false); @@ -902,7 +902,7 @@ internal int GetChildFragmentIndex(ToolStripItem.ToolStripItemAccessibleObject c } /// - /// Gets the number of children belonging to an accessible object. + /// Gets the number of children belonging to an accessible object. /// /// The number of children. internal int GetChildFragmentCount() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownMenu.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownMenu.cs index 26db4935e24..86fc2e75b50 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownMenu.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropDownMenu.cs @@ -61,14 +61,14 @@ public class ToolStripDropDownMenu : ToolStripDropDown private int scaledArrowSize = ArrowSize; /// - /// Summary of ToolStripDropDown. + /// Summary of ToolStripDropDown. /// public ToolStripDropDownMenu() { } /// - /// Constructor to autogenerate + /// Constructor to autogenerate /// internal ToolStripDropDownMenu(ToolStripItem ownerItem, bool isAutoGenerated) : base(ownerItem, isAutoGenerated) { if (DpiHelper.IsScalingRequired) { @@ -255,10 +255,10 @@ private ToolStripScrollButton UpScrollButton } /// - /// this takes a native menu and builds up a managed toolstrip around it. - /// Scenario: showing the items from the SystemMenu. - /// targetWindow is the window to send WM_COMMAND, WM_SYSCOMMAND to - /// hmenu is a handle to the native menu. + /// this takes a native menu and builds up a managed toolstrip around it. + /// Scenario: showing the items from the SystemMenu. + /// targetWindow is the window to send WM_COMMAND, WM_SYSCOMMAND to + /// hmenu is a handle to the native menu. /// internal static ToolStripDropDownMenu FromHMenu(IntPtr hmenu, IWin32Window targetWindow) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropTargetManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropTargetManager.cs index bf4e136b3cc..314d2f69f2f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropTargetManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripDropTargetManager.cs @@ -12,9 +12,9 @@ namespace System.Windows.Forms { /// - /// RegisterDropTarget requires an HWND to back it's IDropTargets. Since some ToolStripItems - /// do not have HWNDS, this guy's got to figure out who the event was really supposed - /// to go to and pass it on to it. + /// RegisterDropTarget requires an HWND to back it's IDropTargets. Since some ToolStripItems + /// do not have HWNDS, this guy's got to figure out who the event was really supposed + /// to go to and pass it on to it. /// internal class ToolStripDropTargetManager : IDropTarget { @@ -32,7 +32,7 @@ internal class ToolStripDropTargetManager : IDropTarget #endif /// - /// Summary of ToolStripDropTargetManager. + /// Summary of ToolStripDropTargetManager. /// /// public ToolStripDropTargetManager(ToolStrip owner) @@ -45,7 +45,7 @@ public ToolStripDropTargetManager(ToolStrip owner) } /// - /// Summary of EnsureRegistered. + /// Summary of EnsureRegistered. /// /// public void EnsureRegistered(IDropTarget dropTarget) @@ -55,7 +55,7 @@ public void EnsureRegistered(IDropTarget dropTarget) } /// - /// Summary of EnsureUnRegistered. + /// Summary of EnsureUnRegistered. /// /// public void EnsureUnRegistered(IDropTarget dropTarget) @@ -80,7 +80,7 @@ public void EnsureUnRegistered(IDropTarget dropTarget) } /// - /// Takes a screen point and converts it into an item. May return null. + /// Takes a screen point and converts it into an item. May return null. /// /// /// @@ -89,7 +89,7 @@ private ToolStripItem FindItemAtPoint(int x, int y) return owner.GetItemAt(owner.PointToClient(new Point(x, y))); } /// - /// Summary of OnDragEnter. + /// Summary of OnDragEnter. /// /// public void OnDragEnter(DragEventArgs e) @@ -149,7 +149,7 @@ public void OnDragEnter(DragEventArgs e) } /// - /// Summary of OnDragOver. + /// Summary of OnDragOver. /// /// public void OnDragOver(DragEventArgs e) @@ -206,7 +206,7 @@ public void OnDragOver(DragEventArgs e) } /// - /// Summary of OnDragLeave. + /// Summary of OnDragLeave. /// /// public void OnDragLeave(EventArgs e) @@ -232,7 +232,7 @@ public void OnDragLeave(EventArgs e) } /// - /// Summary of OnDragDrop. + /// Summary of OnDragDrop. /// /// public void OnDragDrop(DragEventArgs e) @@ -300,10 +300,10 @@ private void SetAcceptDrops(bool accept) } /// - /// if we have a new active item, fire drag leave and - /// enter. This corresponds to the case where you - /// are dragging between items and havent actually - /// left the ToolStrip's client area. + /// if we have a new active item, fire drag leave and + /// enter. This corresponds to the case where you + /// are dragging between items and havent actually + /// left the ToolStrip's client area. /// /// /// diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGrip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGrip.cs index 4e870808ae3..23805679e13 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGrip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGrip.cs @@ -38,8 +38,8 @@ internal ToolStripGrip() } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected internal override Padding DefaultMargin { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventArgs.cs index 0071016114c..aada30631e8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventArgs.cs @@ -9,24 +9,24 @@ namespace System.Windows.Forms public class ToolStripGripRenderEventArgs : ToolStripRenderEventArgs { /// - /// This class represents all the information to render the toolStrip + /// This class represents all the information to render the toolStrip /// public ToolStripGripRenderEventArgs(Graphics g, ToolStrip toolStrip) : base(g, toolStrip) { } /// - /// The graphics object to draw with + /// The graphics object to draw with /// public Rectangle GripBounds => ToolStrip.GripRectangle; /// - /// Vertical or horizontal + /// Vertical or horizontal /// public ToolStripGripDisplayStyle GripDisplayStyle => ToolStrip.GripDisplayStyle; /// - /// Visible or hidden + /// Visible or hidden /// public ToolStripGripStyle GripStyle => ToolStrip.GripStyle; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventHandler.cs index 871e9e11e4a..58b88604951 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripGripRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of a ToolStrip item is being rendered + /// Called when the background of a ToolStrip item is being rendered /// public delegate void ToolStripGripRenderEventHandler(object sender, ToolStripGripRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItem.cs index 1cfed92bf7c..1b5bf18af68 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItem.cs @@ -102,7 +102,6 @@ public abstract class ToolStripItem : Component, /// /// Adding a new event?? Make sure you dont need to add to ToolStripControlHost.cs /// - // Property store keys for properties. The property store allocates most efficiently // in groups of four, so we try to lump properties in groups of four based on how // likely they are going to be used in a group. @@ -161,7 +160,7 @@ public abstract class ToolStripItem : Component, /// /// - /// Constructor + /// Constructor /// protected ToolStripItem() { @@ -197,7 +196,7 @@ protected ToolStripItem(string text, Image image, EventHandler onClick, string n } /// - /// The Accessibility Object for this Control + /// The Accessibility Object for this Control /// [ Browsable(false), EditorBrowsable(EditorBrowsableState.Advanced), @@ -220,7 +219,7 @@ public AccessibleObject AccessibilityObject } /// - /// The default action description of the control + /// The default action description of the control /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -241,7 +240,7 @@ public string AccessibleDefaultActionDescription } } /// - /// The accessible description of the control + /// The accessible description of the control /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -263,7 +262,7 @@ public string AccessibleDescription } /// - /// The accessible name of the control + /// The accessible name of the control /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -286,7 +285,7 @@ public string AccessibleName } /// - /// The accessible role of the control + /// The accessible role of the control /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -322,7 +321,7 @@ public AccessibleRole AccessibleRole } /// - /// Determines if the item aligns towards the beginning or end of the ToolStrip. + /// Determines if the item aligns towards the beginning or end of the ToolStrip. /// [ DefaultValue(ToolStripItemAlignment.Left), @@ -355,11 +354,11 @@ public ToolStripItemAlignment Alignment } /// - /// Determines if this item can be dragged. - /// This is EXACTLY like Control.AllowDrop - setting this to true WILL call - /// the droptarget handlers. The ToolStripDropTargetManager is the one that - /// handles the routing of DropTarget events to the ToolStripItem's IDropTarget - /// methods. + /// Determines if this item can be dragged. + /// This is EXACTLY like Control.AllowDrop - setting this to true WILL call + /// the droptarget handlers. The ToolStripDropTargetManager is the one that + /// handles the routing of DropTarget events to the ToolStripItem's IDropTarget + /// methods. /// [ SRCategory(nameof(SR.CatDragDrop)), @@ -385,7 +384,7 @@ public virtual bool AllowDrop } /// - /// Determines whether we set the ToolStripItem to its preferred size + /// Determines whether we set the ToolStripItem to its preferred size /// [DefaultValue(true)] [SRCategory(nameof(SR.CatBehavior))] @@ -430,8 +429,8 @@ public bool AutoToolTip } /// - /// as opposed to Visible, which returns whether or not the item and its parent are Visible - /// Available returns whether or not the item will be shown. Setting Available sets Visible and Vice/Versa + /// as opposed to Visible, which returns whether or not the item and its parent are Visible + /// Available returns whether or not the item will be shown. Setting Available sets Visible and Vice/Versa /// [ Browsable(false), @@ -466,7 +465,7 @@ public event EventHandler AvailableChanged } /// - /// Gets or sets the image that is displayed on a . + /// Gets or sets the image that is displayed on a . /// [ Localizable(true), @@ -541,7 +540,7 @@ public virtual ImageLayout BackgroundImageLayout } /// - /// The BackColor of the item + /// The BackColor of the item /// [ SRCategory(nameof(SR.CatAppearance)), @@ -587,7 +586,7 @@ public event EventHandler BackColorChanged } /// - /// The bounds of the item + /// The bounds of the item /// [Browsable(false)] public virtual Rectangle Bounds @@ -620,7 +619,7 @@ public Rectangle ContentRectangle } /// - /// Determines whether or not the item can be selected. + /// Determines whether or not the item can be selected. /// [Browsable(false)] public virtual bool CanSelect @@ -641,7 +640,7 @@ internal virtual bool CanKeyboardSelect } /// - /// Occurs when the control is clicked. + /// Occurs when the control is clicked. /// [ SRCategory(nameof(SR.CatAction)), @@ -723,8 +722,8 @@ protected virtual bool DefaultAutoToolTip } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected internal virtual Padding DefaultMargin { @@ -742,8 +741,8 @@ protected internal virtual Padding DefaultMargin } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected virtual Padding DefaultPadding { @@ -754,8 +753,8 @@ protected virtual Padding DefaultPadding } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected virtual Size DefaultSize { @@ -776,7 +775,7 @@ protected virtual ToolStripItemDisplayStyle DefaultDisplayStyle } /// - /// specifies the default behavior of these items on ToolStripDropDowns when clicked. + /// specifies the default behavior of these items on ToolStripDropDowns when clicked. /// internal protected virtual bool DismissWhenClicked { @@ -787,8 +786,8 @@ internal protected virtual bool DismissWhenClicked } /// - /// DisplayStyle specifies whether the image and text are rendered. This is not on the base - /// item class because different derived things will have different enumeration needs. + /// DisplayStyle specifies whether the image and text are rendered. This is not on the base + /// item class because different derived things will have different enumeration needs. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -821,7 +820,7 @@ public virtual ToolStripItemDisplayStyle DisplayStyle } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event EventHandler DisplayStyleChanged { @@ -839,7 +838,7 @@ private RightToLeft DefaultRightToLeft } /// - /// Occurs when the control is double clicked. + /// Occurs when the control is double clicked. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.ControlOnDoubleClickDescr))] public event EventHandler DoubleClick @@ -914,14 +913,14 @@ public event EventHandler DragLeave } /// - /// ToolStripItem.DropSource + /// ToolStripItem.DropSource /// - /// This represents what we're actually going to drag. If the parent has set AllowItemReorder to true, - /// then the item should call back on the private OnQueryContinueDrag/OnGiveFeedback that is implemented - /// in the parent ToolStrip. + /// This represents what we're actually going to drag. If the parent has set AllowItemReorder to true, + /// then the item should call back on the private OnQueryContinueDrag/OnGiveFeedback that is implemented + /// in the parent ToolStrip. /// - /// Else if the parent does not support reordering of items (Parent.AllowItemReorder = false) - - /// then call back on the ToolStripItem's OnQueryContinueDrag/OnGiveFeedback methods. + /// Else if the parent does not support reordering of items (Parent.AllowItemReorder = false) - + /// then call back on the ToolStripItem's OnQueryContinueDrag/OnGiveFeedback methods. /// private DropSource DropSource { @@ -936,7 +935,7 @@ private DropSource DropSource } /// - /// Occurs when the control is clicked. + /// Occurs when the control is clicked. /// [ SRCategory(nameof(SR.CatBehavior)), @@ -1006,8 +1005,8 @@ private void EnsureParentDropTargetRegistered() } /// - /// Retrieves the current font for this item. This will be the font used - /// by default for painting and text in the control. + /// Retrieves the current font for this item. This will be the font used + /// by default for painting and text in the control. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -1053,8 +1052,8 @@ public event EventHandler ForeColorChanged } /// - /// Retrieves the current font for this control. This will be the font used - /// by default for painting and text in the control. + /// Retrieves the current font for this control. This will be the font used + /// by default for painting and text in the control. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -1105,7 +1104,7 @@ public event GiveFeedbackEventHandler GiveFeedback } /// - /// The height of this control + /// The height of this control /// [ SRCategory(nameof(SR.CatLayout)), @@ -1126,8 +1125,8 @@ public int Height } /// - /// ToolStripItems do not have children. For perf reasons always return a static empty collection. - /// Consider creating readonly collection. + /// ToolStripItems do not have children. For perf reasons always return a static empty collection. + /// Consider creating readonly collection. /// ArrangedElementCollection IArrangedElement.Children { @@ -1137,7 +1136,7 @@ ArrangedElementCollection IArrangedElement.Children } } /// - /// Should not be exposed as this returns an unexposed type. + /// Should not be exposed as this returns an unexposed type. /// IArrangedElement IArrangedElement.Container { @@ -1191,7 +1190,7 @@ void IArrangedElement.PerformLayout(IArrangedElement container, string propertyN } /// - /// Gets or sets the alignment of the image on the label control. + /// Gets or sets the alignment of the image on the label control. /// [ DefaultValue(ContentAlignment.MiddleCenter), @@ -1221,7 +1220,7 @@ public ContentAlignment ImageAlign } /// - /// Gets or sets the image that is displayed on a . + /// Gets or sets the image that is displayed on a . /// [ Localizable(true), @@ -1306,8 +1305,8 @@ public Color ImageTransparentColor } /// - /// Returns the ToolStripItem's currently set image index - /// Here for compat only - this is NOT to be visible at DT. + /// Returns the ToolStripItem's currently set image index + /// Here for compat only - this is NOT to be visible at DT. /// [ SRDescription(nameof(SR.ToolStripItemImageIndexDescr)), @@ -1358,8 +1357,8 @@ internal ToolStripItemImageIndexer ImageIndexer } /// - /// Returns the ToolStripItem's currently set image index - /// Here for compat only - this is NOT to be visible at DT. + /// Returns the ToolStripItem's currently set image index + /// Here for compat only - this is NOT to be visible at DT. /// [ SRDescription(nameof(SR.ToolStripItemImageKeyDescr)), @@ -1492,7 +1491,7 @@ public bool IsOnDropDown } } - /// returns whether the item placement is set to overflow. + /// returns whether the item placement is set to overflow. [Browsable(false)] public bool IsOnOverflow { @@ -1514,8 +1513,8 @@ internal virtual bool IsMnemonicsListenerAxSourced } /// - /// Occurs when the location of the ToolStripItem has been updated -- usually by layout by its - /// owner of ToolStrips + /// Occurs when the location of the ToolStripItem has been updated -- usually by layout by its + /// owner of ToolStrips /// [SRCategory(nameof(SR.CatLayout)), SRDescription(nameof(SR.ToolStripItemOnLocationChangedDescr))] public event EventHandler LocationChanged @@ -1525,7 +1524,7 @@ public event EventHandler LocationChanged } /// - /// Specifies the external spacing between this item and any other item or the ToolStrip. + /// Specifies the external spacing between this item and any other item or the ToolStrip. /// [ SRDescription(nameof(SR.ToolStripItemMarginDescr)), @@ -1545,7 +1544,7 @@ public Padding Margin } /// - /// Specifies the merge action when merging two ToolStrip. + /// Specifies the merge action when merging two ToolStrip. /// [ SRDescription(nameof(SR.ToolStripMergeActionDescr)), @@ -1580,7 +1579,7 @@ public MergeAction MergeAction } /// - /// Specifies the merge action when merging two ToolStrip. + /// Specifies the merge action when merging two ToolStrip. /// [ SRDescription(nameof(SR.ToolStripMergeIndexDescr)), @@ -1617,8 +1616,8 @@ internal bool MouseDownAndUpMustBeInSameItem } /// - /// Occurs when the mouse pointer is over the control and a mouse button is - /// pressed. + /// Occurs when the mouse pointer is over the control and a mouse button is + /// pressed. /// [ SRCategory(nameof(SR.CatMouse)), @@ -1683,7 +1682,7 @@ public event MouseEventHandler MouseMove } /// - /// Occurs when the mouse pointer is over the control and a mouse button is released. + /// Occurs when the mouse pointer is over the control and a mouse button is released. /// [ SRCategory(nameof(SR.CatMouse)), @@ -1696,9 +1695,9 @@ public event MouseEventHandler MouseUp } /// - /// Name of this control. The designer will set this to the same - /// as the programatic Id "(name)" of the control. The name can be - /// used as a key into the ControlCollection. + /// Name of this control. The designer will set this to the same + /// as the programatic Id "(name)" of the control. The name can be + /// used as a key into the ControlCollection. /// [ Browsable(false), @@ -1721,9 +1720,9 @@ public string Name } /// - /// The owner of this ToolStripItem. The owner is essentially a backpointer to - /// the ToolStrip who contains this item in it's item collection. Handy for getting - /// to things such as the ImageList, which would be defined on the ToolStrip. + /// The owner of this ToolStripItem. The owner is essentially a backpointer to + /// the ToolStrip who contains this item in it's item collection. Handy for getting + /// to things such as the ImageList, which would be defined on the ToolStrip. /// [ Browsable(false), @@ -1752,7 +1751,7 @@ public ToolStrip Owner } /// returns the "parent" item on the preceeding menu which has spawned this item. - /// e.g. File->Open the OwnerItem of Open is File. + /// e.g. File->Open the OwnerItem of Open is File. [ Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden) @@ -1802,12 +1801,12 @@ public event PaintEventHandler Paint } /// - /// The parent of this ToolStripItem. This can be distinct from the owner because - /// the item can fall onto another window (overflow). In this case the overflow - /// would be the parent but the original ToolStrip would be the Owner. The "parent" - /// ToolStrip will be firing things like paint events - where as the "owner" ToolStrip - /// will be containing shared data like image lists. Typically the only one who should - /// set the parent property is the layout manager on the ToolStrip. + /// The parent of this ToolStripItem. This can be distinct from the owner because + /// the item can fall onto another window (overflow). In this case the overflow + /// would be the parent but the original ToolStrip would be the Owner. The "parent" + /// ToolStrip will be firing things like paint events - where as the "owner" ToolStrip + /// will be containing shared data like image lists. Typically the only one who should + /// set the parent property is the layout manager on the ToolStrip. /// [ Browsable(false), @@ -1828,8 +1827,8 @@ internal protected ToolStrip Parent } /// - /// Specifies whether or not the item is glued to the ToolStrip or overflow or - /// can float between the two. + /// Specifies whether or not the item is glued to the ToolStrip or overflow or + /// can float between the two. /// [ DefaultValue(ToolStripItemOverflow.AsNeeded), @@ -1861,7 +1860,7 @@ public ToolStripItemOverflow Overflow } /// - /// Specifies the internal spacing between the contents and the edges of the item + /// Specifies the internal spacing between the contents and the edges of the item /// [ SRDescription(nameof(SR.ToolStripItemPaddingDescr)), @@ -1881,7 +1880,7 @@ public virtual Padding Padding } /// - /// This is explicitly a ToolStrip, because only ToolStrips know how to manage ToolStripitems + /// This is explicitly a ToolStrip, because only ToolStrips know how to manage ToolStripitems /// internal ToolStrip ParentInternal { @@ -1901,7 +1900,7 @@ internal ToolStrip ParentInternal } /// - /// Where the item actually ended up. + /// Where the item actually ended up. /// [Browsable(false)] public ToolStripItemPlacement Placement @@ -1967,7 +1966,7 @@ internal PropertyStore Properties } /// - /// Returns true if the state of the item is pushed + /// Returns true if the state of the item is pushed /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public virtual bool Pressed @@ -2021,9 +2020,9 @@ internal ToolStripRenderer Renderer } /// - /// This is used for international applications where the language - /// is written from RightToLeft. When this property is true, - /// control placement and text will be from right to left. + /// This is used for international applications where the language + /// is written from RightToLeft. When this property is true, + /// control placement and text will be from right to left. /// [ SRCategory(nameof(SR.CatAppearance)), @@ -2082,10 +2081,10 @@ public virtual RightToLeft RightToLeft } /// - /// Mirrors the image when RTL.Yes. - /// Note we do not change what is returned back from the Image property as this would cause problems with serialization. - /// Instead we only change what is painted - there's an internal MirroredImage property which fills in as - /// e.Image in the ToolStripItemImageRenderEventArgs if the item is RTL.Yes and AutoMirrorImage is turned on. + /// Mirrors the image when RTL.Yes. + /// Note we do not change what is returned back from the Image property as this would cause problems with serialization. + /// Instead we only change what is painted - there's an internal MirroredImage property which fills in as + /// e.Image in the ToolStripItemImageRenderEventArgs if the item is RTL.Yes and AutoMirrorImage is turned on. /// [ DefaultValue(false), @@ -2314,7 +2313,7 @@ public virtual string Text } /// - /// Gets or sets the alignment of the text on the label control. + /// Gets or sets the alignment of the text on the label control. /// [ DefaultValue(ContentAlignment.MiddleCenter), @@ -2469,7 +2468,7 @@ public event EventHandler VisibleChanged } /// - /// The width of this ToolStripItem. + /// The width of this ToolStripItem. /// [ SRCategory(nameof(SR.CatLayout)), @@ -2553,8 +2552,8 @@ internal bool BeginDragForItemReorder() } /// - /// constructs the new instance of the accessibility object for this ToolStripItem. Subclasses - /// should not call base.CreateAccessibilityObject. + /// constructs the new instance of the accessibility object for this ToolStripItem. Subclasses + /// should not call base.CreateAccessibilityObject. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual AccessibleObject CreateAccessibilityInstance() @@ -2563,15 +2562,15 @@ protected virtual AccessibleObject CreateAccessibilityInstance() } /// - /// Creates an instance of the object that defines how image and text - /// gets laid out in the ToolStripItem + /// Creates an instance of the object that defines how image and text + /// gets laid out in the ToolStripItem /// internal virtual ToolStripItemInternalLayout CreateInternalLayout() { return new ToolStripItemInternalLayout(this); } /// - /// Disposes this ToolStrip item... + /// Disposes this ToolStrip item... /// protected override void Dispose(bool disposing) { @@ -2608,12 +2607,12 @@ internal static long DoubleClickTicks } /// - /// Begins a drag operation. The allowedEffects determine which - /// drag operations can occur. If the drag operation needs to interop - /// with applications in another process, data should either be - /// a base managed class (String, Bitmap, or Metafile) or some Object - /// that implements System.Runtime.Serialization.ISerializable. data can also be any Object that - /// implements System.Windows.Forms.IDataObject. + /// Begins a drag operation. The allowedEffects determine which + /// drag operations can occur. If the drag operation needs to interop + /// with applications in another process, data should either be + /// a base managed class (String, Bitmap, or Metafile) or some Object + /// that implements System.Runtime.Serialization.ISerializable. data can also be any Object that + /// implements System.Windows.Forms.IDataObject. /// [EditorBrowsable(EditorBrowsableState.Advanced)] public DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects) @@ -2798,7 +2797,7 @@ internal Size GetTextSize() } /// - /// Invalidates the ToolStripItem + /// Invalidates the ToolStripItem /// public void Invalidate() { @@ -2809,7 +2808,7 @@ public void Invalidate() } /// - /// invalidates a rectangle within the ToolStripItem's bounds + /// invalidates a rectangle within the ToolStripItem's bounds /// public void Invalidate(Rectangle r) { @@ -3123,7 +3122,7 @@ protected internal virtual void OnLayout(LayoutEventArgs e) } /// - /// Explicit support of DropTarget + /// Explicit support of DropTarget /// void IDropTarget.OnDragEnter(DragEventArgs dragEvent) { @@ -3142,7 +3141,7 @@ void IDropTarget.OnDragDrop(DragEventArgs dragEvent) OnDragDrop(dragEvent); } /// - /// Explicit support of DropSource + /// Explicit support of DropSource /// void ISupportOleDropSource.OnGiveFeedback(GiveFeedbackEventArgs giveFeedbackEventArgs) { @@ -3179,13 +3178,13 @@ protected virtual void OnAvailableChanged(EventArgs e) } /// - /// Raises the event. - /// Inheriting classes should override this method to handle this event. - /// Call base.onEnter to send this event to any registered event listeners. + /// Raises the event. + /// Inheriting classes should override this method to handle this event. + /// Call base.onEnter to send this event to any registered event listeners. /// /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onDragEnter to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onDragEnter to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDragEnter(DragEventArgs dragEvent) @@ -3194,8 +3193,8 @@ protected virtual void OnDragEnter(DragEventArgs dragEvent) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onDragOver to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onDragOver to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDragOver(DragEventArgs dragEvent) @@ -3204,8 +3203,8 @@ protected virtual void OnDragOver(DragEventArgs dragEvent) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onDragLeave to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onDragLeave to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDragLeave(EventArgs e) @@ -3214,8 +3213,8 @@ protected virtual void OnDragLeave(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onDragDrop to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onDragDrop to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDragDrop(DragEventArgs dragEvent) @@ -3224,7 +3223,7 @@ protected virtual void OnDragDrop(DragEventArgs dragEvent) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected virtual void OnDisplayStyleChanged(EventArgs e) @@ -3233,8 +3232,8 @@ protected virtual void OnDisplayStyleChanged(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onGiveFeedback to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onGiveFeedback to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] // PM review done @@ -3247,8 +3246,8 @@ internal virtual void OnImageScalingSizeChanged(EventArgs e) { } /// - /// Inheriting classes should override this method to handle this event. - /// Call base.onQueryContinueDrag to send this event to any registered event listeners. + /// Inheriting classes should override this method to handle this event. + /// Call base.onQueryContinueDrag to send this event to any registered event listeners. /// [EditorBrowsable(EditorBrowsableState.Advanced)] // PM review done @@ -3258,7 +3257,7 @@ protected virtual void OnQueryContinueDrag(QueryContinueDragEventArgs queryConti } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnDoubleClick(EventArgs e) { @@ -3266,7 +3265,7 @@ protected virtual void OnDoubleClick(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnEnabledChanged(EventArgs e) { @@ -3308,21 +3307,21 @@ protected virtual void OnLocationChanged(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseEnter(EventArgs e) { } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseMove(MouseEventArgs mea) { } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseHover(EventArgs e) { @@ -3333,7 +3332,7 @@ protected virtual void OnMouseHover(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseLeave(EventArgs e) { @@ -3344,21 +3343,21 @@ protected virtual void OnMouseLeave(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseDown(MouseEventArgs e) { } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnMouseUp(MouseEventArgs e) { } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnPaint(PaintEventArgs e) { @@ -3374,7 +3373,7 @@ protected virtual void OnParentBackColorChanged(EventArgs e) } } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnParentChanged(ToolStrip oldParent, ToolStrip newParent) { @@ -3391,7 +3390,7 @@ protected virtual void OnParentChanged(ToolStrip oldParent, ToolStrip newParent) } /// - /// Occurs when this.Parent.Enabled changes. + /// Occurs when this.Parent.Enabled changes. /// protected internal virtual void OnParentEnabledChanged(EventArgs e) { @@ -3399,8 +3398,8 @@ protected internal virtual void OnParentEnabledChanged(EventArgs e) } /// - /// Occurs when the font property has changed on the parent - used to notify inheritors of the font property that - /// the font has changed + /// Occurs when the font property has changed on the parent - used to notify inheritors of the font property that + /// the font has changed /// [EditorBrowsable(EditorBrowsableState.Advanced)] internal protected virtual void OnOwnerFontChanged(EventArgs e) @@ -3431,7 +3430,7 @@ protected internal virtual void OnParentRightToLeftChanged(EventArgs e) } /// - /// Occurs when the owner of an item changes. + /// Occurs when the owner of an item changes. /// protected virtual void OnOwnerChanged(EventArgs e) { @@ -3468,7 +3467,7 @@ internal void OnOwnerTextDirectionChanged() } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnRightToLeftChanged(EventArgs e) { @@ -3491,7 +3490,7 @@ protected virtual void OnTextChanged(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnVisibleChanged(EventArgs e) { @@ -3532,7 +3531,7 @@ internal void Push(bool push) } /// - /// See Control.ProcessDialogKey for more info. + /// See Control.ProcessDialogKey for more info. /// protected internal virtual bool ProcessDialogKey(Keys keyData) { @@ -3550,7 +3549,7 @@ protected internal virtual bool ProcessDialogKey(Keys keyData) } /// - /// See Control.ProcessCmdKey for more info. + /// See Control.ProcessCmdKey for more info. /// protected internal virtual bool ProcessCmdKey(ref Message m, Keys keyData) { @@ -3622,7 +3621,7 @@ internal void RescaleConstantsInternal(int newDpi) /// /// - /// Selects the item + /// Selects the item /// public void Select() { @@ -3727,7 +3726,7 @@ protected virtual void SetVisibleCore(bool visible) } /// - /// Sets the bounds of the item + /// Sets the bounds of the item /// internal protected virtual void SetBounds(Rectangle bounds) { @@ -3825,7 +3824,7 @@ internal virtual bool ShouldSerializeFont() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializePadding() @@ -3834,7 +3833,7 @@ private bool ShouldSerializePadding() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializeMargin() @@ -3843,7 +3842,7 @@ private bool ShouldSerializeMargin() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializeVisible() @@ -3852,7 +3851,7 @@ private bool ShouldSerializeVisible() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializeImage() @@ -3861,7 +3860,7 @@ private bool ShouldSerializeImage() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializeImageKey() @@ -3870,7 +3869,7 @@ private bool ShouldSerializeImageKey() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] private bool ShouldSerializeImageIndex() @@ -3879,7 +3878,7 @@ private bool ShouldSerializeImageIndex() } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal virtual bool ShouldSerializeRightToLeft() @@ -3903,7 +3902,7 @@ private bool ShouldSerializeTextDirection() } /// - /// Resets the back color to be based on the parent's back color. + /// Resets the back color to be based on the parent's back color. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetBackColor() @@ -3918,7 +3917,7 @@ public virtual void ResetDisplayStyle() } /// - /// Resets the fore color to be based on the parent's fore color. + /// Resets the fore color to be based on the parent's fore color. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetForeColor() @@ -3927,7 +3926,7 @@ public virtual void ResetForeColor() } /// - /// Resets the Font to be based on the parent's Font. + /// Resets the Font to be based on the parent's Font. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetFont() @@ -3936,7 +3935,7 @@ public virtual void ResetFont() } /// - /// Resets the back color to be based on the parent's back color. + /// Resets the back color to be based on the parent's back color. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetImage() @@ -3964,7 +3963,7 @@ public void ResetPadding() } /// - /// Resets the RightToLeft to be the default. + /// Resets the RightToLeft to be the default. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetRightToLeft() @@ -3973,7 +3972,7 @@ public virtual void ResetRightToLeft() } /// - /// Resets the TextDirection to be the default. + /// Resets the TextDirection to be the default. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetTextDirection() @@ -3982,7 +3981,7 @@ public virtual void ResetTextDirection() } /// - /// Translates a point from one coordinate system to another + /// Translates a point from one coordinate system to another /// internal Point TranslatePoint(Point fromPoint, ToolStripPointType fromPointType, ToolStripPointType toPointType) { @@ -4070,7 +4069,7 @@ internal ToolStrip RootToolStrip } /// - /// ToString support + /// ToString support /// public override string ToString() { @@ -4226,7 +4225,7 @@ internal virtual bool IsBeingTabbedTo() } /// - /// An implementation of AccessibleChild for use with ToolStripItems + /// An implementation of AccessibleChild for use with ToolStripItems /// [Runtime.InteropServices.ComVisible(true)] public class ToolStripItemAccessibleObject : AccessibleObject @@ -4334,7 +4333,7 @@ internal override int[] RuntimeId } /// - /// Gets the accessible property value. + /// Gets the accessible property value. /// /// The accessible property ID. /// The accessible property value. @@ -4587,7 +4586,7 @@ public override Rectangle Bounds } /// - /// When overridden in a derived class, gets or sets the parent of an accessible object. + /// When overridden in a derived class, gets or sets the parent of an accessible object. /// public override AccessibleObject Parent { @@ -4609,7 +4608,7 @@ public override AccessibleObject Parent } /// - /// Gets the top level element. + /// Gets the top level element. /// internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRoot { @@ -4620,7 +4619,7 @@ internal override UnsafeNativeMethods.IRawElementProviderFragmentRoot FragmentRo } /// - /// Returns the element in the specified direction. + /// Returns the element in the specified direction. /// /// Indicates the direction in which to navigate. /// Returns the element in the specified direction. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemAlignment.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemAlignment.cs index ee6bca9bf6d..c2070724cc9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemAlignment.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemAlignment.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// This enum is used to determine alignment of the ToolStripItem on the ToolStrip. + /// This enum is used to determine alignment of the ToolStripItem on the ToolStrip. /// public enum ToolStripItemAlignment { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventArgs.cs index 7bbe93161a8..68a9db44aa6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms public class ToolStripItemClickedEventArgs : EventArgs { /// - /// This class represents event args a ToolStrip can use when an item has been clicked. + /// This class represents event args a ToolStrip can use when an item has been clicked. /// public ToolStripItemClickedEventArgs(ToolStripItem clickedItem) { @@ -15,7 +15,7 @@ public ToolStripItemClickedEventArgs(ToolStripItem clickedItem) } /// - /// Represents the item that was clicked on the toolStrip. + /// Represents the item that was clicked on the toolStrip. /// public ToolStripItem ClickedItem { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventHandler.cs index 900b5ac8c93..91cae11ca79 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemClickedEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , or event of a form, - /// control, or other component. + /// control, or other component. /// public delegate void ToolStripItemClickedEventHandler(object sender, ToolStripItemClickedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemCollection.cs index a588fe1a7b4..31f1098db3c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemCollection.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms { /// - /// Summary description for ToolStripItemCollection. + /// Summary description for ToolStripItemCollection. /// [ Editor("System.Windows.Forms.Design.ToolStripCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)), @@ -22,10 +22,10 @@ public class ToolStripItemCollection : ArrangedElementCollection, IList private readonly ToolStrip owner; private readonly bool itemsCollection; private readonly bool isReadOnly = false; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. - /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. + /// Note this is not Thread Safe - but WinForms has to be run in a STA anyways. private int lastAccessedIndex = -1; internal ToolStripItemCollection(ToolStrip owner, bool itemsCollection) : this(owner, itemsCollection, /*isReadOnly=*/false) @@ -56,7 +56,7 @@ public ToolStripItemCollection(ToolStrip owner, ToolStripItem[] value) } /// - /// Retrieves the child control with the specified key. + /// Retrieves the child control with the specified key. /// public virtual ToolStripItem this[string key] { @@ -209,7 +209,7 @@ public virtual void Clear() } /// - /// Returns true if the collection contains an item with the specified key, false otherwise. + /// Returns true if the collection contains an item with the specified key, false otherwise. /// public virtual bool ContainsKey(string key) { @@ -241,8 +241,8 @@ private void CheckCanAddOrInsertItem(ToolStripItem value) } /// - /// Searches for Items by their Name property, builds up an array - /// of all the controls that match. + /// Searches for Items by their Name property, builds up an array + /// of all the controls that match. /// public ToolStripItem[] Find(string key, bool searchAllChildren) { @@ -359,7 +359,7 @@ public int IndexOf(ToolStripItem value) return InnerList.IndexOf(value); } /// - /// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1. + /// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1. /// public virtual int IndexOfKey(string key) { @@ -462,7 +462,7 @@ public void RemoveAt(int index) } /// - /// Removes the child item with the specified key. + /// Removes the child item with the specified key. /// public virtual void RemoveByKey(string key) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemDisplayStyle.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemDisplayStyle.cs index f64f7b1e6ba..ebf9aa53aca 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemDisplayStyle.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemDisplayStyle.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Specifies what to render for the ToolStripItem + /// Specifies what to render for the ToolStripItem /// public enum ToolStripItemDisplayStyle { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemEventType.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemEventType.cs index 2f7b9238df7..d47d77f9025 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemEventType.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemEventType.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// These methods allow the ToolStrip to route events - /// to the ToolStrip item. Since a ToolStrip is not a ToolStripItem, - /// it cannot directly call OnPaint. + /// These methods allow the ToolStrip to route events + /// to the ToolStrip item. Since a ToolStrip is not a ToolStripItem, + /// it cannot directly call OnPaint. /// internal enum ToolStripItemEventType { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventArgs.cs index cc72c1cac08..222d2720a91 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventArgs.cs @@ -16,7 +16,7 @@ public ToolStripItemImageRenderEventArgs(Graphics g, ToolStripItem item, Rectang } /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public ToolStripItemImageRenderEventArgs(Graphics g, ToolStripItem item, Image image, Rectangle imageRectangle) : base(g, item) { @@ -25,22 +25,22 @@ public ToolStripItemImageRenderEventArgs(Graphics g, ToolStripItem item, Image i } /// - /// The image to draw + /// The image to draw /// public Image Image { get; } /// - /// The rectangle to draw the Image in + /// The rectangle to draw the Image in /// public Rectangle ImageRectangle { get; } /// - /// Not public as it currently pertains to button & system renderer. + /// Not public as it currently pertains to button & system renderer. /// internal bool ShiftOnPress { get; set; } /// - /// Not public as it currently pertains to ToolStripRenderer. + /// Not public as it currently pertains to ToolStripRenderer. /// internal ImageAttributes ImageAttributes { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventHandler.cs index 4adae999242..d06e021a1a9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemImageRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of a ToolStrip item is being rendered + /// Called when the background of a ToolStrip item is being rendered /// public delegate void ToolStripItemImageRenderEventHandler(object sender, ToolStripItemImageRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemOverflow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemOverflow.cs index 03caf63d10d..aff2636b3a9 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemOverflow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemOverflow.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// This enum is used to determine placement of the ToolStripItem on the ToolStrip. + /// This enum is used to determine placement of the ToolStripItem on the ToolStrip. /// public enum ToolStripItemOverflow { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemPlacement.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemPlacement.cs index 705bf9d776e..32ecda325ff 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemPlacement.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemPlacement.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// This enum represents the current layout of the ToolStripItem. + /// This enum represents the current layout of the ToolStripItem. /// public enum ToolStripItemPlacement { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventArgs.cs index 56da39bb14a..0a29ab24acd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventArgs.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms public class ToolStripItemRenderEventArgs : EventArgs { /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public ToolStripItemRenderEventArgs(Graphics g, ToolStripItem item) { @@ -18,17 +18,17 @@ public ToolStripItemRenderEventArgs(Graphics g, ToolStripItem item) } /// - /// The graphics object to draw with + /// The graphics object to draw with /// public Graphics Graphics { get; } /// - /// The item to draw + /// The item to draw /// public ToolStripItem Item { get; } /// - /// The toolstrip the item is currently parented to + /// The toolstrip the item is currently parented to /// public ToolStrip ToolStrip => Item?.ParentInternal; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventHandler.cs index 264831c57b8..3a28c42b1ac 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of a ToolStrip item is being rendered + /// Called when the background of a ToolStrip item is being rendered /// public delegate void ToolStripItemRenderEventHandler(object sender, ToolStripItemRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventArgs.cs index bc4281b8709..ce1e3ca6d12 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public class ToolStripItemTextRenderEventArgs : ToolStripItemRenderEventArgs { @@ -15,7 +15,7 @@ public class ToolStripItemTextRenderEventArgs : ToolStripItemRenderEventArgs private bool _textColorChanged = false; /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public ToolStripItemTextRenderEventArgs(Graphics g, ToolStripItem item, string text, Rectangle textRectangle, Color textColor, Font textFont, TextFormatFlags format) : base(g, item) { @@ -33,7 +33,7 @@ public ToolStripItemTextRenderEventArgs(Graphics g, ToolStripItem item, string t } /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public ToolStripItemTextRenderEventArgs(Graphics g, ToolStripItem item, string text, Rectangle textRectangle, Color textColor, Font textFont, ContentAlignment textAlign) : base(g, item) { @@ -52,12 +52,12 @@ public ToolStripItemTextRenderEventArgs(Graphics g, ToolStripItem item, string t } /// - /// The string to draw + /// The string to draw /// public string Text { get; set; } /// - /// The color to draw the text + /// The color to draw the text /// public Color TextColor { @@ -72,22 +72,22 @@ public Color TextColor internal Color DefaultTextColor { get; set; } /// - /// The font to draw the text + /// The font to draw the text /// public Font TextFont { get; set; } /// - /// The rectangle to draw the text in + /// The rectangle to draw the text in /// public Rectangle TextRectangle { get; set; } /// - /// The rectangle to draw the text in + /// The rectangle to draw the text in /// public TextFormatFlags TextFormat { get; set; } /// - /// The angle at which the text should be drawn in tenths of degrees. + /// The angle at which the text should be drawn in tenths of degrees. /// public ToolStripTextDirection TextDirection { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventHandler.cs index bbc15053ac3..dbb0d18595e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripItemTextRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of a ToolStrip item is being rendered + /// Called when the background of a ToolStrip item is being rendered /// public delegate void ToolStripItemTextRenderEventHandler(object sender, ToolStripItemTextRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLabel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLabel.cs index 8b3af7434f6..da7f246aaa1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLabel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLabel.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// A non selectable ToolStrip item + /// A non selectable ToolStrip item /// [ToolStripItemDesignerAvailability(ToolStripItemDesignerAvailability.ToolStrip)] public class ToolStripLabel : ToolStripItem @@ -24,7 +24,7 @@ public class ToolStripLabel : ToolStripItem private Cursor lastCursor; /// - /// A non selectable ToolStrip item + /// A non selectable ToolStrip item /// public ToolStripLabel() { @@ -315,8 +315,8 @@ private bool ShouldSerializeVisitedLinkColor() } /// - /// Creates an instance of the object that defines how image and text - /// gets laid out in the ToolStripItem + /// Creates an instance of the object that defines how image and text + /// gets laid out in the ToolStripItem /// internal override ToolStripItemInternalLayout CreateInternalLayout() { @@ -330,7 +330,7 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected override void OnPaint(PaintEventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventArgs.cs index fb93ed474ce..770c851b19e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventArgs.cs @@ -8,12 +8,12 @@ namespace System.Windows.Forms { /// - /// Provides Arguments for the Cancelable LocationChanging Event. + /// Provides Arguments for the Cancelable LocationChanging Event. /// internal class ToolStripLocationCancelEventArgs : CancelEventArgs { /// - /// Initializes a new instance of the ToolStripLocationCancelEventArgs with cancel value. + /// Initializes a new instance of the ToolStripLocationCancelEventArgs with cancel value. /// public ToolStripLocationCancelEventArgs(Point newLocation, bool value) : base(value) { @@ -21,7 +21,7 @@ public ToolStripLocationCancelEventArgs(Point newLocation, bool value) : base(va } /// - /// Returns the New Location of the ToolStrip. + /// Returns the New Location of the ToolStrip. /// public Point NewLocation { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventHandler.cs index 2212f1a0113..086f2514f34 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripLocationCancelEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the event raised when canceling an - /// OnLocationChanging event for ToolStrips. + /// Represents the method that will handle the event raised when canceling an + /// OnLocationChanging event for ToolStrips. /// internal delegate void ToolStripLocationCancelEventHandler(object sender, ToolStripLocationCancelEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripManager.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripManager.cs index bad29683014..de6344ce36d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripManager.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripManager.cs @@ -170,7 +170,7 @@ private static void AddEventHandler(int key, Delegate value) } /// - /// Find a toolstrip in the weak ref arraylist, return null if nothing was found + /// Find a toolstrip in the weak ref arraylist, return null if nothing was found /// public static ToolStrip FindToolStrip(string toolStripName) { @@ -188,7 +188,7 @@ public static ToolStrip FindToolStrip(string toolStripName) } /// - /// Find a toolstrip in the weak ref arraylist, return null if nothing was found + /// Find a toolstrip in the weak ref arraylist, return null if nothing was found /// internal static ToolStrip FindToolStrip(Form owningForm, string toolStripName) { @@ -482,21 +482,21 @@ internal static bool SelectNextToolStrip(ToolStrip start, bool forward) return false; } - /// ============================================================================ + /// ============================================================================ /// BEGIN task specific functions. Since ToolStripManager is used /// for Painting, Merging and Rafting, and who knows what else in the future /// the following properties/methods/events are organized in regions /// alphabetically by task - /// ---------------------------------------------------------------------------- + /// ---------------------------------------------------------------------------- /// /// ToolStripManager Default Renderer /// #region DefaultRenderer - /// These are thread static because we want separate instances - /// for each thread. We dont want to guarantee thread safety - /// and dont want to have to take locks in painting code. + /// These are thread static because we want separate instances + /// for each thread. We dont want to guarantee thread safety + /// and dont want to have to take locks in painting code. [ThreadStatic] private static ToolStripRenderer defaultRenderer; @@ -530,7 +530,7 @@ private static Type DefaultRendererType } /// the default renderer for the thread. When ToolStrip.RenderMode is set to manager - this - /// is the property used. + /// is the property used. /// public static ToolStripRenderer Renderer { @@ -545,7 +545,6 @@ public static ToolStripRenderer Renderer set { /// - if (defaultRenderer != value) { CurrentRendererType = (value == null) ? DefaultRendererType : value.GetType(); @@ -596,7 +595,6 @@ public static ToolStripManagerRenderMode RenderMode { /// - if (!ClientUtils.IsEnumValid(value, (int)value, (int)ToolStripManagerRenderMode.Custom, (int)ToolStripManagerRenderMode.Professional)) { throw new InvalidEnumArgumentException(nameof(value), (int)value, typeof(ToolStripManagerRenderMode)); @@ -615,8 +613,8 @@ public static ToolStripManagerRenderMode RenderMode } /// an additional layering of control. this lets you pick whether your toolbars - /// should use visual style information (theming) to render itself. - /// potentially you could want a themed app but an unthemed toolstrip. (e.g. Whidbey VS). + /// should use visual style information (theming) to render itself. + /// potentially you could want a themed app but an unthemed toolstrip. (e.g. Whidbey VS). /// public static bool VisualStylesEnabled { @@ -785,10 +783,9 @@ public static void SaveSettings(Form sourceForm, string key) /// /// ToolStripManager ALT key PreProcessing /// - #region MenuKeyAndShortcutProcessing - /// ModalMenuFilter + /// ModalMenuFilter /// - this installs a message filter when a dropdown becomes active. /// - the message filter /// a. eats WM_MOUSEMOVEs so that the window that's underneath @@ -801,8 +798,8 @@ public static void SaveSettings(Form sourceForm, string key) /// /// - There should be 1 Message Filter per thread and it should be uninstalled once /// the last dropdown has gone away - /// This is not part of ToolStripManager because it's DropDown specific and - /// we dont want to publicly expose this message filter. + /// This is not part of ToolStripManager because it's DropDown specific and + /// we dont want to publicly expose this message filter. internal class ModalMenuFilter : IMessageModifyAndFilter { private HandleRef _activeHwnd = NativeMethods.NullHandleRef; // the window that was active when we showed the dropdown @@ -843,7 +840,7 @@ private ModalMenuFilter() { } - /// this is the HWnd that was active when we popped the first dropdown. + /// this is the HWnd that was active when we popped the first dropdown. internal static HandleRef ActiveHwnd { get { return Instance.ActiveHwndInternal; } @@ -923,9 +920,9 @@ internal static bool MenuKeyToggle } } - /// This is used in scenarios where windows forms - /// does not own the message pump, but needs access - /// to the message queue. + /// This is used in scenarios where windows forms + /// does not own the message pump, but needs access + /// to the message queue. private HostedWindowsFormsMessageHook MessageHook { get @@ -2063,9 +2060,8 @@ private static MenuStrip GetFirstMenuStripRecursive(Control.ControlCollection co #endregion MenuKeyAndShortcutProcessing /// - /// ToolStripManager MenuMerging functions + /// ToolStripManager MenuMerging functions /// - #region MenuMerging private static ToolStripItem FindMatch(ToolStripItem source, ToolStripItemCollection destinationItems) @@ -2123,7 +2119,7 @@ private static bool IsSpecialMDIStrip(ToolStrip toolStrip) } /// - /// merge two toolstrips + /// merge two toolstrips /// public static bool Merge(ToolStrip sourceToolStrip, ToolStrip targetToolStrip) { @@ -2314,7 +2310,7 @@ private static void MergeRecursive(ToolStripItem source, ToolStripItemCollection } /// - /// merge two toolstrips + /// merge two toolstrips /// public static bool Merge(ToolStrip sourceToolStrip, string targetName) { @@ -2339,7 +2335,7 @@ public static bool Merge(ToolStrip sourceToolStrip, string targetName) } /// - /// doesn't do a null check on source... if it's null we unmerge everything + /// doesn't do a null check on source... if it's null we unmerge everything /// internal static bool RevertMergeInternal(ToolStrip targetToolStrip, ToolStrip sourceToolStrip, bool revertMDIControls) { @@ -2449,7 +2445,7 @@ internal static bool RevertMergeInternal(ToolStrip targetToolStrip, ToolStrip so } /// - /// unmerge two toolstrips + /// unmerge two toolstrips /// public static bool RevertMerge(ToolStrip targetToolStrip) { @@ -2457,7 +2453,7 @@ public static bool RevertMerge(ToolStrip targetToolStrip) } /// - /// unmerge two toolstrips + /// unmerge two toolstrips /// public static bool RevertMerge(ToolStrip targetToolStrip, ToolStrip sourceToolStrip) { @@ -2469,7 +2465,7 @@ public static bool RevertMerge(ToolStrip targetToolStrip, ToolStrip sourceToolSt } /// - /// unmerge two toolstrips + /// unmerge two toolstrips /// public static bool RevertMerge(string targetName) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripMenuItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripMenuItem.cs index 53e6b72f968..0d7eb6cd310 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripMenuItem.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripMenuItem.cs @@ -13,7 +13,7 @@ namespace System.Windows.Forms { /// - /// ToolStripMenuItem + /// ToolStripMenuItem /// [ToolStripItemDesignerAvailability(ToolStripItemDesignerAvailability.MenuStrip | ToolStripItemDesignerAvailability.ContextMenuStrip)] [DesignerSerializer("System.Windows.Forms.Design.ToolStripMenuItemCodeDomSerializer, " + AssemblyRef.SystemDesign, "System.ComponentModel.Design.Serialization.CodeDomSerializer, " + AssemblyRef.SystemDesign)] @@ -195,8 +195,8 @@ private void Initialize() } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected override Size DefaultSize { get { @@ -254,7 +254,7 @@ public override bool Enabled } /// - /// Gets or sets a value indicating whether the item is checked. + /// Gets or sets a value indicating whether the item is checked. /// [ Bindable(true), @@ -281,8 +281,8 @@ public bool Checked } /// - /// Keeps a shared copy of the checked image between all menu items - /// Fishes out the appropriate one based on CheckState. + /// Keeps a shared copy of the checked image between all menu items + /// Fishes out the appropriate one based on CheckState. /// internal Image CheckedImage { @@ -397,8 +397,8 @@ public bool CheckOnClick } /// - /// Gets - /// or sets a value indicating whether the check box is checked. + /// Gets + /// or sets a value indicating whether the check box is checked. /// [ Bindable(true), @@ -433,9 +433,9 @@ public CheckState CheckState } /// - /// Occurs when the - /// value of the - /// property changes. + /// Occurs when the + /// value of the + /// property changes. /// [SRDescription(nameof(SR.CheckBoxOnCheckedChangedDescr))] public event EventHandler CheckedChanged @@ -444,9 +444,9 @@ public event EventHandler CheckedChanged remove => Events.RemoveHandler(EventCheckedChanged, value); } /// - /// Occurs when the - /// value of the - /// property changes. + /// Occurs when the + /// value of the + /// property changes. /// [SRDescription(nameof(SR.CheckBoxOnCheckStateChangedDescr))] public event EventHandler CheckStateChanged @@ -456,8 +456,8 @@ public event EventHandler CheckStateChanged } /// - /// Specifies whether or not the item is glued to the ToolStrip or overflow or - /// can float between the two. + /// Specifies whether or not the item is glued to the ToolStrip or overflow or + /// can float between the two. /// [ DefaultValue(ToolStripItemOverflow.Never), @@ -477,8 +477,8 @@ public event EventHandler CheckStateChanged } /// - /// Gets or sets the shortcut keys associated with the menu - /// item. + /// Gets or sets the shortcut keys associated with the menu + /// item. /// [ Localizable(true), @@ -567,10 +567,10 @@ public string ShortcutKeyDisplayString } /// - /// Gets or sets a value that indicates whether the shortcut - /// keys that are assocaited - /// with the menu item are displayed next to the menu item - /// caption. + /// Gets or sets a value that indicates whether the shortcut + /// keys that are assocaited + /// with the menu item are displayed next to the menu item + /// caption. /// [ DefaultValue(true), @@ -600,8 +600,8 @@ public bool ShowShortcutKeys } /// - /// An item is toplevel if it is parented to anything other than a ToolStripDropDownMenu - /// This implies that a ToolStripMenuItem in an overflow IS a toplevel item + /// An item is toplevel if it is parented to anything other than a ToolStripDropDownMenu + /// This implies that a ToolStripMenuItem in an overflow IS a toplevel item /// internal bool IsTopLevel { @@ -957,8 +957,8 @@ protected override void OnClick(EventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnCheckedChanged(EventArgs e) { @@ -966,7 +966,7 @@ protected virtual void OnCheckedChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnCheckStateChanged(EventArgs e) { @@ -1230,7 +1230,7 @@ protected override void OnPaint(PaintEventArgs e) } /// - /// handle shortcut keys here. + /// handle shortcut keys here. /// protected internal override bool ProcessCmdKey(ref Message m, Keys keyData) { @@ -1322,7 +1322,7 @@ internal override bool IsBeingTabbedTo() } /// - /// An implementation of AccessibleChild for use with ToolStripItems + /// An implementation of AccessibleChild for use with ToolStripItems /// [ComVisible(true)] internal class ToolStripMenuItemAccessibleObject : ToolStripDropDownItemAccessibleObject diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflow.cs index cdba658d8d8..bc836aecd22 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflow.cs @@ -89,7 +89,7 @@ void IArrangedElement.SetBounds(Rectangle bounds, BoundsSpecified specified) } /// - /// Summary of CreateLayoutEngine. + /// Summary of CreateLayoutEngine. /// /// public override LayoutEngine LayoutEngine diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflowButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflowButton.cs index 69dcbeb432d..22bd60ddcb3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflowButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripOverflowButton.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// ToolStripOverflowButton + /// ToolStripOverflowButton /// [ToolStripItemDesignerAvailability(ToolStripItemDesignerAvailability.None)] public class ToolStripOverflowButton : ToolStripDropDownButton diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanel.cs index c86ba3060ba..3e820e7d9a7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanel.cs @@ -146,7 +146,7 @@ public override bool AutoSize } - /// Override base AutoSizeChanged to we can change visibility/browsability attributes + /// Override base AutoSizeChanged to we can change visibility/browsability attributes [ Browsable(true), EditorBrowsable(EditorBrowsableState.Always) @@ -312,7 +312,7 @@ public event EventHandler RendererChanged } /// - /// Collection of child controls. + /// Collection of child controls. /// [ Browsable(false), @@ -638,7 +638,7 @@ protected virtual void OnRendererChanged(EventArgs e) } /// - /// We want to Set ToolStripPanel at DesignTime when the ToolStripPanel is added to the Form, + /// We want to Set ToolStripPanel at DesignTime when the ToolStripPanel is added to the Form, /// protected override void OnParentChanged(EventArgs e) { @@ -1293,8 +1293,8 @@ private void MoveOutsideContainer(ToolStrip toolStripToDrag, Point screenLocatio } /// - /// Given a point within the ToolStripPanel client area - - /// it returns the row. If no such row exists, returns null + /// Given a point within the ToolStripPanel client area - + /// it returns the row. If no such row exists, returns null /// public ToolStripPanelRow PointToRow(Point clientLocation) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelCell.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelCell.cs index cb18120282d..100344a9aa2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelCell.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelCell.cs @@ -10,11 +10,11 @@ namespace System.Windows.Forms using System.Diagnostics; using System.Globalization; - /// this class is a container for toolstrips on a rafting row. - /// you can set layout styles on this container all day long and not - /// affect the underlying toolstrip's properties.... so if its - /// removed from a rafting container its still got its defaults - /// set up for it. + /// this class is a container for toolstrips on a rafting row. + /// you can set layout styles on this container all day long and not + /// affect the underlying toolstrip's properties.... so if its + /// removed from a rafting container its still got its defaults + /// set up for it. internal class ToolStripPanelCell : ArrangedElement { private ToolStrip _wrappedToolStrip = null; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventArgs.cs index 678edf27af8..174f30165fd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventArgs.cs @@ -18,12 +18,12 @@ public ToolStripPanelRenderEventArgs(Graphics g, ToolStripPanel toolStripPanel) } /// - /// The graphics object to draw with + /// The graphics object to draw with /// public Graphics Graphics { get; } /// - /// Represents which toolStrip was affected by the click + /// Represents which toolStrip was affected by the click /// public ToolStripPanel ToolStripPanel { get; } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventHandler.cs index 52985a4f92a..39c5c0f93bd 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of the ToolStripPanel is being rendered + /// Called when the background of the ToolStripPanel is being rendered /// public delegate void ToolStripPanelRenderEventHandler(object sender, ToolStripPanelRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRow.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRow.cs index 77d613670bd..7063a7aed68 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRow.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripPanelRow.cs @@ -95,7 +95,7 @@ public Control[] Controls } /// - /// Collection of child controls. + /// Collection of child controls. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), SRDescription(nameof(SR.ControlControlsDescr))] internal ToolStripPanelRowControlCollection ControlsInternal @@ -294,8 +294,8 @@ internal void Debug_PrintRowID() #endif /// - /// returns true if there is enough space to "raft" the control - /// ow returns false + /// returns true if there is enough space to "raft" the control + /// ow returns false /// public bool CanMove(ToolStrip toolStripToDrag) { @@ -689,7 +689,7 @@ ArrangedElementCollection IArrangedElement.Children } /// - /// Should not be exposed as this returns an unexposed type. + /// Should not be exposed as this returns an unexposed type. /// IArrangedElement IArrangedElement.Container { @@ -937,8 +937,8 @@ public ToolStripPanelCell GetNextVisibleCell(int index, bool forward) } /// - /// grows all controls after the index to be their preferred size. - /// reports back how much space was used. + /// grows all controls after the index to be their preferred size. + /// reports back how much space was used. /// protected virtual int GrowControlsAfter(int index, int growBy) { @@ -969,8 +969,8 @@ protected virtual int GrowControlsAfter(int index, int growBy) } /// - /// grows all controls before the index to be their preferred size. - /// reports back how much space was used. + /// grows all controls before the index to be their preferred size. + /// reports back how much space was used. /// protected virtual int GrowControlsBefore(int index, int growBy) { @@ -2223,21 +2223,21 @@ public override void LeaveRow(ToolStrip toolStripToDrag) } /// - /// ToolStripPanelRowControlCollection + /// ToolStripPanelRowControlCollection /// - /// this class represents the collection of controls on a particular row. - /// when you add and remove controls from this collection - you also add and remove - /// controls to and from the ToolStripPanel.Control's collection (which happens - /// to be externally readonly.) + /// this class represents the collection of controls on a particular row. + /// when you add and remove controls from this collection - you also add and remove + /// controls to and from the ToolStripPanel.Control's collection (which happens + /// to be externally readonly.) /// - /// This class is used to represent the IArrangedElement.Children for the ToolStripPanelRow - - /// which means that this collection represents the IArrangedElements to layout for - /// a particular ToolStripPanelRow. + /// This class is used to represent the IArrangedElement.Children for the ToolStripPanelRow - + /// which means that this collection represents the IArrangedElements to layout for + /// a particular ToolStripPanelRow. /// - /// We need to keep copies of the controls in both the ToolStripPanelRowControlCollection and - /// the ToolStripPanel.Control collection as the ToolStripPanel.Control collection - /// is responsible for parenting and unparenting the controls (ToolStripPanelRows do NOT derive from - /// Control and thus are NOT hwnd backed). + /// We need to keep copies of the controls in both the ToolStripPanelRowControlCollection and + /// the ToolStripPanel.Control collection as the ToolStripPanel.Control collection + /// is responsible for parenting and unparenting the controls (ToolStripPanelRows do NOT derive from + /// Control and thus are NOT hwnd backed). /// internal class ToolStripPanelRowControlCollection : ArrangedElementCollection, IList, IEnumerable { @@ -2539,9 +2539,9 @@ public void CopyTo(Control[] array, int index) } } - /// We want to pretend like we're only holding controls... so everywhere we've returned controls. - /// but the problem is if you do a foreach, you'll get the cells not the controls. So we've got - /// to sort of write a wrapper class around the ArrayList enumerator. + /// We want to pretend like we're only holding controls... so everywhere we've returned controls. + /// but the problem is if you do a foreach, you'll get the cells not the controls. So we've got + /// to sort of write a wrapper class around the ArrayList enumerator. private class ToolStripPanelCellToControlEnumerator : IEnumerator, ICloneable { private readonly IEnumerator arrayListEnumerator; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripProgressBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripProgressBar.cs index 2896a9df15c..22c64769bc1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripProgressBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripProgressBar.cs @@ -38,7 +38,7 @@ public ToolStripProgressBar(string name) : this() } /// - /// Create a strongly typed accessor for the class + /// Create a strongly typed accessor for the class /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -85,7 +85,7 @@ public override ImageLayout BackgroundImageLayout } /// - /// Specify what size you want the item to start out at + /// Specify what size you want the item to start out at /// /// protected override Size DefaultSize @@ -97,7 +97,7 @@ protected override Size DefaultSize } /// - /// Specify how far from the edges you want to be + /// Specify how far from the edges you want to be /// /// protected internal override Padding DefaultMargin @@ -188,7 +188,7 @@ public virtual bool RightToLeftLayout } /// - /// Wrap some commonly used properties + /// Wrap some commonly used properties /// /// [ @@ -209,7 +209,7 @@ public int Step } /// - /// Wrap some commonly used properties + /// Wrap some commonly used properties /// /// [ @@ -230,7 +230,7 @@ public ProgressBarStyle Style } /// - /// Hide the property. + /// Hide the property. /// [ Browsable(false), @@ -250,7 +250,7 @@ public override string Text } /// - /// Wrap some commonly used properties + /// Wrap some commonly used properties /// /// [ @@ -315,7 +315,7 @@ protected override void OnUnsubscribeControlEvents(Control control) } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -328,7 +328,7 @@ protected override void OnUnsubscribeControlEvents(Control control) } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -341,7 +341,7 @@ protected override void OnUnsubscribeControlEvents(Control control) } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -353,7 +353,7 @@ protected override void OnUnsubscribeControlEvents(Control control) remove => base.KeyUp -= value; } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -366,7 +366,7 @@ protected override void OnUnsubscribeControlEvents(Control control) } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -386,7 +386,7 @@ public event EventHandler RightToLeftLayoutChanged } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -399,7 +399,7 @@ public event EventHandler RightToLeftLayoutChanged } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), @@ -412,7 +412,7 @@ public event EventHandler RightToLeftLayoutChanged } /// - /// Hide the event. + /// Hide the event. /// [ Browsable(false), diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventArgs.cs index 1d6419cef40..a290d9c23f4 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventArgs.cs @@ -11,7 +11,7 @@ public class ToolStripRenderEventArgs : EventArgs private Color _backColor = Color.Empty; /// - /// This class represents all the information to render the toolStrip + /// This class represents all the information to render the toolStrip /// public ToolStripRenderEventArgs(Graphics g, ToolStrip toolStrip) { @@ -32,22 +32,22 @@ public ToolStripRenderEventArgs(Graphics g, ToolStrip toolStrip, Rectangle affec } /// - /// The graphics object to draw with + /// The graphics object to draw with /// public Graphics Graphics { get; } /// - /// The bounds to draw in + /// The bounds to draw in /// public Rectangle AffectedBounds { get; } /// - /// Represents which toolStrip was affected by the click + /// Represents which toolStrip was affected by the click /// public ToolStrip ToolStrip { get; } /// - /// The back color to draw with. + /// The back color to draw with. /// public Color BackColor { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventHandler.cs index eb1dc1b24f2..9621ad8a575 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of the ToolStrip is being rendered + /// Called when the background of the ToolStrip is being rendered /// public delegate void ToolStripRenderEventHandler(object sender, ToolStripRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderer.cs index f9ec31524f0..c1ca6376c4d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripRenderer.cs @@ -130,9 +130,8 @@ internal virtual ToolStripRenderer RendererOverride } } - /// ----------------------------------------------------------------------------- + /// ----------------------------------------------------------------------------- /// - public event ToolStripArrowRenderEventHandler RenderArrow { add => AddHandler(EventRenderArrow, value); @@ -140,7 +139,7 @@ public event ToolStripArrowRenderEventHandler RenderArrow } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripRenderEventHandler RenderToolStripBackground { @@ -161,7 +160,7 @@ public event ToolStripContentPanelRenderEventHandler RenderToolStripContentPanel } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripRenderEventHandler RenderToolStripBorder { @@ -170,7 +169,7 @@ public event ToolStripRenderEventHandler RenderToolStripBorder } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderButtonBackground { @@ -178,7 +177,7 @@ public event ToolStripItemRenderEventHandler RenderButtonBackground remove => RemoveHandler(EventRenderButtonBackground, value); } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderDropDownButtonBackground { @@ -187,7 +186,7 @@ public event ToolStripItemRenderEventHandler RenderDropDownButtonBackground } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderOverflowButtonBackground { @@ -195,7 +194,7 @@ public event ToolStripItemRenderEventHandler RenderOverflowButtonBackground remove => RemoveHandler(EventRenderOverflowButtonBackground, value); } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripGripRenderEventHandler RenderGrip { @@ -203,7 +202,7 @@ public event ToolStripGripRenderEventHandler RenderGrip remove => RemoveHandler(EventRenderGrip, value); } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderItemBackground { @@ -211,7 +210,7 @@ public event ToolStripItemRenderEventHandler RenderItemBackground remove => RemoveHandler(EventRenderItemBackground, value); } /// - /// Draws the split button + /// Draws the split button /// public event ToolStripItemImageRenderEventHandler RenderItemImage { @@ -219,7 +218,7 @@ public event ToolStripItemImageRenderEventHandler RenderItemImage remove => RemoveHandler(EventRenderItemImage, value); } /// - /// Draws the checkmark + /// Draws the checkmark /// public event ToolStripItemImageRenderEventHandler RenderItemCheck { @@ -227,7 +226,7 @@ public event ToolStripItemImageRenderEventHandler RenderItemCheck remove => RemoveHandler(EventRenderItemCheck, value); } /// - /// Draws the split button + /// Draws the split button /// public event ToolStripItemTextRenderEventHandler RenderItemText { @@ -241,7 +240,7 @@ public event ToolStripRenderEventHandler RenderImageMargin remove => RemoveHandler(EventRenderImageMargin, value); } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderLabelBackground { @@ -249,7 +248,7 @@ public event ToolStripItemRenderEventHandler RenderLabelBackground remove => RemoveHandler(EventRenderLabelBackground, value); } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripItemRenderEventHandler RenderMenuItemBackground { @@ -258,7 +257,7 @@ public event ToolStripItemRenderEventHandler RenderMenuItemBackground } /// - /// Draws the split button + /// Draws the split button /// public event ToolStripItemRenderEventHandler RenderToolStripStatusLabelBackground { @@ -267,7 +266,7 @@ public event ToolStripItemRenderEventHandler RenderToolStripStatusLabelBackgroun } /// - /// Occurs when the display style has changed + /// Occurs when the display style has changed /// public event ToolStripRenderEventHandler RenderStatusStripSizingGrip { @@ -276,7 +275,7 @@ public event ToolStripRenderEventHandler RenderStatusStripSizingGrip } /// - /// Draws the split button + /// Draws the split button /// public event ToolStripItemRenderEventHandler RenderSplitButtonBackground { @@ -291,9 +290,8 @@ public event ToolStripSeparatorRenderEventHandler RenderSeparator } #region EventHandlerSecurity - /// ----------------------------------------------------------------------------- + /// ----------------------------------------------------------------------------- /// - private void AddHandler(object key, Delegate value) { Events.AddHandler(key, value); @@ -321,7 +319,7 @@ public void DrawArrow(ToolStripArrowRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawToolStripBackground(ToolStripRenderEventArgs e) { @@ -334,7 +332,7 @@ public void DrawToolStripBackground(ToolStripRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawGrip(ToolStripGripRenderEventArgs e) { @@ -346,7 +344,7 @@ public void DrawGrip(ToolStripGripRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// public void DrawItemBackground(ToolStripItemRenderEventArgs e) { @@ -360,7 +358,7 @@ public void DrawItemBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawImageMargin(ToolStripRenderEventArgs e) { @@ -373,7 +371,7 @@ public void DrawImageMargin(ToolStripRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawLabelBackground(ToolStripItemRenderEventArgs e) { @@ -385,7 +383,7 @@ public void DrawLabelBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// public void DrawButtonBackground(ToolStripItemRenderEventArgs e) { @@ -408,7 +406,7 @@ public void DrawToolStripBorder(ToolStripRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// public void DrawDropDownButtonBackground(ToolStripItemRenderEventArgs e) { @@ -421,7 +419,7 @@ public void DrawDropDownButtonBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// public void DrawOverflowButtonBackground(ToolStripItemRenderEventArgs e) { @@ -434,7 +432,7 @@ public void DrawOverflowButtonBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw image + /// Draw image /// public void DrawItemImage(ToolStripItemImageRenderEventArgs e) { @@ -447,7 +445,7 @@ public void DrawItemImage(ToolStripItemImageRenderEventArgs e) } /// - /// Draw image + /// Draw image /// public void DrawItemCheck(ToolStripItemImageRenderEventArgs e) { @@ -460,7 +458,7 @@ public void DrawItemCheck(ToolStripItemImageRenderEventArgs e) } /// - /// Draw text + /// Draw text /// public void DrawItemText(ToolStripItemTextRenderEventArgs e) { @@ -473,7 +471,7 @@ public void DrawItemText(ToolStripItemTextRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// public void DrawMenuItemBackground(ToolStripItemRenderEventArgs e) { @@ -486,7 +484,7 @@ public void DrawMenuItemBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawSplitButton(ToolStripItemRenderEventArgs e) { @@ -500,7 +498,7 @@ public void DrawSplitButton(ToolStripItemRenderEventArgs e) } /// - /// Draw the background color + /// Draw the background color /// public void DrawToolStripStatusLabelBackground(ToolStripItemRenderEventArgs e) { @@ -524,7 +522,7 @@ public void DrawStatusStripSizingGrip(ToolStripRenderEventArgs e) } } /// - /// Draw the separator + /// Draw the separator /// public void DrawSeparator(ToolStripSeparatorRenderEventArgs e) { @@ -671,7 +669,7 @@ protected virtual void OnRenderArrow(ToolStripArrowRenderEventArgs e){ } /// - /// Draw the ToolStrip background. ToolStrip users should override this if they want to draw differently. + /// Draw the ToolStrip background. ToolStrip users should override this if they want to draw differently. /// protected virtual void OnRenderToolStripBackground(ToolStripRenderEventArgs e) { @@ -683,7 +681,7 @@ protected virtual void OnRenderToolStripBackground(ToolStripRenderEventArgs e) } /// - /// Draw the border around the ToolStrip. This should be done as the last step. + /// Draw the border around the ToolStrip. This should be done as the last step. /// protected virtual void OnRenderToolStripBorder(ToolStripRenderEventArgs e) { @@ -695,7 +693,7 @@ protected virtual void OnRenderToolStripBorder(ToolStripRenderEventArgs e) } /// - /// Draw the grip. ToolStrip users should override this if they want to draw differently. + /// Draw the grip. ToolStrip users should override this if they want to draw differently. /// protected virtual void OnRenderGrip(ToolStripGripRenderEventArgs e) { @@ -707,7 +705,7 @@ protected virtual void OnRenderGrip(ToolStripGripRenderEventArgs e) } /// - /// Draw the items background + /// Draw the items background /// protected virtual void OnRenderItemBackground(ToolStripItemRenderEventArgs e) { @@ -720,7 +718,7 @@ protected virtual void OnRenderItemBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the items background + /// Draw the items background /// protected virtual void OnRenderImageMargin(ToolStripRenderEventArgs e) { @@ -732,7 +730,7 @@ protected virtual void OnRenderImageMargin(ToolStripRenderEventArgs e) } /// - /// Draw the button background + /// Draw the button background /// protected virtual void OnRenderButtonBackground(ToolStripItemRenderEventArgs e) { @@ -745,7 +743,7 @@ protected virtual void OnRenderButtonBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the button background + /// Draw the button background /// protected virtual void OnRenderDropDownButtonBackground(ToolStripItemRenderEventArgs e) { @@ -758,7 +756,7 @@ protected virtual void OnRenderDropDownButtonBackground(ToolStripItemRenderEvent } /// - /// Draw the button background + /// Draw the button background /// protected virtual void OnRenderOverflowButtonBackground(ToolStripItemRenderEventArgs e) { @@ -769,8 +767,8 @@ protected virtual void OnRenderOverflowButtonBackground(ToolStripItemRenderEvent } } /// - /// Draw the item'si mage. ToolStrip users should override this function to change the - /// drawing of all images. + /// Draw the item'si mage. ToolStrip users should override this function to change the + /// drawing of all images. /// protected virtual void OnRenderItemImage(ToolStripItemImageRenderEventArgs e) { @@ -836,8 +834,8 @@ protected virtual void OnRenderItemCheck(ToolStripItemImageRenderEventArgs e) } /// - /// Draw the item's text. ToolStrip users should override this function to change the - /// drawing of all text. + /// Draw the item's text. ToolStrip users should override this function to change the + /// drawing of all text. /// protected virtual void OnRenderItemText(ToolStripItemTextRenderEventArgs e) { @@ -881,7 +879,7 @@ protected virtual void OnRenderItemText(ToolStripItemTextRenderEventArgs e) } /// - /// Draw the button background + /// Draw the button background /// protected virtual void OnRenderLabelBackground(ToolStripItemRenderEventArgs e) { @@ -893,7 +891,7 @@ protected virtual void OnRenderLabelBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the items background + /// Draw the items background /// protected virtual void OnRenderMenuItemBackground(ToolStripItemRenderEventArgs e) { @@ -905,8 +903,8 @@ protected virtual void OnRenderMenuItemBackground(ToolStripItemRenderEventArgs e } /// - /// Draws a toolbar separator. ToolStrip users should override this function to change the - /// drawing of all separators. + /// Draws a toolbar separator. ToolStrip users should override this function to change the + /// drawing of all separators. /// protected virtual void OnRenderSeparator(ToolStripSeparatorRenderEventArgs e) { @@ -995,7 +993,7 @@ protected virtual void OnRenderStatusStripSizingGrip(ToolStripRenderEventArgs e) } /// - /// Draw the item's background. + /// Draw the item's background. /// protected virtual void OnRenderSplitButtonBackground(ToolStripItemRenderEventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripScrollButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripScrollButton.cs index a630d1e93b9..69197835408 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripScrollButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripScrollButton.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// A non selectable ToolStrip item + /// A non selectable ToolStrip item /// internal class ToolStripScrollButton : ToolStripControlHost { @@ -40,8 +40,8 @@ private static Control CreateControlInstance(bool up) } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected internal override Padding DefaultMargin { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparator.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparator.cs index f6078c68ce4..952a755b056 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparator.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparator.cs @@ -503,7 +503,7 @@ internal protected override void SetBounds(Rectangle rect) } /// - /// An implementation of AccessibleChild for use with ToolStripItems + /// An implementation of AccessibleChild for use with ToolStripItems /// [Runtime.InteropServices.ComVisible(true)] internal class ToolStripSeparatorAccessibleObject : ToolStripItemAccessibleObject diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventArgs.cs index 62b3a519239..a65a7f94d5c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventArgs.cs @@ -7,12 +7,12 @@ namespace System.Windows.Forms { /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public class ToolStripSeparatorRenderEventArgs : ToolStripItemRenderEventArgs { /// - /// This class represents all the information to render the ToolStrip + /// This class represents all the information to render the ToolStrip /// public ToolStripSeparatorRenderEventArgs(Graphics g, ToolStripSeparator separator, bool vertical) : base(g, separator) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventHandler.cs index b0c465d7ea0..b62b876a1dc 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSeparatorRenderEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Called when the background of a ToolStrip item is being rendered + /// Called when the background of a ToolStrip item is being rendered /// public delegate void ToolStripSeparatorRenderEventHandler(object sender, ToolStripSeparatorRenderEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitButton.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitButton.cs index 4e14b9e032d..6cfb64a8457 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitButton.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitButton.cs @@ -38,7 +38,7 @@ public class ToolStripSplitButton : ToolStripDropDownItem private static int scaledDropDownButtonWidth = DEFAULT_DROPDOWN_WIDTH; /// - /// Summary of ToolStripSplitButton. + /// Summary of ToolStripSplitButton. /// public ToolStripSplitButton() { @@ -83,7 +83,7 @@ public ToolStripSplitButton(string text, Image image, params ToolStripItem[] dro } /// - /// Summary of ToolStripSplitButton. + /// Summary of ToolStripSplitButton. /// [Browsable(false)] public Rectangle ButtonBounds @@ -97,7 +97,7 @@ public Rectangle ButtonBounds } /// - /// Summary of ButtonPressed. + /// Summary of ButtonPressed. /// [Browsable(false)] public bool ButtonPressed @@ -110,7 +110,7 @@ public bool ButtonPressed } /// - /// Summary of ButtonPressed. + /// Summary of ButtonPressed. /// [Browsable(false)] public bool ButtonSelected @@ -122,7 +122,7 @@ public bool ButtonSelected } /// - /// Occurs when the button portion of a split button is clicked. + /// Occurs when the button portion of a split button is clicked. /// [ SRCategory(nameof(SR.CatAction)), @@ -134,7 +134,7 @@ public event EventHandler ButtonClick remove => Events.RemoveHandler(EventButtonClick, value); } /// - /// Occurs when the utton portion of a split button is double clicked. + /// Occurs when the utton portion of a split button is double clicked. /// [ SRCategory(nameof(SR.CatAction)), @@ -155,7 +155,7 @@ protected override bool DefaultAutoToolTip } /// - /// Summary of DefaultItem. + /// Summary of DefaultItem. /// [DefaultValue(null), Browsable(false)] public ToolStripItem DefaultItem @@ -175,7 +175,7 @@ public ToolStripItem DefaultItem } /// - /// Occurs when the default item has changed + /// Occurs when the default item has changed /// [ SRCategory(nameof(SR.CatAction)), @@ -188,7 +188,7 @@ public event EventHandler DefaultItemChanged } /// - /// specifies the default behavior of these items on ToolStripDropDowns when clicked. + /// specifies the default behavior of these items on ToolStripDropDowns when clicked. /// internal protected override bool DismissWhenClicked { @@ -205,7 +205,7 @@ internal override Rectangle DropDownButtonArea } /// - /// The bounds of the DropDown in ToolStrip coordinates. + /// The bounds of the DropDown in ToolStrip coordinates. /// [Browsable(false)] public Rectangle DropDownButtonBounds @@ -217,7 +217,7 @@ public Rectangle DropDownButtonBounds } /// - /// Summary of DropDownButtonBounds. + /// Summary of DropDownButtonBounds. /// [Browsable(false)] public bool DropDownButtonPressed @@ -229,7 +229,7 @@ public bool DropDownButtonPressed } } /// - /// Summary of DropDownButtonSelected. + /// Summary of DropDownButtonSelected. /// [Browsable(false)] public bool DropDownButtonSelected @@ -240,7 +240,7 @@ public bool DropDownButtonSelected } } /// - /// Summary of DropDownButtonWidth. + /// Summary of DropDownButtonWidth. /// [ SRCategory(nameof(SR.CatLayout)), @@ -270,7 +270,7 @@ public int DropDownButtonWidth } /// - /// This is here for serialization purposes. + /// This is here for serialization purposes. /// private int DefaultDropDownButtonWidth { @@ -291,7 +291,7 @@ private int DefaultDropDownButtonWidth } /// - /// Just used as a convenience to help manage layout + /// Just used as a convenience to help manage layout /// private ToolStripSplitButtonButton SplitButtonButton { @@ -313,7 +313,7 @@ private ToolStripSplitButtonButton SplitButtonButton } } /// - /// Summary of SplitButtonButtonLayout. + /// Summary of SplitButtonButtonLayout. /// internal ToolStripItemInternalLayout SplitButtonButtonLayout { @@ -332,7 +332,7 @@ internal ToolStripItemInternalLayout SplitButtonButtonLayout } /// - /// the width of the separator between the default and drop down button + /// the width of the separator between the default and drop down button /// [ SRDescription(nameof(SR.ToolStripSplitButtonSplitterWidthDescr)), @@ -360,8 +360,8 @@ internal int SplitterWidth } } /// - /// the boundaries of the separator between the default and drop down button, exposed for custom - /// painting purposes. + /// the boundaries of the separator between the default and drop down button, exposed for custom + /// painting purposes. /// [Browsable(false)] public Rectangle SplitterBounds @@ -372,7 +372,7 @@ public Rectangle SplitterBounds } } /// - /// Summary of CalculateLayout. + /// Summary of CalculateLayout. /// private void CalculateLayout() { @@ -437,7 +437,7 @@ public override Size GetPreferredSize(Size constrainingSize) } /// - /// Summary of InvalidateSplitButtonLayout. + /// Summary of InvalidateSplitButtonLayout. /// private void InvalidateSplitButtonLayout() { @@ -470,8 +470,8 @@ protected internal override bool ProcessMnemonic(char charCode) } /// - /// called when the button portion of a split button is clicked - /// if there is a default item, this will route the click to the default item + /// called when the button portion of a split button is clicked + /// if there is a default item, this will route the click to the default item /// protected virtual void OnButtonClick(EventArgs e) { @@ -482,8 +482,8 @@ protected virtual void OnButtonClick(EventArgs e) } /// - /// called when the button portion of a split button is double clicked - /// if there is a default item, this will route the double click to the default item + /// called when the button portion of a split button is double clicked + /// if there is a default item, this will route the double click to the default item /// public virtual void OnButtonDoubleClick(EventArgs e) { @@ -494,7 +494,7 @@ public virtual void OnButtonDoubleClick(EventArgs e) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected virtual void OnDefaultItemChanged(EventArgs e) { @@ -510,7 +510,7 @@ protected virtual void OnDefaultItemChanged(EventArgs e) } /// - /// Summary of OnMouseDown. + /// Summary of OnMouseDown. /// protected override void OnMouseDown(MouseEventArgs e) { @@ -535,7 +535,7 @@ protected override void OnMouseDown(MouseEventArgs e) } /// - /// Summary of OnMouseUp. + /// Summary of OnMouseUp. /// protected override void OnMouseUp(MouseEventArgs e) { @@ -602,7 +602,7 @@ protected override void OnMouseLeave(EventArgs e) } /// - /// Summary of OnRightToLeftChanged. + /// Summary of OnRightToLeftChanged. /// protected override void OnRightToLeftChanged(EventArgs e) { @@ -610,7 +610,7 @@ protected override void OnRightToLeftChanged(EventArgs e) InvalidateSplitButtonLayout(); } /// - /// Summary of OnPaint. + /// Summary of OnPaint. /// /// protected override void OnPaint(PaintEventArgs e) @@ -645,7 +645,7 @@ public void PerformButtonClick() } /// - /// Resets the RightToLeft to be the default. + /// Resets the RightToLeft to be the default. /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual void ResetDropDownButtonWidth() @@ -654,14 +654,14 @@ public virtual void ResetDropDownButtonWidth() } /// - /// Summary of SetDropDownBounds. + /// Summary of SetDropDownBounds. /// private void SetDropDownButtonBounds(Rectangle rect) { dropDownButtonBounds = rect; } /// - /// Determines if the property needs to be persisted. + /// Determines if the property needs to be persisted. /// [EditorBrowsable(EditorBrowsableState.Never)] internal virtual bool ShouldSerializeDropDownButtonWidth() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitStackLayout.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitStackLayout.cs index 58c42645e23..a6b52d7e6f5 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitStackLayout.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSplitStackLayout.cs @@ -25,7 +25,7 @@ internal ToolStripSplitStackLayout(ToolStrip owner) } /// - /// This is the index we use to send items to the overflow if we run out of room + /// This is the index we use to send items to the overflow if we run out of room /// protected int BackwardsWalkingIndex { get; set; } @@ -55,12 +55,12 @@ private Size OverflowButtonSize private bool OverflowRequired { get; set; } /// - /// The current ToolStrip we're operating over. + /// The current ToolStrip we're operating over. /// public ToolStrip ToolStrip { get; } /// - /// This method will mark whether items should be placed in the overflow or on the main ToolStrip. + /// This method will mark whether items should be placed in the overflow or on the main ToolStrip. /// private void CalculatePlacementsHorizontal() { @@ -123,7 +123,7 @@ private void CalculatePlacementsHorizontal() } /// - /// This method will mark whether items should be placed in the overflow or on the main ToolStrip. + /// This method will mark whether items should be placed in the overflow or on the main ToolStrip. /// private void CalculatePlacementsVertical() { @@ -641,8 +641,8 @@ private void ResetItemPlacements() } /// - /// This method is called when we are walking through the item collection and we have realized that we - /// need to free up "X" amount of space to be able to fit an item onto the ToolStrip. + /// This method is called when we are walking through the item collection and we have realized that we + /// need to free up "X" amount of space to be able to fit an item onto the ToolStrip. /// private int SendNextItemToOverflow(int spaceNeeded, bool horizontal) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripStatusLabel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripStatusLabel.cs index 00f92670c77..1201a919db6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripStatusLabel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripStatusLabel.cs @@ -12,7 +12,7 @@ namespace System.Windows.Forms { /// - /// A non selectable ToolStrip item + /// A non selectable ToolStrip item /// [ToolStripItemDesignerAvailability(ToolStripItemDesignerAvailability.StatusStrip)] public class ToolStripStatusLabel : ToolStripLabel, IAutomationLiveRegion @@ -26,7 +26,7 @@ public class ToolStripStatusLabel : ToolStripLabel, IAutomationLiveRegion private AutomationLiveSetting liveSetting; /// - /// A non selectable ToolStrip item + /// A non selectable ToolStrip item /// public ToolStripStatusLabel() { @@ -54,11 +54,11 @@ public ToolStripStatusLabel(string text, Image image, EventHandler onClick, stri } /// - /// Creates a new AccessibleObject for this ToolStripStatusLabel instance. - /// The AccessibleObject instance returned by this method supports UIA Live Region feature. + /// Creates a new AccessibleObject for this ToolStripStatusLabel instance. + /// The AccessibleObject instance returned by this method supports UIA Live Region feature. /// /// - /// AccessibleObject for this ToolStripStatusLabel instance. + /// AccessibleObject for this ToolStripStatusLabel instance. /// protected override AccessibleObject CreateAccessibilityInstance() { @@ -66,8 +66,8 @@ protected override AccessibleObject CreateAccessibilityInstance() } /// - /// Creates an instance of the object that defines how image and text - /// gets laid out in the ToolStripItem + /// Creates an instance of the object that defines how image and text + /// gets laid out in the ToolStripItem /// internal override ToolStripItemInternalLayout CreateInternalLayout() { @@ -150,7 +150,7 @@ public ToolStripStatusLabelBorderSides BorderSides } /// - /// Called by all constructors of ToolStripButton. + /// Called by all constructors of ToolStripButton. /// private void Initialize() { @@ -191,8 +191,8 @@ public bool Spring } /// - /// Indicates the "politeness" level that a client should use - /// to notify the user of changes to the live region. + /// Indicates the "politeness" level that a client should use + /// to notify the user of changes to the live region. /// [ SRCategory(nameof(SR.CatAccessibility)), @@ -239,7 +239,7 @@ public override Size GetPreferredSize(Size constrainingSize) } /// - /// Inheriting classes should override this method to handle this event. + /// Inheriting classes should override this method to handle this event. /// protected override void OnPaint(PaintEventArgs e) { @@ -269,7 +269,7 @@ public ToolStripStatusLabelAccessibleObject(ToolStripStatusLabel ownerItem) : ba } /// - /// Raises the LiveRegionChanged UIA event. + /// Raises the LiveRegionChanged UIA event. /// /// True if operation succeeds, False otherwise. public override bool RaiseLiveRegionChanged() diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSystemRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSystemRenderer.cs index 23e1509dbc9..add33df6960 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSystemRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripSystemRenderer.cs @@ -197,7 +197,7 @@ private static ToolBarState GetToolBarState(ToolStripItem item) } /// - /// Draw the ToolStrip background. ToolStrip users should override this if they want to draw differently. + /// Draw the ToolStrip background. ToolStrip users should override this if they want to draw differently. /// protected override void OnRenderToolStripBackground(ToolStripRenderEventArgs e) { @@ -251,7 +251,7 @@ protected override void OnRenderToolStripBackground(ToolStripRenderEventArgs e) } /// - /// Draw the border around the ToolStrip. This should be done as the last step. + /// Draw the border around the ToolStrip. This should be done as the last step. /// protected override void OnRenderToolStripBorder(ToolStripRenderEventArgs e) { @@ -295,7 +295,7 @@ protected override void OnRenderToolStripBorder(ToolStripRenderEventArgs e) } /// - /// Draw the grip. ToolStrip users should override this if they want to draw differently. + /// Draw the grip. ToolStrip users should override this if they want to draw differently. /// protected override void OnRenderGrip(ToolStripGripRenderEventArgs e) { @@ -350,20 +350,20 @@ protected override void OnRenderGrip(ToolStripGripRenderEventArgs e) } /// - /// Draw the items background + /// Draw the items background /// protected override void OnRenderItemBackground(ToolStripItemRenderEventArgs e) { } /// - /// Draw the items background + /// Draw the items background /// protected override void OnRenderImageMargin(ToolStripRenderEventArgs e) { } /// - /// Draw the button background + /// Draw the button background /// protected override void OnRenderButtonBackground(ToolStripItemRenderEventArgs e) { @@ -371,7 +371,7 @@ protected override void OnRenderButtonBackground(ToolStripItemRenderEventArgs e) } /// - /// Draw the button background + /// Draw the button background /// protected override void OnRenderDropDownButtonBackground(ToolStripItemRenderEventArgs e) { @@ -379,7 +379,7 @@ protected override void OnRenderDropDownButtonBackground(ToolStripItemRenderEven } /// - /// Draw the button background + /// Draw the button background /// protected override void OnRenderOverflowButtonBackground(ToolStripItemRenderEventArgs e) { @@ -403,14 +403,14 @@ protected override void OnRenderOverflowButtonBackground(ToolStripItemRenderEven } /// - /// Draw the button background + /// Draw the button background /// protected override void OnRenderLabelBackground(ToolStripItemRenderEventArgs e) { RenderLabelInternal(e); } /// - /// Draw the items background + /// Draw the items background /// protected override void OnRenderMenuItemBackground(ToolStripItemRenderEventArgs e) { @@ -493,8 +493,8 @@ protected override void OnRenderMenuItemBackground(ToolStripItemRenderEventArgs } /// - /// Draws a toolbar separator. ToolStrip users should override this function to change the - /// drawing of all separators. + /// Draws a toolbar separator. ToolStrip users should override this function to change the + /// drawing of all separators. /// protected override void OnRenderSeparator(ToolStripSeparatorRenderEventArgs e) { @@ -510,7 +510,7 @@ protected override void OnRenderToolStripStatusLabelBackground(ToolStripItemRend } /// - /// Draw the item's background. + /// Draw the item's background. /// protected override void OnRenderSplitButtonBackground(ToolStripItemRenderEventArgs e) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripTextBox.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripTextBox.cs index cec7d4a5b8c..3b5301f646f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripTextBox.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolStripTextBox.cs @@ -86,8 +86,8 @@ public override ImageLayout BackgroundImageLayout } /// - /// Deriving classes can override this to configure a default size for their control. - /// This is more efficient than setting the size in the control's constructor. + /// Deriving classes can override this to configure a default size for their control. + /// This is more efficient than setting the size in the control's constructor. /// protected internal override Padding DefaultMargin { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolTip.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolTip.cs index 67aa8096816..0c0f92dfa6b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolTip.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolTip.cs @@ -13,8 +13,8 @@ namespace System.Windows.Forms { /// - /// Provides a small pop-up window containing a line of text that describes the purpose of a - /// tool or control (usually represented as a graphical object) in a program. + /// Provides a small pop-up window containing a line of text that describes the purpose of a + /// tool or control (usually represented as a graphical object) in a program. /// [ProvideProperty(nameof(ToolTip), typeof(Control))] [DefaultEvent(nameof(Popup))] @@ -55,8 +55,8 @@ public class ToolTip : Component, IExtenderProvider private int _originalPopupDelay = 0; /// - /// Setting TTM_TRACKPOSITION will cause redundant POP and Draw Messages. - /// Hence we guard against this by having this private flag. + /// Setting TTM_TRACKPOSITION will cause redundant POP and Draw Messages. + /// Hence we guard against this by having this private flag. /// private bool _trackPosition = false; @@ -64,15 +64,15 @@ public class ToolTip : Component, IExtenderProvider private DrawToolTipEventHandler _onDraw; /// - /// Adding a tool twice breaks the ToolTip, so we need to track which - /// tools are created to prevent this. + /// Adding a tool twice breaks the ToolTip, so we need to track which + /// tools are created to prevent this. /// private readonly Hashtable _created = new Hashtable(); private bool _cancelled = false; /// - /// Initializes a new instance of the class, given the container. + /// Initializes a new instance of the class, given the container. /// public ToolTip(IContainer cont) : this() { @@ -85,7 +85,7 @@ public ToolTip(IContainer cont) : this() } /// - /// Initializes a new instance of the class in its default state. + /// Initializes a new instance of the class in its default state. /// public ToolTip() { @@ -96,7 +96,7 @@ public ToolTip() } /// - /// Gets or sets a value indicating whether the control is currently active. + /// Gets or sets a value indicating whether the control is currently active. /// [SRDescription(nameof(SR.ToolTipActiveDescr))] [DefaultValue(true)] @@ -124,7 +124,7 @@ internal void HideToolTip(IKeyboardToolTip currentTool) } /// - /// Gets or sets the time (in milliseconds) that passes before the appears. + /// Gets or sets the time (in milliseconds) that passes before the appears. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.ToolTipAutomaticDelayDescr))] @@ -150,7 +150,7 @@ internal string GetCaptionForTool(Control tool) } /// - /// Gets or sets the initial delay for the control. + /// Gets or sets the initial delay for the control. /// [RefreshProperties(RefreshProperties.All)] [SRDescription(nameof(SR.ToolTipAutoPopDelayDescr))] @@ -169,7 +169,7 @@ public int AutoPopDelay } /// - /// Gets or sets the BackColor for the control. + /// Gets or sets the BackColor for the control. /// [SRDescription(nameof(SR.ToolTipBackColorDescr))] [DefaultValue(typeof(Color), "Info")] @@ -187,7 +187,7 @@ public Color BackColor } /// - /// The CreateParams to create the window. + /// The CreateParams to create the window. /// protected virtual CreateParams CreateParams { @@ -227,7 +227,7 @@ protected virtual CreateParams CreateParams } /// - /// Gets or sets the ForeColor for the control. + /// Gets or sets the ForeColor for the control. /// [SRDescription(nameof(SR.ToolTipForeColorDescr))] [DefaultValue(typeof(Color), "InfoText")] @@ -263,7 +263,7 @@ internal IntPtr Handle } /// - /// Gets or sets the IsBalloon for the control. + /// Gets or sets the IsBalloon for the control. /// [SRDescription(nameof(SR.ToolTipIsBalloonDescr))] [DefaultValue(false)] @@ -310,7 +310,7 @@ private bool IsWindowActive(IWin32Window window) } /// - /// Gets or sets the initial delay for the control. + /// Gets or sets the initial delay for the control. /// [RefreshProperties(RefreshProperties.All)] [Description(nameof(SR.ToolTipInitialDelayDescr))] @@ -329,7 +329,7 @@ public int InitialDelay } /// - /// Indicates whether the ToolTip will be drawn by the system or the user. + /// Indicates whether the ToolTip will be drawn by the system or the user. /// [SRCategory(nameof(SR.CatBehavior))] [DefaultValue(false)] @@ -337,8 +337,8 @@ public int InitialDelay public bool OwnerDraw { get; set; } /// - /// Gets or sets the length of time (in milliseconds) that it takes subsequent ToolTip - /// instances to appear as the mouse pointer moves from one ToolTip region to another. + /// Gets or sets the length of time (in milliseconds) that it takes subsequent ToolTip + /// instances to appear as the mouse pointer moves from one ToolTip region to another. /// [RefreshProperties(RefreshProperties.All)] [Description(nameof(SR.ToolTipReshowDelayDescr))] @@ -357,8 +357,8 @@ public int ReshowDelay } /// - /// Gets or sets a value indicating whether the appears even when its - /// parent control is not active. + /// Gets or sets a value indicating whether the appears even when its + /// parent control is not active. /// [DefaultValue(false)] [Description(nameof(SR.ToolTipShowAlwaysDescr))] @@ -379,7 +379,7 @@ public bool ShowAlways } /// - /// When set to true, any ampersands in the Text property are not displayed. + /// When set to true, any ampersands in the Text property are not displayed. /// [SRDescription(nameof(SR.ToolTipStripAmpersandsDescr))] [Browsable(true)] @@ -409,7 +409,7 @@ public bool StripAmpersands public object Tag { get; set; } /// - /// Gets or sets an Icon on the ToolTip. + /// Gets or sets an Icon on the ToolTip. /// [DefaultValue(ToolTipIcon.None)] [Description(nameof(SR.ToolTipToolTipIconDescr))] @@ -441,7 +441,7 @@ public ToolTipIcon ToolTipIcon } /// - /// Gets or sets the title of the ToolTip. + /// Gets or sets the title of the ToolTip. /// [DefaultValue("")] [Description(nameof(SR.ToolTipTitleDescr))] @@ -534,7 +534,7 @@ private Control TopLevelControl } /// - /// When set to true, animations are used when tooltip is shown or hidden. + /// When set to true, animations are used when tooltip is shown or hidden. /// [SRDescription(nameof(SR.ToolTipUseAnimationDescr))] [Browsable(true)] @@ -556,7 +556,7 @@ public bool UseAnimation } /// - /// When set to true, a fade effect is used when tooltips are shown or hidden. + /// When set to true, a fade effect is used when tooltips are shown or hidden. /// [SRDescription(nameof(SR.ToolTipUseFadingDescr))] [Browsable(true)] @@ -578,7 +578,7 @@ public bool UseFading } /// - /// Fires in OwnerDraw mode when the tooltip needs to be drawn. + /// Fires in OwnerDraw mode when the tooltip needs to be drawn. /// [SRCategory(nameof(SR.CatBehavior))] [SRDescription(nameof(SR.ToolTipDrawEventDescr))] @@ -589,7 +589,7 @@ public event DrawToolTipEventHandler Draw } /// - /// Fires when the tooltip is just about to be shown. + /// Fires when the tooltip is just about to be shown. /// [SRCategory(nameof(SR.CatBehavior))] [SRDescription(nameof(SR.ToolTipPopupEventDescr))] @@ -600,7 +600,7 @@ public event PopupEventHandler Popup } /// - /// Adjusts the other delay values based on the Automatic value. + /// Adjusts the other delay values based on the Automatic value. /// private void AdjustBaseFromAuto() { @@ -683,12 +683,12 @@ private void HandleDestroyed(object sender, EventArgs eventargs) } /// - /// Fires the Draw event. + /// Fires the Draw event. /// private void OnDraw(DrawToolTipEventArgs e) => _onDraw?.Invoke(this, e); /// - /// Fires the Popup event. + /// Fires the Popup event. /// private void OnPopup(PopupEventArgs e) => _onPopup?.Invoke(this, e); @@ -705,7 +705,7 @@ private void TopLevelDestroyed(object sender, EventArgs eventargs) } /// - /// Returns true if the tooltip can offer an extender property to the specified target component. + /// Returns true if the tooltip can offer an extender property to the specified target component. /// public bool CanExtend(object target) => target is Control; @@ -720,7 +720,7 @@ private void ClearTopLevelControlEvents() } /// - /// Creates the handle for the control. + /// Creates the handle for the control. /// private void CreateHandle() { @@ -900,8 +900,8 @@ private void MouseMove(object sender, MouseEventArgs me) } /// - /// Destroys the handle for this control. - /// Required by Label to destroy the handle for the toolTip added for AutoEllipses. + /// Destroys the handle for this control. + /// Required by Label to destroy the handle for the toolTip added for AutoEllipses. /// internal void DestroyHandle() { @@ -934,7 +934,7 @@ private void DestroyRegion(Control ctl) } /// - /// Disposes of the component. + /// Disposes of the component. /// protected override void Dispose(bool disposing) { @@ -969,7 +969,7 @@ protected override void Dispose(bool disposing) } /// - /// Returns the delayTime based on the NativeMethods.TTDT_* values. + /// Returns the delayTime based on the NativeMethods.TTDT_* values. /// internal int GetDelayTime(int type) { @@ -984,9 +984,9 @@ internal int GetDelayTime(int type) internal bool GetHandleCreated() => _window != null && _window.Handle != IntPtr.Zero; /// - /// Returns a new instance of the TOOLINFO_T structure with the minimum required data to - /// uniquely identify a region. This is used primarily for delete operations. - /// NOTE: This cannot force the creation of a handle. + /// Returns a new instance of the TOOLINFO_T structure with the minimum required data to + /// uniquely identify a region. This is used primarily for delete operations. + /// NOTE: This cannot force the creation of a handle. /// private NativeMethods.TOOLINFO_TOOLTIP GetMinTOOLINFO(Control ctl) { @@ -1011,10 +1011,10 @@ private NativeMethods.TOOLINFO_TOOLTIP GetMinToolInfoForHandle(IntPtr handle) } /// - /// Returns a detailed TOOLINFO_TOOLTIP structure that represents the specified region. - /// NOTE: This may force the creation of a handle. - /// If the out parameter allocatedString has been set to true, It is the responsibility of - /// the caller to free the string buffer referenced by lpszText (using Marshal.FreeHGlobal). + /// Returns a detailed TOOLINFO_TOOLTIP structure that represents the specified region. + /// NOTE: This may force the creation of a handle. + /// If the out parameter allocatedString has been set to true, It is the responsibility of + /// the caller to free the string buffer referenced by lpszText (using Marshal.FreeHGlobal). /// private NativeMethods.TOOLINFO_TOOLTIP GetTOOLINFO(Control ctl, string caption, out bool allocatedString) { @@ -1084,7 +1084,7 @@ private NativeMethods.TOOLINFO_TOOLTIP GetWinTOOLINFO(IntPtr hWnd) } /// - /// Retrieves the text associated with the specified control. + /// Retrieves the text associated with the specified control. /// [DefaultValue(""), Localizable(true)] @@ -1102,8 +1102,8 @@ public string GetToolTip(Control control) } /// - /// Returns the HWND of the window that is at the specified point. This handles special - /// cases where one Control owns multiple HWNDs (i.e. ComboBox). + /// Returns the HWND of the window that is at the specified point. This handles special + /// cases where one Control owns multiple HWNDs (i.e. ComboBox). /// private IntPtr GetWindowFromPoint(Point screenCoords, ref bool success) { @@ -1215,7 +1215,7 @@ private void RecreateHandle() } /// - /// Removes all of the tooltips currently associated with the control. + /// Removes all of the tooltips currently associated with the control. /// public void RemoveAll() { @@ -1244,7 +1244,7 @@ public void RemoveAll() } /// - /// Sets the delayTime based on the NativeMethods.TTDT_* values. + /// Sets the delayTime based on the NativeMethods.TTDT_* values. /// private void SetDelayTime(int type, int time) { @@ -1271,7 +1271,7 @@ private void SetDelayTime(int type, int time) } /// - /// Associates text with the specified control. + /// Associates text with the specified control. /// public void SetToolTip(Control control, string caption) { @@ -1280,7 +1280,7 @@ public void SetToolTip(Control control, string caption) } /// - /// Associates text with the specified information + /// Associates text with the specified information /// private void SetToolTipInternal(Control control, TipInfo info) { @@ -1350,27 +1350,27 @@ private void SetToolTipInternal(Control control, TipInfo info) } /// - /// Returns true if the AutomaticDelay property should be persisted. + /// Returns true if the AutomaticDelay property should be persisted. /// private bool ShouldSerializeAutomaticDelay() => _auto && AutomaticDelay != DefaultDelay; /// - /// Returns true if the AutoPopDelay property should be persisted. + /// Returns true if the AutoPopDelay property should be persisted. /// private bool ShouldSerializeAutoPopDelay() => !_auto; /// - /// Returns true if the InitialDelay property should be persisted. + /// Returns true if the InitialDelay property should be persisted. /// private bool ShouldSerializeInitialDelay() => !_auto; /// - /// Returns true if the ReshowDelay property should be persisted. + /// Returns true if the ReshowDelay property should be persisted. /// private bool ShouldSerializeReshowDelay() => !_auto; /// - /// Shows a tooltip for specified text, window, and hotspot + /// Shows a tooltip for specified text, window, and hotspot /// private void ShowTooltip(string text, IWin32Window window, int duration) { @@ -1445,7 +1445,7 @@ private void ShowTooltip(string text, IWin32Window window, int duration) } /// - /// Associates with the specified control and displays it. + /// Associates with the specified control and displays it. /// public void Show(string text, IWin32Window window) { @@ -1457,8 +1457,8 @@ public void Show(string text, IWin32Window window) } /// - /// Associates with the specified control and displays it for the - /// specified duration. + /// Associates with the specified control and displays it for the + /// specified duration. /// public void Show(string text, IWin32Window window, int duration) { @@ -1478,7 +1478,7 @@ public void Show(string text, IWin32Window window, int duration) } /// - /// Associates with the specified control and displays it. + /// Associates with the specified control and displays it. /// public void Show(string text, IWin32Window window, Point point) { @@ -1501,7 +1501,7 @@ public void Show(string text, IWin32Window window, Point point) } /// - /// Associates with the specified control and displays it. + /// Associates with the specified control and displays it. /// public void Show(string text, IWin32Window window, Point point, int duration) { @@ -1528,7 +1528,7 @@ public void Show(string text, IWin32Window window, Point point, int duration) } /// - /// Associates with the specified control and displays it. + /// Associates with the specified control and displays it. /// public void Show(string text, IWin32Window window, int x, int y) { @@ -1549,7 +1549,7 @@ public void Show(string text, IWin32Window window, int x, int y) } /// - /// Associates with the specified control and displays it. + /// Associates with the specified control and displays it. /// public void Show(string text, IWin32Window window, int x, int y, int duration) { @@ -1776,7 +1776,7 @@ private bool IsCompetingLocationBetter(long originalLocationClippedArea, } /// - /// Private Function to encapsulate TTM_TRACKPOSITION so that this doesnt fire an extra POP event + /// Private Function to encapsulate TTM_TRACKPOSITION so that this doesnt fire an extra POP event /// private void SetTrackPosition(int pointX, int pointY) { @@ -1792,7 +1792,7 @@ private void SetTrackPosition(int pointX, int pointY) } /// - /// Hides with the specified control. + /// Hides with the specified control. /// public void Hide(IWin32Window win) { @@ -1831,7 +1831,7 @@ public void Hide(IWin32Window win) } // Find the Form for associated Control and hook up to the Deactivated event to - /// hide the shown tooltip + /// hide the shown tooltip Form baseFrom = tool.FindForm(); if (baseFrom != null) { @@ -1968,7 +1968,7 @@ private void SetTool(IWin32Window win, string text, TipInfo.Type type, Point pos } /// - /// Starts the timer hiding Positioned ToolTips + /// Starts the timer hiding Positioned ToolTips /// private void StartTimer(IWin32Window owner, int interval) { @@ -1984,7 +1984,7 @@ private void StartTimer(IWin32Window owner, int interval) } /// - /// Stops the timer for hiding Positioned ToolTips + /// Stops the timer for hiding Positioned ToolTips /// protected void StopTimer() { @@ -2001,7 +2001,7 @@ protected void StopTimer() } /// - /// Generates updown events when the timer calls this function. + /// Generates updown events when the timer calls this function. /// private void TimerHandler(object source, EventArgs args) { @@ -2009,12 +2009,12 @@ private void TimerHandler(object source, EventArgs args) } /// - /// Finalizes garbage collection. + /// Finalizes garbage collection. /// ~ToolTip() => DestroyHandle(); /// - /// Returns a string representation for this control. + /// Returns a string representation for this control. /// public override string ToString() { @@ -2046,7 +2046,7 @@ private void Reposition(Point tipPosition, Size tipSize) } /// - /// Handles the WM_MOVE message. + /// Handles the WM_MOVE message. /// private void WmMove() { @@ -2095,7 +2095,7 @@ private void WmMove() } /// - /// Handles the WM_MOUSEACTIVATE message. + /// Handles the WM_MOUSEACTIVATE message. /// private void WmMouseActivate(ref Message msg) { @@ -2134,7 +2134,7 @@ private void WmMouseActivate(ref Message msg) } /// - /// Handles the WM_WINDOWFROMPOINT message. + /// Handles the WM_WINDOWFROMPOINT message. /// private void WmWindowFromPoint(ref Message msg) { @@ -2144,7 +2144,7 @@ private void WmWindowFromPoint(ref Message msg) } /// - /// Handles the TTN_SHOW message. + /// Handles the TTN_SHOW message. /// private void WmShow() { @@ -2235,9 +2235,9 @@ private void WmShow() } /// - /// Handles the WM_WINDOWPOSCHANGED message. - /// We need to Hide the window since the native tooltip actually calls SetWindowPos in its TTN_SHOW even if we cancel showing the - /// tooltip. Hence we need to listen to the WindowPosChanged message can hide the window ourselves. + /// Handles the WM_WINDOWPOSCHANGED message. + /// We need to Hide the window since the native tooltip actually calls SetWindowPos in its TTN_SHOW even if we cancel showing the + /// tooltip. Hence we need to listen to the WindowPosChanged message can hide the window ourselves. /// private bool WmWindowPosChanged() { @@ -2251,7 +2251,7 @@ private bool WmWindowPosChanged() } /// - /// Handles the WM_WINDOWPOSCHANGING message. + /// Handles the WM_WINDOWPOSCHANGING message. /// private unsafe void WmWindowPosChanging(ref Message m) { @@ -2359,7 +2359,7 @@ private unsafe void WmWindowPosChanging(ref Message m) } /// - /// Called just before the tooltip is hidden + /// Called just before the tooltip is hidden /// private void WmPop() { @@ -2424,7 +2424,7 @@ private void WmPop() } /// - /// WNDPROC + /// WNDPROC /// private void WndProc(ref Message msg) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolTipIcon.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolTipIcon.cs index 7b9e705a7e6..7940bff8105 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolTipIcon.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolTipIcon.cs @@ -7,22 +7,22 @@ namespace System.Windows.Forms public enum ToolTipIcon { /// - /// No Icon. + /// No Icon. /// None = 0, /// - /// A Information Icon. + /// A Information Icon. /// Info = 1, /// - /// A Warning Icon. + /// A Warning Icon. /// Warning = 2, /// - /// A Error Icon. + /// A Error Icon. /// Error = 3 } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ToolstripProfessionalRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ToolstripProfessionalRenderer.cs index b907a81ece5..6c24f3c43ae 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ToolstripProfessionalRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ToolstripProfessionalRenderer.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Summary description for ProfessionalToolStripRenderer. + /// Summary description for ProfessionalToolStripRenderer. /// public class ToolStripProfessionalRenderer : ToolStripRenderer { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TrackBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TrackBar.cs index 3b3bc97ccc8..cef11d09156 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TrackBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TrackBar.cs @@ -924,7 +924,7 @@ protected virtual void OnScroll(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// [EditorBrowsable(EditorBrowsableState.Advanced)] protected override void OnMouseWheel(MouseEventArgs e) diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNode.cs index e36e8e3914a..ace07057c9f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNode.cs @@ -2122,7 +2122,7 @@ private bool ShouldSerializeForeColor() /// /// Saves this TreeNode object to the given data stream. /// - /// Review: Changing this would break VB users. so suppresing this message. + /// Review: Changing this would break VB users. so suppresing this message. /// protected virtual void Serialize(SerializationInfo si, StreamingContext context) { @@ -2271,7 +2271,7 @@ internal void UpdateImage() } /// - /// ISerializable private implementation + /// ISerializable private implementation /// void ISerializable.GetObjectData(SerializationInfo si, StreamingContext context) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventArgs.cs index 07025bbaf5a..ae01ed069df 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventArgs.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Provides data for the - /// or event. + /// Provides data for the + /// or event. /// public class TreeNodeMouseClickEventArgs : MouseEventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventHandler.cs index 1ad4135fee4..4253c1937f8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeClickEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , , - /// or event of a + /// or event of a /// public delegate void TreeNodeMouseClickEventHandler(object sender, TreeNodeMouseClickEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeCollection.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeCollection.cs index aaca38ace87..da41bd60ab3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeCollection.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeCollection.cs @@ -16,9 +16,9 @@ public class TreeNodeCollection : IList { private readonly TreeNode owner; - /// A caching mechanism for key accessor - /// We use an index here rather than control so that we don't have lifetime - /// issues by holding on to extra references. + /// A caching mechanism for key accessor + /// We use an index here rather than control so that we don't have lifetime + /// issues by holding on to extra references. private int lastAccessedIndex = -1; //this index is used to optimize performance of AddRange diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventArgs.cs index 6a432938c8e..c786c67a4a1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// [ComVisible(true)] public class TreeNodeMouseHoverEventArgs : EventArgs diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventHandler.cs index 4dc3531a651..47aea180b81 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeMouseHoverEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the - /// event of a . + /// Represents the method that will handle the + /// event of a . /// public delegate void TreeNodeMouseHoverEventHandler(object sender, TreeNodeMouseHoverEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeState.cs index 5691bfa54b6..354c1c74185 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeNodeState.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Gives state information about a TreeView node. Used with owner draw. + /// Gives state information about a TreeView node. Used with owner draw. /// [Flags] public enum TreeNodeStates diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeView.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeView.cs index b8d2c9e31f5..8bfda1ec1c1 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeView.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeView.cs @@ -994,7 +994,7 @@ public TreeNodeCollection Nodes } /// - /// Indicates the drawing mode for the tree view. + /// Indicates the drawing mode for the tree view. /// [ SRCategory(nameof(SR.CatBehavior)), @@ -1988,7 +1988,7 @@ internal TreeNode NodeFromHandle(IntPtr handle) } /// - /// Fires the DrawNode event. + /// Fires the DrawNode event. /// protected virtual void OnDrawNode(DrawTreeNodeEventArgs e) { @@ -2041,7 +2041,7 @@ protected override void OnHandleCreated(EventArgs e) SendMessage(NativeMethods.TVM_SETTEXTCOLOR, 0, ColorTranslator.ToWin32(c)); } - /// put the linecolor into the native control only if Set ... + /// put the linecolor into the native control only if Set ... if (lineColor != Color.Empty) { SendMessage(NativeMethods.TVM_SETLINECOLOR, 0, ColorTranslator.ToWin32(lineColor)); @@ -2186,9 +2186,9 @@ protected override void OnMouseLeave(EventArgs e) /// protected override void OnMouseHover(EventArgs e) { - /// Hover events need to be caught for each node - /// within the TreeView so the appropriate - /// NodeHovered event can be raised. + /// Hover events need to be caught for each node + /// within the TreeView so the appropriate + /// NodeHovered event can be raised. NativeMethods.TV_HITTESTINFO tvhip = new NativeMethods.TV_HITTESTINFO(); Point pos = Cursor.Position; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewAction.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewAction.cs index 2ec8dabdc91..4d556fbf4d6 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewAction.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewAction.cs @@ -5,32 +5,32 @@ namespace System.Windows.Forms { /// - /// This enum is used to specify the action that caused a TreeViewEventArgs. + /// This enum is used to specify the action that caused a TreeViewEventArgs. /// public enum TreeViewAction { /// - /// The action is unknown. + /// The action is unknown. /// Unknown = 0, /// - /// The event was caused by a keystroke. + /// The event was caused by a keystroke. /// ByKeyboard = 1, /// - /// The event was caused by a mouse click. + /// The event was caused by a mouse click. /// ByMouse = 2, /// - /// The tree node is collapsing. + /// The tree node is collapsing. /// Collapse = 3, /// - /// The tree node is expanding. + /// The tree node is expanding. /// Expand = 4, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewCancelEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewCancelEventHandler.cs index 8c05b408e35..bf88a1d1629 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewCancelEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewCancelEventHandler.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , + /// Represents the method that will handle the , /// , , - /// or event of a + /// or event of a /// public delegate void TreeViewCancelEventHandler(object sender, TreeViewCancelEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewDrawMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewDrawMode.cs index d28315d04f4..473e5a30504 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewDrawMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewDrawMode.cs @@ -5,22 +5,22 @@ namespace System.Windows.Forms { /// - /// Specifies responsibility for drawing TreeView nodes. + /// Specifies responsibility for drawing TreeView nodes. /// public enum TreeViewDrawMode { /// - /// The operating system paints the nodes of the TreeView. + /// The operating system paints the nodes of the TreeView. /// Normal = 0, /// - /// The user needs to paint the text only. + /// The user needs to paint the text only. /// OwnerDrawText = 1, /// - /// The user paints the entire row corresponding to a node, including lines and boxes. + /// The user paints the entire row corresponding to a node, including lines and boxes. /// OwnerDrawAll = 2, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewEventHandler.cs index 5ed70522f0f..7001f66783b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewEventHandler.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Represents the method that will handle the , , , or - /// event of a + /// Represents the method that will handle the , , , or + /// event of a /// public delegate void TreeViewEventHandler(object sender, TreeViewEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewHitTestLocation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewHitTestLocation.cs index 09ef5abc283..49c1636bc77 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewHitTestLocation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewHitTestLocation.cs @@ -7,59 +7,59 @@ namespace System.Windows.Forms { /// - /// Specifies the return value for HITTEST on treeview. + /// Specifies the return value for HITTEST on treeview. /// [Flags] [ComVisible(true)] public enum TreeViewHitTestLocations { /// - /// No Information. + /// No Information. /// None = NativeMethods.TVHT_NOWHERE, /// - /// On Image. + /// On Image. /// Image = NativeMethods.TVHT_ONITEMICON, /// - /// On Label. + /// On Label. /// Label = NativeMethods.TVHT_ONITEMLABEL, /// - /// Indent. + /// Indent. /// Indent = NativeMethods.TVHT_ONITEMINDENT, /// - /// AboveClientArea. + /// AboveClientArea. /// AboveClientArea = NativeMethods.TVHT_ABOVE, /// - /// BelowClientArea. + /// BelowClientArea. /// BelowClientArea = NativeMethods.TVHT_BELOW, /// - /// LeftOfClientArea. + /// LeftOfClientArea. /// LeftOfClientArea = NativeMethods.TVHT_TOLEFT, /// - /// RightOfClientArea. + /// RightOfClientArea. /// RightOfClientArea = NativeMethods.TVHT_TORIGHT, /// - /// RightOfNode. + /// RightOfNode. /// RightOfLabel = NativeMethods.TVHT_ONITEMRIGHT, /// - /// StateImage. + /// StateImage. /// StateImage = NativeMethods.TVHT_ONITEMSTATEICON, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewImageKeyConverter.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewImageKeyConverter.cs index 647488913e1..7f1192efde7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewImageKeyConverter.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TreeViewImageKeyConverter.cs @@ -8,17 +8,17 @@ namespace System.Windows.Forms using System.Globalization; /// - /// ImageIndexConverter is a class that can be used to convert - /// image index values one data type to another. + /// ImageIndexConverter is a class that can be used to convert + /// image index values one data type to another. /// public class TreeViewImageKeyConverter : ImageKeyConverter { /// - /// Converts the given object to another type. The most common types to convert - /// are to and from a string object. The default implementation will make a call - /// to ToString on the object if the object is valid and if the destination - /// type is string. If this cannot convert to the desitnation type, this will - /// throw a NotSupportedException. + /// Converts the given object to another type. The most common types to convert + /// are to and from a string object. The default implementation will make a call + /// to ToString on the object if the object is valid and if the destination + /// type is string. If this cannot convert to the desitnation type, this will + /// throw a NotSupportedException. /// public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventArgs.cs index 1af771a2bb6..dc610f595ce 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the TypeValidationEventHandler event. + /// Provides data for the TypeValidationEventHandler event. /// public class TypeValidationEventArgs : EventArgs { @@ -18,28 +18,28 @@ public TypeValidationEventArgs(Type validatingType, bool isValidInput, object re } /// - /// The position where the test failed the mask constraint. + /// The position where the test failed the mask constraint. /// public Type ValidatingType { get; } /// - /// The exception thrown by the validating object while performing the data validation. + /// The exception thrown by the validating object while performing the data validation. /// public bool IsValidInput { get; } /// - /// A message about the validation operation. Intended to be populated with - /// an exception information if any thrown. + /// A message about the validation operation. Intended to be populated with + /// an exception information if any thrown. /// public string Message { get; } /// - /// The value returned from the Parse method. + /// The value returned from the Parse method. /// public object ReturnValue { get; } /// - /// Specifies whether focus should be allowed to be shifted from the control. + /// Specifies whether focus should be allowed to be shifted from the control. /// public bool Cancel { get; set; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventHandler.cs index 7a54c5f968d..d2e28ba9fc8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/TypeValidationEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Describes a delegate for an event that has a TypeValidationEventArgs as a parameter. + /// Describes a delegate for an event that has a TypeValidationEventArgs as a parameter. /// public delegate void TypeValidationEventHandler(object sender, TypeValidationEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UICues.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UICues.cs index 9ce9055e238..ed5ca32f353 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UICues.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UICues.cs @@ -5,30 +5,30 @@ namespace System.Windows.Forms { /// - /// Specifies UI state. + /// Specifies UI state. /// [Flags] public enum UICues { /// - /// Focus rectangles are shown after the change. + /// Focus rectangles are shown after the change. /// ShowFocus = 0x01, /// - /// Keyboard cues are underlined after the change. + /// Keyboard cues are underlined after the change. /// ShowKeyboard = 0x02, Shown = ShowFocus | ShowKeyboard, /// - /// The state of the focus cues has changed. + /// The state of the focus cues has changed. /// ChangeFocus = 0x04, /// - /// The state of the keyboard cues has changed. + /// The state of the keyboard cues has changed. /// ChangeKeyboard = 0x08, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventArgs.cs index ac090061b6e..11e0dae2e8d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class UICuesEventArgs : EventArgs { @@ -17,22 +17,22 @@ public UICuesEventArgs(UICues uicues) } /// - /// Focus rectangles are shown after the change. + /// Focus rectangles are shown after the change. /// public bool ShowFocus => (_uicues & UICues.ShowFocus) != 0; /// - /// Keyboard cues are underlined after the change. + /// Keyboard cues are underlined after the change. /// public bool ShowKeyboard => (_uicues & UICues.ShowKeyboard) != 0; /// - /// The state of the focus cues has changed. + /// The state of the focus cues has changed. /// public bool ChangeFocus => (_uicues & UICues.ChangeFocus) != 0; /// - /// The state of the keyboard cues has changed. + /// The state of the keyboard cues has changed. /// public bool ChangeKeyboard => (_uicues & UICues.ChangeKeyboard) != 0; diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventHandler.cs index 5e2710ada75..a85b0e72c89 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UICuesEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Represents a method that will handle the event of a . + /// Represents a method that will handle the event of a . /// public delegate void UICuesEventHandler(object sender, UICuesEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UnhandledExceptionMode.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UnhandledExceptionMode.cs index f40495fc5a8..a454c0a8ffe 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UnhandledExceptionMode.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UnhandledExceptionMode.cs @@ -5,9 +5,9 @@ namespace System.Windows.Forms { /// - /// Determines the exception mode of NativeWindow's WndProc method. Pass - /// a value of this enum into SetUnhandledExceptionMode to control how - /// new NativeWindow objects handle exceptions. + /// Determines the exception mode of NativeWindow's WndProc method. Pass + /// a value of this enum into SetUnhandledExceptionMode to control how + /// new NativeWindow objects handle exceptions. /// public enum UnhandledExceptionMode { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownBase.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownBase.cs index 90334d5f8b6..1701c18aca7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownBase.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownBase.cs @@ -35,7 +35,6 @@ public abstract class UpDownBase : ContainerControl // Member variables // //////////////////////////////////////////////////////////////////////// - // Child controls internal UpDownEdit upDownEdit; // See nested class at end of this file internal UpDownButtons upDownButtons; // See nested class at end of this file @@ -105,7 +104,6 @@ public UpDownBase() // Properties // //////////////////////////////////////////////////////////////////////// - // AutoScroll is not relevant to an UpDownBase /// [Browsable(false), EditorBrowsable(EditorBrowsableState.Never), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] @@ -663,7 +661,6 @@ protected bool UserEdit // Methods // //////////////////////////////////////////////////////////////////////// - /// /// When overridden in a derived class, handles the pressing of the down button /// on the up-down control. @@ -678,7 +675,7 @@ internal override Rectangle ApplyBoundsConstraints(int suggestedX, int suggested } /// - /// Gets an accessible name. + /// Gets an accessible name. /// /// The base name. /// The accessible name. @@ -707,8 +704,8 @@ protected override void RescaleConstantsForDpi(int deviceDpiOld, int deviceDpiNe } /// - /// When overridden in a derived class, raises the Changed event. - /// event. + /// When overridden in a derived class, raises the Changed event. + /// event. /// protected virtual void OnChanged(object source, EventArgs e) { @@ -804,8 +801,8 @@ protected override void OnPaint(PaintEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnTextBoxKeyDown(object source, KeyEventArgs e) { @@ -837,8 +834,8 @@ protected virtual void OnTextBoxKeyDown(object source, KeyEventArgs e) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected virtual void OnTextBoxKeyPress(object source, KeyPressEventArgs e) { @@ -847,7 +844,7 @@ protected virtual void OnTextBoxKeyPress(object source, KeyPressEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnTextBoxLostFocus(object source, EventArgs e) { @@ -858,7 +855,7 @@ protected virtual void OnTextBoxLostFocus(object source, EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// protected virtual void OnTextBoxResize(object source, EventArgs e) { @@ -867,8 +864,8 @@ protected virtual void OnTextBoxResize(object source, EventArgs e) } /// - /// Raises the TextBoxTextChanged event. - /// event. + /// Raises the TextBoxTextChanged event. + /// event. /// protected virtual void OnTextBoxTextChanged(object source, EventArgs e) { @@ -938,7 +935,7 @@ protected override void OnMouseUp(MouseEventArgs mevent) } /// - /// Raises the event. + /// Raises the event. /// protected override void OnMouseWheel(MouseEventArgs e) { @@ -1213,7 +1210,6 @@ internal class UpDownEdit : TextBox // Member variables // ///////////////////////////////////////////////////////////////////// - // Parent control private readonly UpDownBase parent; private bool doubleClickFired = false; @@ -1221,7 +1217,6 @@ internal class UpDownEdit : TextBox // Constructors // ///////////////////////////////////////////////////////////////////// - internal UpDownEdit(UpDownBase parent) : base() { @@ -1313,8 +1308,8 @@ internal override void WmContextMenu(ref Message m) } /// - /// Raises the - /// event. + /// Raises the + /// event. /// protected override void OnKeyUp(KeyEventArgs e) { @@ -1390,7 +1385,6 @@ internal class UpDownButtons : Control // Member variables // ///////////////////////////////////////////////////////////////////// - // Parent control private readonly UpDownBase parent; @@ -1412,7 +1406,6 @@ internal class UpDownButtons : Control // Constructors // ///////////////////////////////////////////////////////////////////// - internal UpDownButtons(UpDownBase parent) : base() @@ -1430,7 +1423,6 @@ internal UpDownButtons(UpDownBase parent) // Methods // ///////////////////////////////////////////////////////////////////// - /// /// /// Adds a handler for the updown button event. diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventArgs.cs index 61c24f511c2..66d7914eed3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventArgs.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the UpDownEvent + /// Provides data for the UpDownEvent /// public class UpDownEventArgs : EventArgs { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventHandler.cs index 99341c2916b..0db8151a7d7 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/UpDownEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// A delegate for an updown event handler. + /// A delegate for an updown event handler. /// public delegate void UpDownEventHandler(object source, UpDownEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/VScrollBar.cs b/src/System.Windows.Forms/src/System/Windows/Forms/VScrollBar.cs index efb56e36f3a..e3042ea1c14 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/VScrollBar.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/VScrollBar.cs @@ -9,7 +9,7 @@ namespace System.Windows.Forms { /// - /// Represents a standard Windows vertical scroll bar. + /// Represents a standard Windows vertical scroll bar. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/VScrollProperties.cs b/src/System.Windows.Forms/src/System/Windows/Forms/VScrollProperties.cs index e9cc808f145..3917c52a264 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/VScrollProperties.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/VScrollProperties.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Basic Properties for VScroll. + /// Basic Properties for VScroll. /// public class VScrollProperties : ScrollProperties { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/ValidationConstraints.cs b/src/System.Windows.Forms/src/System/Windows/Forms/ValidationConstraints.cs index f07f3c98cc4..7fabfc523ef 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/ValidationConstraints.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/ValidationConstraints.cs @@ -5,46 +5,46 @@ namespace System.Windows.Forms { /// - /// Determines which child controls in a ContainerControl will be validated - /// by the method. + /// Determines which child controls in a ContainerControl will be validated + /// by the method. /// [Flags] public enum ValidationConstraints { /// - /// All child controls and their descendants are validated. + /// All child controls and their descendants are validated. /// None = 0x00, /// - /// Child control must be selectable to be validated. + /// Child control must be selectable to be validated. /// - /// Note: This flag allows validation of a control that has the - /// ControlStyles.Selectable style, ie. has the ability to be selected, - /// even when that control is currently unselectable because it has been - /// disabled or hidden. To prevent validation of selectable controls that - /// are currently disabled or hidden, + /// Note: This flag allows validation of a control that has the + /// ControlStyles.Selectable style, ie. has the ability to be selected, + /// even when that control is currently unselectable because it has been + /// disabled or hidden. To prevent validation of selectable controls that + /// are currently disabled or hidden, /// Selectable = 0x01, /// - /// Child control must be enabled to be validated (Control.Enabled = true). + /// Child control must be enabled to be validated (Control.Enabled = true). /// Enabled = 0x02, /// - /// Child control must be visible to be validated (Control.Visible = true). + /// Child control must be visible to be validated (Control.Visible = true). /// Visible = 0x04, /// - /// Child control must be a tab stops to be validated (Control.TabStop = true). + /// Child control must be a tab stops to be validated (Control.TabStop = true). /// TabStop = 0x08, /// - /// Only immediate children of container control are validated. - /// Descendants are not validated. + /// Only immediate children of container control are validated. + /// Descendants are not validated. /// ImmediateChildren = 0x10, } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/View.cs b/src/System.Windows.Forms/src/System/Windows/Forms/View.cs index 4eb3428f95e..0a052a0e3b2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/View.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/View.cs @@ -5,35 +5,35 @@ namespace System.Windows.Forms { /// - /// Specifies how list items are displayed in a control. + /// Specifies how list items are displayed in a control. /// public enum View { /// - /// Each item appears as a full-sized icon with a label below it. + /// Each item appears as a full-sized icon with a label below it. /// LargeIcon = NativeMethods.LVS_ICON, /// - /// Each item appears on a seperate line with further - /// information about each item arranged in columns. The left - /// most column - /// contains a small icon and - /// label, and subsequent columns contain subitems as specified by the application. A - /// column displays a header which can display a caption for the - /// column. The user can resize each column at runtime. + /// Each item appears on a seperate line with further + /// information about each item arranged in columns. The left + /// most column + /// contains a small icon and + /// label, and subsequent columns contain subitems as specified by the application. A + /// column displays a header which can display a caption for the + /// column. The user can resize each column at runtime. /// Details = NativeMethods.LVS_REPORT, /// - /// Each item appears as a small icon with a label to its right. + /// Each item appears as a small icon with a label to its right. /// SmallIcon = NativeMethods.LVS_SMALLICON, /// - /// Each item - /// appears as a small icon with a label to its right. - /// Items are arranged in columns with no column headers. + /// Each item + /// appears as a small icon with a label to its right. + /// Items are arranged in columns with no column headers. /// List = NativeMethods.LVS_LIST, diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleInformation.cs b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleInformation.cs index a3337495fc4..1119568fcb3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleInformation.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleInformation.cs @@ -23,14 +23,14 @@ public static class VisualStyleInformation private static VisualStyleRenderer visualStyleRenderer = null; /// - /// Used to find whether visual styles are supported by the current OS. Same as - /// using the OSFeature class to see if themes are supported. - /// This is always supported on platforms that .NET Core supports. + /// Used to find whether visual styles are supported by the current OS. Same as + /// using the OSFeature class to see if themes are supported. + /// This is always supported on platforms that .NET Core supports. /// public static bool IsSupportedByOS => true; /// - /// Returns true if a visual style has currently been applied by the user, else false. + /// Returns true if a visual style has currently been applied by the user, else false. /// public static bool IsEnabledByUser => SafeNativeMethods.IsAppThemed(); diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs index a2463e520e2..0ded128230c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs @@ -38,7 +38,7 @@ static VisualStyleRenderer() } /// - /// Check if visual styles is supported for client area. + /// Check if visual styles is supported for client area. /// private static bool AreClientAreaVisualStylesSupported { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleState.cs index 72235b8a28f..b05207bda30 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/VisualStyles/VisualStyleState.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms.VisualStyles { /// - /// Determines whether visual styles are enabled. + /// Determines whether visual styles are enabled. /// [Flags] public enum VisualStyleState @@ -16,17 +16,17 @@ public enum VisualStyleState NoneEnabled = 0, /// - /// Visual styles enabled only for client area. + /// Visual styles enabled only for client area. /// ClientAreaEnabled = NativeMethods.STAP_ALLOW_CONTROLS, /// - /// Visual styles enabled only for non-client area. + /// Visual styles enabled only for non-client area. /// NonClientAreaEnabled = NativeMethods.STAP_ALLOW_NONCLIENT, /// - /// Visual styles enabled only for client and non-client areas. + /// Visual styles enabled only for client and non-client areas. /// ClientAndNonClientAreasEnabled = NativeMethods.STAP_ALLOW_NONCLIENT | NativeMethods.STAP_ALLOW_CONTROLS } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowser.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowser.cs index 116b76f4e53..992a868603f 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowser.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowser.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms { /// - /// This is a wrapper over the native WebBrowser control implemented in shdocvw.dll. + /// This is a wrapper over the native WebBrowser control implemented in shdocvw.dll. /// [ComVisible(true), ClassInterface(ClassInterfaceType.AutoDispatch), @@ -53,7 +53,7 @@ public class WebBrowser : WebBrowserBase // 8856f961-340a-11d0-a96b-00c04fd705a2 is the clsid for the native webbrowser control // /// - /// Creates an instance of the control. + /// Creates an instance of the control. /// public WebBrowser() : base("8856f961-340a-11d0-a96b-00c04fd705a2") { @@ -69,9 +69,9 @@ public WebBrowser() : base("8856f961-340a-11d0-a96b-00c04fd705a2") // /// - /// Specifies whether the WebBrowser control may navigate to another page once - /// it has been loaded. NOTE: it will always be able to navigate before being loaded. - /// "Loaded" here means setting Url, DocumentText, or DocumentStream. + /// Specifies whether the WebBrowser control may navigate to another page once + /// it has been loaded. NOTE: it will always be able to navigate before being loaded. + /// "Loaded" here means setting Url, DocumentText, or DocumentStream. /// [SRDescription(nameof(SR.WebBrowserAllowNavigationDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(true)] @@ -92,11 +92,11 @@ public bool AllowNavigation } /// - /// Specifies whether the WebBrowser control will receive drop notifcations. - /// Maps to IWebBrowser2:RegisterAsDropTarget. - /// Note that this does not mean that the WebBrowser control integrates with - /// Windows Forms drag/drop i.e. the DragDrop event does not fire. It does - /// control whether you can drag new documents into the browser control. + /// Specifies whether the WebBrowser control will receive drop notifcations. + /// Maps to IWebBrowser2:RegisterAsDropTarget. + /// Note that this does not mean that the WebBrowser control integrates with + /// Windows Forms drag/drop i.e. the DragDrop event does not fire. It does + /// control whether you can drag new documents into the browser control. /// [SRDescription(nameof(SR.WebBrowserAllowWebBrowserDropDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(true)] @@ -119,8 +119,8 @@ public bool AllowWebBrowserDrop } /// - /// Specifies whether the browser control shows script errors in dialogs or not. - /// Maps to IWebBrowser2:Silent. + /// Specifies whether the browser control shows script errors in dialogs or not. + /// Maps to IWebBrowser2:Silent. /// [SRDescription(nameof(SR.WebBrowserScriptErrorsSuppressedDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(false)] @@ -140,8 +140,8 @@ public bool ScriptErrorsSuppressed } /// - /// Specifies whether the browser control Shortcuts are enabled. - /// Maps to IDocHostUIHandler:TranslateAccelerator event. + /// Specifies whether the browser control Shortcuts are enabled. + /// Maps to IDocHostUIHandler:TranslateAccelerator event. /// [SRDescription(nameof(SR.WebBrowserWebBrowserShortcutsEnabledDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(true)] @@ -158,9 +158,9 @@ public bool WebBrowserShortcutsEnabled } /// - /// If true, there is navigation history such that calling GoBack() will succeed. - /// Defaults to false. After that it's value is kept up to date by hooking the - /// DWebBrowserEvents2:CommandStateChange. + /// If true, there is navigation history such that calling GoBack() will succeed. + /// Defaults to false. After that it's value is kept up to date by hooking the + /// DWebBrowserEvents2:CommandStateChange. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool CanGoBack @@ -172,8 +172,8 @@ public bool CanGoBack } /// - /// Returns the current WEBBROWSERSTATE_canGoBack value so that this value can be accessed - /// from child classes. + /// Returns the current WEBBROWSERSTATE_canGoBack value so that this value can be accessed + /// from child classes. /// internal bool CanGoBackInternal { @@ -192,9 +192,9 @@ internal bool CanGoBackInternal } /// - /// If true, there is navigation history such that calling GoForward() will succeed. - /// Defaults to false. After that it's value is kept up to date by hooking the - /// DWebBrowserEvents2:CommandStateChange. + /// If true, there is navigation history such that calling GoForward() will succeed. + /// Defaults to false. After that it's value is kept up to date by hooking the + /// DWebBrowserEvents2:CommandStateChange. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool CanGoForward @@ -206,8 +206,8 @@ public bool CanGoForward } /// - /// Returns the current WEBBROWSERSTATE_canGoForward value so that this value can - /// be accessed from child classes. + /// Returns the current WEBBROWSERSTATE_canGoForward value so that this value can + /// be accessed from child classes. /// internal bool CanGoForwardInternal { @@ -226,8 +226,8 @@ internal bool CanGoForwardInternal } /// - /// The HtmlDocument for page hosted in the html page. If no page is loaded, it returns null. - /// Maps to IWebBrowser2:Document. + /// The HtmlDocument for page hosted in the html page. If no page is loaded, it returns null. + /// Maps to IWebBrowser2:Document. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public HtmlDocument Document @@ -265,8 +265,8 @@ public HtmlDocument Document } /// - /// Get/sets the stream for the html document. - /// Uses the IPersisteStreamInit interface on the HtmlDocument to set/retrieve the html stream. + /// Get/sets the stream for the html document. + /// Uses the IPersisteStreamInit interface on the HtmlDocument to set/retrieve the html stream. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public Stream DocumentStream @@ -312,7 +312,7 @@ public Stream DocumentStream } /// - /// Sets/sets the text of the contained html page. + /// Sets/sets the text of the contained html page. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public string DocumentText @@ -346,8 +346,8 @@ public string DocumentText } /// - /// The title of the html page currently loaded. If none are loaded, returns empty string. - /// Maps to IWebBrowser2:LocationName. + /// The title of the html page currently loaded. If none are loaded, returns empty string. + /// Maps to IWebBrowser2:LocationName. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public string DocumentTitle @@ -379,8 +379,8 @@ public string DocumentTitle } /// - /// A string containing the MIME type of the document hosted in the browser control. - /// If none are loaded, returns empty string. Maps to IHTMLDocument2:mimeType. + /// A string containing the MIME type of the document hosted in the browser control. + /// If none are loaded, returns empty string. Maps to IHTMLDocument2:mimeType. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public string DocumentType @@ -407,8 +407,8 @@ public string DocumentType } /// - /// Initially set to WebBrowserEncryptionLevel.Insecure. - /// After that it's kept up to date by hooking the DWebBrowserEvents2:SetSecureLockIcon. + /// Initially set to WebBrowserEncryptionLevel.Insecure. + /// After that it's kept up to date by hooking the DWebBrowserEvents2:SetSecureLockIcon. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public WebBrowserEncryptionLevel EncryptionLevel @@ -424,7 +424,7 @@ public WebBrowserEncryptionLevel EncryptionLevel } /// - /// True if the browser is engaged in navigation or download. Maps to IWebBrowser2:Busy. + /// True if the browser is engaged in navigation or download. Maps to IWebBrowser2:Busy. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool IsBusy @@ -443,7 +443,7 @@ public bool IsBusy } /// - /// Gets the offline state of the browser control. Maps to IWebBrowser2:Offline. + /// Gets the offline state of the browser control. Maps to IWebBrowser2:Offline. /// [SRDescription(nameof(SR.WebBrowserIsOfflineDescr)), Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool IsOffline @@ -455,11 +455,11 @@ public bool IsOffline } /// - /// Indicates whether to use the WebBrowser context menu. - /// It's technically possible to have both the WebBrowser & Windows Forms context - /// menu enabled, but making this property effect the behavior of the Windows Form - /// context menu does not lead to a clean OM. Maps to sinking the - /// IDocHostUIHandler:ShowContextMenu + /// Indicates whether to use the WebBrowser context menu. + /// It's technically possible to have both the WebBrowser & Windows Forms context + /// menu enabled, but making this property effect the behavior of the Windows Form + /// context menu does not lead to a clean OM. Maps to sinking the + /// IDocHostUIHandler:ShowContextMenu /// [SRDescription(nameof(SR.WebBrowserIsWebBrowserContextMenuEnabledDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(true)] @@ -476,10 +476,10 @@ public bool IsWebBrowserContextMenuEnabled } /// - /// Allows the host application to provide an object that the contained html - /// pages can access programatically in script. The object specified here - /// will be accessible in script as the "window.external" object via IDispatch - /// COM interop. Maps to an implementation of the IDocUIHandler.GetExternal event. + /// Allows the host application to provide an object that the contained html + /// pages can access programatically in script. The object specified here + /// will be accessible in script as the "window.external" object via IDispatch + /// COM interop. Maps to an implementation of the IDocUIHandler.GetExternal event. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public object ObjectForScripting @@ -528,8 +528,8 @@ public object ObjectForScripting } /// - /// Gets the ReadyState of the browser control. (ex.. document loading vs. load complete). - /// Maps to IWebBrowser2:ReadyState. + /// Gets the ReadyState of the browser control. (ex.. document loading vs. load complete). + /// Maps to IWebBrowser2:ReadyState. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public WebBrowserReadyState ReadyState @@ -548,10 +548,10 @@ public WebBrowserReadyState ReadyState } /// - /// The text that would be displayed in the IE status bar. - /// There is no direct WebBrowser property that maps to this. This property is - /// initially an empty string. After that the value is kept up to date via the - /// DWebBrowserEvents2:StatusTextChange event. + /// The text that would be displayed in the IE status bar. + /// There is no direct WebBrowser property that maps to this. This property is + /// initially an empty string. After that the value is kept up to date via the + /// DWebBrowserEvents2:StatusTextChange event. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public virtual string StatusText @@ -567,10 +567,10 @@ public virtual string StatusText } /// - /// The url of the HtmlDocument for page hosted in the html page. - /// Get Maps to IWebBrowser2:LocationUrl. Set is the equivalent of calling Navigate(Url). - /// Note this means that setting the Url property & then reading it immediately may not - /// return the result that you just set (since the get always returns the url you are currently at). + /// The url of the HtmlDocument for page hosted in the html page. + /// Get Maps to IWebBrowser2:LocationUrl. Set is the equivalent of calling Navigate(Url). + /// Note this means that setting the Url property & then reading it immediately may not + /// return the result that you just set (since the get always returns the url you are currently at). /// [ SRDescription(nameof(SR.WebBrowserUrlDescr)), @@ -609,8 +609,8 @@ public Uri Url } /// - /// Returns the version property of IE. - /// Determined by reading the file version of mshtml.dll in the %system% directory. + /// Returns the version property of IE. + /// Determined by reading the file version of mshtml.dll in the %system% directory. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public Version Version @@ -628,10 +628,10 @@ public Version Version // /// - /// Navigates the browser to the previous page in the navigation history list. - /// Maps to IWebBrowser2:GoBack. - /// Returns true if the operation succeeds, else returns false. It will return - /// false if there is no page in the navigation history to go back to. + /// Navigates the browser to the previous page in the navigation history list. + /// Maps to IWebBrowser2:GoBack. + /// Returns true if the operation succeeds, else returns false. It will return + /// false if there is no page in the navigation history to go back to. /// public bool GoBack() { @@ -652,10 +652,10 @@ public bool GoBack() } /// - /// Navigates the browser to the next page in the navigation history list. - /// Maps to IWebBrowser2:GoForward. - /// Returns true if the operation succeeds, else returns false. It will return - /// false if there is no page in the navigation history to go forward to. + /// Navigates the browser to the next page in the navigation history list. + /// Maps to IWebBrowser2:GoForward. + /// Returns true if the operation succeeds, else returns false. It will return + /// false if there is no page in the navigation history to go forward to. /// public bool GoForward() { @@ -676,7 +676,7 @@ public bool GoForward() } /// - /// Navigates the browser to user's homepage. Maps to IWebBrowser2:GoHome. + /// Navigates the browser to user's homepage. Maps to IWebBrowser2:GoHome. /// public void GoHome() { @@ -684,7 +684,7 @@ public void GoHome() } /// - /// Navigates the browser to user's default search page. Maps to IWebBrowser2:GoSearch. + /// Navigates the browser to user's default search page. Maps to IWebBrowser2:GoSearch. /// public void GoSearch() { @@ -692,7 +692,7 @@ public void GoSearch() } /// - /// Navigates to the specified Uri's AbsolutePath + /// Navigates to the specified Uri's AbsolutePath /// public void Navigate(Uri url) { @@ -700,21 +700,21 @@ public void Navigate(Uri url) } /// - /// String overload for Navigate(Uri) + /// String overload for Navigate(Uri) /// - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Navigate(string urlString) { PerformNavigateHelper(ReadyNavigateToUrl(urlString), false, null, null, null); } /// - /// Navigates the specified frame to the specified URL. - /// If the frame name is invalid, it opens a new window (not ideal, but it's the current behavior). - /// Maps to IWebBrowser2:Navigate. + /// Navigates the specified frame to the specified URL. + /// If the frame name is invalid, it opens a new window (not ideal, but it's the current behavior). + /// Maps to IWebBrowser2:Navigate. /// public void Navigate(Uri url, string targetFrameName) { @@ -722,19 +722,19 @@ public void Navigate(Uri url, string targetFrameName) } /// - /// String overload for Navigate(Uri, string) + /// String overload for Navigate(Uri, string) /// - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Navigate(string urlString, string targetFrameName) { PerformNavigateHelper(ReadyNavigateToUrl(urlString), false, targetFrameName, null, null); } /// - /// Opens a new window if newWindow is true, navigating it to the specified URL. Maps to IWebBrowser2:Navigate. + /// Opens a new window if newWindow is true, navigating it to the specified URL. Maps to IWebBrowser2:Navigate. /// public void Navigate(Uri url, bool newWindow) { @@ -742,19 +742,19 @@ public void Navigate(Uri url, bool newWindow) } /// - /// String overload for Navigate(Uri, bool) + /// String overload for Navigate(Uri, bool) /// - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Navigate(string urlString, bool newWindow) { PerformNavigateHelper(ReadyNavigateToUrl(urlString), newWindow, null, null, null); } /// - /// Navigates to the specified Uri's AbsolutePath with specified args + /// Navigates to the specified Uri's AbsolutePath with specified args /// public void Navigate(Uri url, string targetFrameName, byte[] postData, string additionalHeaders) { @@ -762,20 +762,20 @@ public void Navigate(Uri url, string targetFrameName, byte[] postData, string ad } /// - /// String overload for Navigate(Uri, string, byte[], string) + /// String overload for Navigate(Uri, string, byte[], string) /// - /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have - /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified - /// (things like "www.microsoft.com") that the underlying objects support and we don't want to - /// break. + /// Note: We intentionally have a string overload (apparently Mort wants one). We don't have + /// string overloads call Uri overloads because that breaks Uris that aren't fully qualified + /// (things like "www.microsoft.com") that the underlying objects support and we don't want to + /// break. public void Navigate(string urlString, string targetFrameName, byte[] postData, string additionalHeaders) { PerformNavigateHelper(ReadyNavigateToUrl(urlString), false, targetFrameName, postData, additionalHeaders); } /// - /// Prints the html document to the default printer w/ no print dialog. - /// Maps to IWebBrowser2:ExecWB w/ IDM_PRINT flag & LECMDEXECOPT_DONTPROMPTUSER. + /// Prints the html document to the default printer w/ no print dialog. + /// Maps to IWebBrowser2:ExecWB w/ IDM_PRINT flag & LECMDEXECOPT_DONTPROMPTUSER. /// public void Print() { @@ -794,7 +794,7 @@ public void Print() } /// - /// Refreshes the current page. Maps to IWebBrowser2:Refresh. + /// Refreshes the current page. Maps to IWebBrowser2:Refresh. /// public override void Refresh() { @@ -821,9 +821,9 @@ public override void Refresh() } /// - /// Refreshes the current page w/ the specified refresh option. The refresh option - /// controls how much is loaded out of the browser cache vs. rechecking the server for. - /// Maps to IWebBrowser2:Refresh2 + /// Refreshes the current page w/ the specified refresh option. The refresh option + /// controls how much is loaded out of the browser cache vs. rechecking the server for. + /// Maps to IWebBrowser2:Refresh2 /// public void Refresh(WebBrowserRefreshOption opt) { @@ -851,7 +851,7 @@ public void Refresh(WebBrowserRefreshOption opt) } /// - /// Enables/disables the webbrowser's scrollbars. + /// Enables/disables the webbrowser's scrollbars. /// [SRDescription(nameof(SR.WebBrowserScrollBarsEnabledDescr)), SRCategory(nameof(SR.CatBehavior)), DefaultValue(true)] @@ -872,8 +872,8 @@ public bool ScrollBarsEnabled } /// - /// Opens the IE page setup dialog for the current page. - /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PAGESETUP flag & LECMDEXECOPT_PROMPTUSER. + /// Opens the IE page setup dialog for the current page. + /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PAGESETUP flag & LECMDEXECOPT_PROMPTUSER. /// public void ShowPageSetupDialog() { @@ -892,8 +892,8 @@ public void ShowPageSetupDialog() } /// - /// Opens the IE print dialog. - /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PRINT flag & OLECMDEXECOPT_PROMPTUSER. + /// Opens the IE print dialog. + /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PRINT flag & OLECMDEXECOPT_PROMPTUSER. /// public void ShowPrintDialog() { @@ -913,7 +913,7 @@ public void ShowPrintDialog() } /// - /// Opens the IE print preview dialog. Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PRINTPREVIEW flag. + /// Opens the IE print preview dialog. Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PRINTPREVIEW flag. /// public void ShowPrintPreviewDialog() { @@ -933,8 +933,8 @@ public void ShowPrintPreviewDialog() } /// - /// Opens the properties dialog for the current html page. - /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PROPERTIES flag & LECMDEXECOPT_PROMPTUSER. + /// Opens the properties dialog for the current html page. + /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_PROPERTIES flag & LECMDEXECOPT_PROMPTUSER. /// public void ShowPropertiesDialog() { @@ -954,8 +954,8 @@ public void ShowPropertiesDialog() } /// - /// Opens the IE File-Save dialog. - /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_SAVEAS flag & LECMDEXECOPT_PROMPTUSER. + /// Opens the IE File-Save dialog. + /// Maps to IWebBrowser2:ExecWebBrowser w/ IDM_SAVEAS flag & LECMDEXECOPT_PROMPTUSER. /// public void ShowSaveAsDialog() { @@ -975,7 +975,7 @@ public void ShowSaveAsDialog() } /// - /// Stops the current navigation. Maps to IWebBrowser2:Stop. + /// Stops the current navigation. Maps to IWebBrowser2:Stop. /// public void Stop() { @@ -996,77 +996,77 @@ public void Stop() // Public events: // /// - /// Occurs when the IE back button would change from enabled to disabled or vice versa. - /// Maps to DWebBrowserEvents2:CommandStateChange w/ CSC_NAVIGATEBACK. + /// Occurs when the IE back button would change from enabled to disabled or vice versa. + /// Maps to DWebBrowserEvents2:CommandStateChange w/ CSC_NAVIGATEBACK. /// [Browsable(false), SRCategory(nameof(SR.CatPropertyChanged)), SRDescription(nameof(SR.WebBrowserCanGoBackChangedDescr))] public event EventHandler CanGoBackChanged; /// - /// Occurs when the IE forward button would change from enabled to disabled or vice versa. - /// Maps to DWebBrowserEvents2:CommandStateChange w/ CSC_NAVIGATEFORWARD. + /// Occurs when the IE forward button would change from enabled to disabled or vice versa. + /// Maps to DWebBrowserEvents2:CommandStateChange w/ CSC_NAVIGATEFORWARD. /// [Browsable(false), SRCategory(nameof(SR.CatPropertyChanged)), SRDescription(nameof(SR.WebBrowserCanGoForwardChangedDescr))] public event EventHandler CanGoForwardChanged; /// - /// Occurs when the document hosted in the web browser control is fully loaded. - /// This is conceptially similar to Form.Load(). You need to wait until this event fires - /// before doing anything that manipulates the html page, ex. reading the Document - /// property of the webbrowser control. Maps to DWebBrowserEvents2:DocumentComplete. + /// Occurs when the document hosted in the web browser control is fully loaded. + /// This is conceptially similar to Form.Load(). You need to wait until this event fires + /// before doing anything that manipulates the html page, ex. reading the Document + /// property of the webbrowser control. Maps to DWebBrowserEvents2:DocumentComplete. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.WebBrowserDocumentCompletedDescr))] public event WebBrowserDocumentCompletedEventHandler DocumentCompleted; /// - /// Occurs whenever the title text changes. The Title is the html page title - /// or the file path/url if not title is available. This is the text you see as - /// the title of the IE window preceeding "Microsoft Internet Explorer". - /// Maps to DWebBrowserEvents2:TitleChange. + /// Occurs whenever the title text changes. The Title is the html page title + /// or the file path/url if not title is available. This is the text you see as + /// the title of the IE window preceeding "Microsoft Internet Explorer". + /// Maps to DWebBrowserEvents2:TitleChange. /// [Browsable(false), SRCategory(nameof(SR.CatPropertyChanged)), SRDescription(nameof(SR.WebBrowserDocumentTitleChangedDescr))] public event EventHandler DocumentTitleChanged; /// - /// Occurs whenever encryption level changes. - /// Can be used to set a custom security lock icon similar to what IE shows when - /// you go to an https site. Maps to DWebBrowserEvents2:SetSecureLockIcon. + /// Occurs whenever encryption level changes. + /// Can be used to set a custom security lock icon similar to what IE shows when + /// you go to an https site. Maps to DWebBrowserEvents2:SetSecureLockIcon. /// [Browsable(false), SRCategory(nameof(SR.CatPropertyChanged)), SRDescription(nameof(SR.WebBrowserEncryptionLevelChangedDescr))] public event EventHandler EncryptionLevelChanged; /// - /// Occurs when a file download occurs. - /// Can be used to cancel file downloads. Maps to DWebBrowserEvents2:FileDownload. + /// Occurs when a file download occurs. + /// Can be used to cancel file downloads. Maps to DWebBrowserEvents2:FileDownload. /// [SRCategory(nameof(SR.CatBehavior)), SRDescription(nameof(SR.WebBrowserFileDownloadDescr))] public event EventHandler FileDownload; /// - /// Occurs after browser control navigation occurs. - /// Fires after browser navigation is complete. Maps to DWebBrowserEvents2:NavigateComplete. + /// Occurs after browser control navigation occurs. + /// Fires after browser navigation is complete. Maps to DWebBrowserEvents2:NavigateComplete. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.WebBrowserNavigatedDescr))] public event WebBrowserNavigatedEventHandler Navigated; /// - /// Occurs before browser control navigation occurs. - /// Fires before browser navigation occurs. Allows navigation to be canceled if - /// NavigatingEventArgs.Cancel is set to false. Maps to DWebBrowserEvents2:BeforeNavigate2. + /// Occurs before browser control navigation occurs. + /// Fires before browser navigation occurs. Allows navigation to be canceled if + /// NavigatingEventArgs.Cancel is set to false. Maps to DWebBrowserEvents2:BeforeNavigate2. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.WebBrowserNavigatingDescr))] public event WebBrowserNavigatingEventHandler Navigating; /// - /// Occurs when a new browser window is created. - /// Can be used to cancel the creation of the new browser window. Maps to DWebBrowserEvents2:NewWindow2. + /// Occurs when a new browser window is created. + /// Can be used to cancel the creation of the new browser window. Maps to DWebBrowserEvents2:NewWindow2. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.WebBrowserNewWindowDescr))] public event CancelEventHandler NewWindow; /// - /// Occurs when an update to the progress of a download occurs. - /// Fires whenever the browser control has updated info on the download. Can be - /// used to provide a download status bar and display the number of bytes downloaded. - /// Maps to DWebBrowserEvents2:ProgressChange. + /// Occurs when an update to the progress of a download occurs. + /// Fires whenever the browser control has updated info on the download. Can be + /// used to provide a download status bar and display the number of bytes downloaded. + /// Maps to DWebBrowserEvents2:ProgressChange. /// [SRCategory(nameof(SR.CatAction)), SRDescription(nameof(SR.WebBrowserProgressChangedDescr))] public event WebBrowserProgressChangedEventHandler ProgressChanged; /// - /// Occurs whenever the status text changes. - /// Can be used to keep a status bar populated with uptodate text. - /// Maps to DWebBrowserEvents2:StatusTextChange. + /// Occurs whenever the status text changes. + /// Can be used to keep a status bar populated with uptodate text. + /// Maps to DWebBrowserEvents2:StatusTextChange. /// [Browsable(false), SRCategory(nameof(SR.CatPropertyChanged)), SRDescription(nameof(SR.WebBrowserStatusTextChangedDescr))] public event EventHandler StatusTextChanged; @@ -1112,7 +1112,7 @@ protected override void Dispose(bool disposing) } /// - /// Overrides the default size property of Control to specify a bigger default size of 250 x 250. + /// Overrides the default size property of Control to specify a bigger default size of 250 x 250. /// protected override Size DefaultSize { @@ -1123,7 +1123,7 @@ protected override Size DefaultSize } /// - /// Retrieves IWebBrowser2 from the native object. Overriding classes should first call base.AttachInterfaces. + /// Retrieves IWebBrowser2 from the native object. Overriding classes should first call base.AttachInterfaces. /// protected override void AttachInterfaces(object nativeActiveXObject) { @@ -1131,7 +1131,7 @@ protected override void AttachInterfaces(object nativeActiveXObject) } /// - /// Discards the IWebBrowser2 reference. Overriding classes should call base.DetachInterfaces. + /// Discards the IWebBrowser2 reference. Overriding classes should call base.DetachInterfaces. /// protected override void DetachInterfaces() { @@ -1139,7 +1139,7 @@ protected override void DetachInterfaces() } /// - /// Returns a WebBrowserSite object. + /// Returns a WebBrowserSite object. /// protected override WebBrowserSiteBase CreateWebBrowserSiteBase() { @@ -1147,7 +1147,7 @@ protected override WebBrowserSiteBase CreateWebBrowserSiteBase() } /// - /// Attaches to the DWebBrowserEvents2 connection point. + /// Attaches to the DWebBrowserEvents2 connection point. /// protected override void CreateSink() { @@ -1164,7 +1164,7 @@ protected override void CreateSink() } /// - /// Releases the DWebBrowserEvents2 connection point. + /// Releases the DWebBrowserEvents2 connection point. /// protected override void DetachSink() { @@ -1195,7 +1195,7 @@ internal override void OnTopMostActiveXParentChanged(EventArgs e) // /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnCanGoBackChanged(EventArgs e) @@ -1204,7 +1204,7 @@ protected virtual void OnCanGoBackChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnCanGoForwardChanged(EventArgs e) @@ -1213,7 +1213,7 @@ protected virtual void OnCanGoForwardChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnDocumentCompleted(WebBrowserDocumentCompletedEventArgs e) @@ -1223,7 +1223,7 @@ protected virtual void OnDocumentCompleted(WebBrowserDocumentCompletedEventArgs } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnDocumentTitleChanged(EventArgs e) @@ -1232,7 +1232,7 @@ protected virtual void OnDocumentTitleChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnEncryptionLevelChanged(EventArgs e) @@ -1241,7 +1241,7 @@ protected virtual void OnEncryptionLevelChanged(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnFileDownload(EventArgs e) @@ -1250,7 +1250,7 @@ protected virtual void OnFileDownload(EventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnNavigated(WebBrowserNavigatedEventArgs e) @@ -1259,7 +1259,7 @@ protected virtual void OnNavigated(WebBrowserNavigatedEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnNavigating(WebBrowserNavigatingEventArgs e) @@ -1268,7 +1268,7 @@ protected virtual void OnNavigating(WebBrowserNavigatingEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnNewWindow(CancelEventArgs e) @@ -1277,7 +1277,7 @@ protected virtual void OnNewWindow(CancelEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnProgressChanged(WebBrowserProgressChangedEventArgs e) @@ -1286,7 +1286,7 @@ protected virtual void OnProgressChanged(WebBrowserProgressChangedEventArgs e) } /// - /// Raises the event. + /// Raises the event. /// // protected virtual void OnStatusTextChanged(EventArgs e) @@ -1512,14 +1512,14 @@ private UnsafeNativeMethods.IWebBrowser2 AxIWebBrowser2 // WebBrowserSite class: // /// - /// Provides a default WebBrowserSite implementation for use in the CreateWebBrowserSite - /// method in the WebBrowser class. + /// Provides a default WebBrowserSite implementation for use in the CreateWebBrowserSite + /// method in the WebBrowser class. /// [ComVisible(false)] protected class WebBrowserSite : WebBrowserSiteBase, UnsafeNativeMethods.IDocHostUIHandler { /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// public WebBrowserSite(WebBrowser host) : base(host) { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserBase.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserBase.cs index f2c56d59643..494de541bbf 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserBase.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserBase.cs @@ -15,17 +15,17 @@ namespace System.Windows.Forms { /// - /// Wraps ActiveX controls and exposes them as fully featured windows forms controls - /// (by inheriting from Control). Some of Control's properties that don't make sense - /// for ActiveX controls are blocked here (by setting Browsable attributes on some and - /// throwing exceptions from others), to make life easy for the inheritors. + /// Wraps ActiveX controls and exposes them as fully featured windows forms controls + /// (by inheriting from Control). Some of Control's properties that don't make sense + /// for ActiveX controls are blocked here (by setting Browsable attributes on some and + /// throwing exceptions from others), to make life easy for the inheritors. /// - /// Inheritors of this class simply need to concentrate on defining & implementing the - /// properties/methods/events of the specific ActiveX control they are wrapping, the - /// default properties etc and the code to implement the activation etc. are - /// encapsulated in the class below. + /// Inheritors of this class simply need to concentrate on defining & implementing the + /// properties/methods/events of the specific ActiveX control they are wrapping, the + /// default properties etc and the code to implement the activation etc. are + /// encapsulated in the class below. /// - /// The classid of the ActiveX control is specified in the constructor. + /// The classid of the ActiveX control is specified in the constructor. /// [ComVisible(true)] [ClassInterface(ClassInterfaceType.AutoDispatch)] @@ -69,8 +69,8 @@ public class WebBrowserBase : Control internal object activeXInstance; /// - /// Creates a new instance of a WinForms control which wraps an ActiveX control - /// given by the clsid parameter. + /// Creates a new instance of a WinForms control which wraps an ActiveX control + /// given by the clsid parameter. /// internal WebBrowserBase(string clsidString) : base() { @@ -91,7 +91,7 @@ internal WebBrowserBase(string clsidString) : base() // /// - /// Returns the native webbrowser object that this control wraps. + /// Returns the native webbrowser object that this control wraps. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public object ActiveXInstance @@ -121,8 +121,8 @@ public object ActiveXInstance // below method and return their own WebBrowserSiteBaseBase derived object. // /// - /// Returns an object that will be set as the site for the native ActiveX control. - /// Implementors of the site can derive from class. + /// Returns an object that will be set as the site for the native ActiveX control. + /// Implementors of the site can derive from class. /// protected virtual WebBrowserSiteBase CreateWebBrowserSiteBase() { @@ -130,34 +130,34 @@ protected virtual WebBrowserSiteBase CreateWebBrowserSiteBase() } /// - /// This will be called when the native ActiveX control has just been created. - /// Inheritors of this class can override this method to cast the nativeActiveXObject - /// parameter to the appropriate interface. They can then cache this interface - /// value in a member variable. However, they must release this value when - /// DetachInterfaces is called (by setting the cached interface variable to null). + /// This will be called when the native ActiveX control has just been created. + /// Inheritors of this class can override this method to cast the nativeActiveXObject + /// parameter to the appropriate interface. They can then cache this interface + /// value in a member variable. However, they must release this value when + /// DetachInterfaces is called (by setting the cached interface variable to null). /// protected virtual void AttachInterfaces(object nativeActiveXObject) { } /// - /// See AttachInterfaces for a description of when to override DetachInterfaces. + /// See AttachInterfaces for a description of when to override DetachInterfaces. /// protected virtual void DetachInterfaces() { } /// - /// This will be called when we are ready to start listening to events. - /// Inheritors can override this method to hook their own connection points. + /// This will be called when we are ready to start listening to events. + /// Inheritors can override this method to hook their own connection points. /// protected virtual void CreateSink() { } /// - /// This will be called when it is time to stop listening to events. - /// This is where inheritors have to disconnect their connection points. + /// This will be called when it is time to stop listening to events. + /// This is where inheritors have to disconnect their connection points. /// protected virtual void DetachSink() { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventArgs.cs index e796bd3cd45..0d00c937287 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventArgs.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class WebBrowserDocumentCompletedEventArgs : EventArgs { private readonly Uri _url; /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// public WebBrowserDocumentCompletedEventArgs(Uri url) { @@ -20,7 +20,7 @@ public WebBrowserDocumentCompletedEventArgs(Uri url) } /// - /// Url of the Document. + /// Url of the Document. /// public Uri Url { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventHandler.cs index 3bc953f7820..e15cca9fb16 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserDocumentCompletedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Delegate to the WebBrowser DocumentCompleted event. + /// Delegate to the WebBrowser DocumentCompleted event. /// public delegate void WebBrowserDocumentCompletedEventHandler(object sender, WebBrowserDocumentCompletedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserEncryptionLevel.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserEncryptionLevel.cs index 3d356cfa54e..7645f5de945 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserEncryptionLevel.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserEncryptionLevel.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Specifies the EncryptionLevel of the document in the WebBrowser control. - /// Returned by the property. + /// Specifies the EncryptionLevel of the document in the WebBrowser control. + /// Returned by the property. /// public enum WebBrowserEncryptionLevel { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserHelper.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserHelper.cs index 633a3303da5..a272aa2b74e 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserHelper.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserHelper.cs @@ -12,9 +12,9 @@ namespace System.Windows.Forms { /// - /// This class contains static properties/methods that are internal. - /// It also has types that make sense only for ActiveX hosting classes. - /// In other words, this is a helper class for the ActiveX hosting classes. + /// This class contains static properties/methods that are internal. + /// It also has types that make sense only for ActiveX hosting classes. + /// In other words, this is a helper class for the ActiveX hosting classes. /// internal static class WebBrowserHelper { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventArgs.cs index 625d8bd0093..9848bc22ac3 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventArgs.cs @@ -5,14 +5,14 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class WebBrowserNavigatedEventArgs : EventArgs { private readonly Uri _url; /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// public WebBrowserNavigatedEventArgs(Uri url) { @@ -20,7 +20,7 @@ public WebBrowserNavigatedEventArgs(Uri url) } /// - /// Url the browser navigated to. + /// Url the browser navigated to. /// public Uri Url { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventHandler.cs index 490425513bf..b47f3bee67c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Delegate to the WebBrowser Navigated event. + /// Delegate to the WebBrowser Navigated event. /// public delegate void WebBrowserNavigatedEventHandler(object sender, WebBrowserNavigatedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventArgs.cs index 182af5c2912..8215e64bc48 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventArgs.cs @@ -7,7 +7,7 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class WebBrowserNavigatingEventArgs : CancelEventArgs { @@ -15,7 +15,7 @@ public class WebBrowserNavigatingEventArgs : CancelEventArgs private readonly string _targetFrameName; /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// public WebBrowserNavigatingEventArgs(Uri url, string targetFrameName) { @@ -24,7 +24,7 @@ public WebBrowserNavigatingEventArgs(Uri url, string targetFrameName) } /// - /// Url the browser is navigating to. + /// Url the browser is navigating to. /// public Uri Url { @@ -35,7 +35,7 @@ public Uri Url } /// - /// In case an individual frame is about to be navigated, this contains the frame name. + /// In case an individual frame is about to be navigated, this contains the frame name. /// public string TargetFrameName { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventHandler.cs index ac25c5bfc0e..fa90fc9e5b2 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserNavigatingEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Delegate to the WebBrowser Navigating event. + /// Delegate to the WebBrowser Navigating event. /// public delegate void WebBrowserNavigatingEventHandler(object sender, WebBrowserNavigatingEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventArgs.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventArgs.cs index 288a1fb6829..67f0aa0118c 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventArgs.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventArgs.cs @@ -5,12 +5,12 @@ namespace System.Windows.Forms { /// - /// Provides data for the event. + /// Provides data for the event. /// public class WebBrowserProgressChangedEventArgs : EventArgs { /// - /// Creates an instance of the class. + /// Creates an instance of the class. /// public WebBrowserProgressChangedEventArgs(long currentProgress, long maximumProgress) { @@ -19,13 +19,13 @@ public WebBrowserProgressChangedEventArgs(long currentProgress, long maximumProg } /// - /// Specifies current number of bytes donwloaded. CurrentProgress/MaximumProgress*100 = progress percentage. + /// Specifies current number of bytes donwloaded. CurrentProgress/MaximumProgress*100 = progress percentage. /// public long CurrentProgress { get; } /// - /// Specifies total number of bytes of item being downloaded. - /// CurrentProgress/MaximumProgress*100 = progress percentage. + /// Specifies total number of bytes of item being downloaded. + /// CurrentProgress/MaximumProgress*100 = progress percentage. /// public long MaximumProgress { get; } } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventHandler.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventHandler.cs index 29f5ece1113..f204b8af9a8 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventHandler.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserProgressChangedEventHandler.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Delegate to the WebBrowser ProgressChanged event. + /// Delegate to the WebBrowser ProgressChanged event. /// public delegate void WebBrowserProgressChangedEventHandler(object sender, WebBrowserProgressChangedEventArgs e); } diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserReadyState.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserReadyState.cs index a40e7f90ca6..e351d87bf5b 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserReadyState.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserReadyState.cs @@ -5,8 +5,8 @@ namespace System.Windows.Forms { /// - /// Specifies the ReadyState of the WebBrowser control. - /// Returned by the property. + /// Specifies the ReadyState of the WebBrowser control. + /// Returned by the property. /// public enum WebBrowserReadyState { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserRefreshOption.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserRefreshOption.cs index 322ae863254..333187aa145 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserRefreshOption.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserRefreshOption.cs @@ -5,7 +5,7 @@ namespace System.Windows.Forms { /// - /// Specifies the RefreshOptions in the method. + /// Specifies the RefreshOptions in the method. /// public enum WebBrowserRefreshOption { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserSiteBase.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserSiteBase.cs index 17b40728aea..1d8fde2c20d 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserSiteBase.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WebBrowserSiteBase.cs @@ -10,16 +10,16 @@ namespace System.Windows.Forms { /// - /// This class implements the necessary interfaces required for an ActiveX site. + /// This class implements the necessary interfaces required for an ActiveX site. /// - /// This class is public, but has an internal constructor so that external - /// users can only reference the Type (cannot instantiate it directly). - /// Other classes have to inherit this class and expose it to the outside world. + /// This class is public, but has an internal constructor so that external + /// users can only reference the Type (cannot instantiate it directly). + /// Other classes have to inherit this class and expose it to the outside world. /// - /// This class does not have any public property/method/event by itself. - /// All implementations of the site interface methods are private, which - /// means that inheritors who want to override even a single method of one - /// of these interfaces will have to implement the whole interface. + /// This class does not have any public property/method/event by itself. + /// All implementations of the site interface methods are private, which + /// means that inheritors who want to override even a single method of one + /// of these interfaces will have to implement the whole interface. /// public class WebBrowserSiteBase : UnsafeNativeMethods.IOleControlSite, UnsafeNativeMethods.IOleClientSite, UnsafeNativeMethods.IOleInPlaceSite, UnsafeNativeMethods.ISimpleFrameSite, UnsafeNativeMethods.IPropertyNotifySink, IDisposable @@ -38,7 +38,7 @@ internal WebBrowserSiteBase(WebBrowserBase h) } /// - /// Dispose(release the cookie) + /// Dispose(release the cookie) /// public void Dispose() { @@ -46,7 +46,7 @@ public void Dispose() } /// - /// Release the cookie if we're disposing + /// Release the cookie if we're disposing /// protected virtual void Dispose(bool disposing) { @@ -57,7 +57,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Retrieves the WebBrowserBase object set in the constructor. + /// Retrieves the WebBrowserBase object set in the constructor. /// internal WebBrowserBase Host { diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/WinFormsUtils.cs b/src/System.Windows.Forms/src/System/Windows/Forms/WinFormsUtils.cs index 8fa02b4d6d0..b92751a7497 100644 --- a/src/System.Windows.Forms/src/System/Windows/Forms/WinFormsUtils.cs +++ b/src/System.Windows.Forms/src/System/Windows/Forms/WinFormsUtils.cs @@ -23,8 +23,8 @@ internal sealed class WindowsFormsUtils public static readonly ContentAlignment AnyCenterAlign = ContentAlignment.TopCenter | ContentAlignment.MiddleCenter | ContentAlignment.BottomCenter; /// - /// The GetMessagePos function retrieves the cursor position for the last message - /// retrieved by the GetMessage function. + /// The GetMessagePos function retrieves the cursor position for the last message + /// retrieved by the GetMessage function. /// public static Point LastCursorPoint { @@ -36,7 +36,7 @@ public static Point LastCursorPoint } /// - /// this graphics requires disposal. + /// this graphics requires disposal. /// public static Graphics CreateMeasurementGraphics() { @@ -44,9 +44,9 @@ public static Graphics CreateMeasurementGraphics() } /// - /// If you want to know if a piece of text contains one and only one & - /// this is your function. If you have a character "t" and want match it to &Text - /// Control.IsMnemonic is a better bet. + /// If you want to know if a piece of text contains one and only one & + /// this is your function. If you have a character "t" and want match it to &Text + /// Control.IsMnemonic is a better bet. /// public static bool ContainsMnemonic(string text) { @@ -78,7 +78,7 @@ internal static Rectangle ConstrainToScreenWorkingAreaBounds(Rectangle bounds) } /// - /// Given a rectangle, constrain it to fit onto the current screen. + /// Given a rectangle, constrain it to fit onto the current screen. /// internal static Rectangle ConstrainToScreenBounds(Rectangle bounds) { @@ -126,8 +126,8 @@ internal static Rectangle ConstrainToBounds(Rectangle constrainingBounds, Rectan } /// - /// Adds an extra & to to the text so that "Fish & Chips" can be displayed on a menu item - /// without underlining anything. + /// Adds an extra & to to the text so that "Fish & Chips" can be displayed on a menu item + /// without underlining anything. /// Fish & Chips --> Fish && Chips /// internal static string EscapeTextWithAmpersands(string text) @@ -159,9 +159,9 @@ internal static string EscapeTextWithAmpersands(string text) } /// - /// helper function for generating information about a particular control - /// use AssertControlInformation if sticking in an assert - then the work - /// to figure out the control info will only be done when the assertion is false. + /// helper function for generating information about a particular control + /// use AssertControlInformation if sticking in an assert - then the work + /// to figure out the control info will only be done when the assertion is false. /// internal static string GetControlInformation(IntPtr hwnd) { @@ -212,8 +212,8 @@ internal static string AssertControlInformation(bool condition, Control control) } /// - /// Retrieves the mnemonic from a given string, or zero if no mnemonic. - /// As used by the Control.Mnemonic to get mnemonic from Control.Text. + /// Retrieves the mnemonic from a given string, or zero if no mnemonic. + /// As used by the Control.Mnemonic to get mnemonic from Control.Text. /// public static char GetMnemonic(string text, bool convertToUpperCase) { @@ -248,7 +248,7 @@ public static char GetMnemonic(string text, bool convertToUpperCase) } /// - /// Finds the top level handle for a given handle. + /// Finds the top level handle for a given handle. /// public static HandleRef GetRootHWnd(HandleRef hwnd) { @@ -257,7 +257,7 @@ public static HandleRef GetRootHWnd(HandleRef hwnd) } /// - /// Finds the top level handle for a given handle. + /// Finds the top level handle for a given handle. /// public static HandleRef GetRootHWnd(Control control) { @@ -265,12 +265,12 @@ public static HandleRef GetRootHWnd(Control control) } /// - /// Strips all keyboard mnemonic prefixes from a given string, eg. turning "He&lp" into "Help". + /// Strips all keyboard mnemonic prefixes from a given string, eg. turning "He&lp" into "Help". /// /// - /// Note: Be careful not to call this multiple times on the same string, otherwise you'll turn - /// something like "Fi&sh && Chips" into "Fish & Chips" on the first call, and then "Fish Chips" - /// on the second call. + /// Note: Be careful not to call this multiple times on the same string, otherwise you'll turn + /// something like "Fi&sh && Chips" into "Fish & Chips" on the first call, and then "Fish Chips" + /// on the second call. /// public static string TextWithoutMnemonics(string text) { @@ -304,10 +304,10 @@ public static string TextWithoutMnemonics(string text) } /// - /// Translates a point from one control's coordinate system to the other - /// same as: + /// Translates a point from one control's coordinate system to the other + /// same as: /// controlTo.PointToClient(controlFrom.PointToScreen(point)) - /// but slightly more performant. + /// but slightly more performant. /// public static Point TranslatePoint(Point point, Control fromControl, Control toControl) { @@ -316,10 +316,10 @@ public static Point TranslatePoint(Point point, Control fromControl, Control toC } /// - /// Compares the strings using invariant culture for Turkish-I support. Returns true if they match. + /// Compares the strings using invariant culture for Turkish-I support. Returns true if they match. /// - /// If your strings are symbolic (returned from APIs, not from user) the following calls - /// are faster than this method: + /// If your strings are symbolic (returned from APIs, not from user) the following calls + /// are faster than this method: /// /// String.Equals(s1, s2, StringComparison.Ordinal) /// String.Equals(s1, s2, StringComparison.OrdinalIgnoreCase) @@ -359,8 +359,8 @@ public static string GetComponentName(IComponent component, string defaultNameVa public static class EnumValidator { /// - /// Valid values are 0x001,0x002,0x004, 0x010,0x020,0x040, 0x100, 0x200,0x400 - /// Method for verifying + /// Valid values are 0x001,0x002,0x004, 0x010,0x020,0x040, 0x100, 0x200,0x400 + /// Method for verifying /// Verify that the number passed in has only one bit on /// Verify that the bit that is on is a valid bit by bitwise anding it to a mask. /// @@ -378,11 +378,11 @@ public static bool IsValidContentAlignment(ContentAlignment contentAlign) } /// - /// shifts off the number of bits specified by numBitsToShift + /// shifts off the number of bits specified by numBitsToShift /// - makes sure the bits we've shifted off are just zeros /// - then compares if the resulting value is between minValAfterShift and maxValAfterShift /// - /// EXAMPLE: + /// EXAMPLE: /// MessageBoxIcon. Valid values are 0x0, 0x10, 0x20, 0x30, 0x40 /// Method for verifying: chop off the last 0 by shifting right 4 bits, verify resulting number is between 0 & 4. /// @@ -436,9 +436,9 @@ public void Reset() } /// - /// This is a ControlCollection which can be made readonly. In readonly mode, this - /// ControlCollection throws NotSupportedExceptions for any operation that attempts - /// to modify the collection. + /// This is a ControlCollection which can be made readonly. In readonly mode, this + /// ControlCollection throws NotSupportedExceptions for any operation that attempts + /// to modify the collection. /// internal class ReadOnlyControlCollection : Control.ControlCollection { @@ -487,8 +487,8 @@ public override void RemoveByKey(string key) } /// - /// This control collection only allows a specific type of control - /// into the controls collection. It optionally supports readonlyness. + /// This control collection only allows a specific type of control + /// into the controls collection. It optionally supports readonlyness. /// internal class TypedControlCollection : ReadOnlyControlCollection { @@ -530,14 +530,14 @@ public override void Add(Control value) } /// - /// DCMapping is used to change the mapping and clip region of the - /// the specified device context to the given bounds. When the - /// DCMapping is disposed, the original mapping and clip rectangle - /// are restored. + /// DCMapping is used to change the mapping and clip region of the + /// the specified device context to the given bounds. When the + /// DCMapping is disposed, the original mapping and clip rectangle + /// are restored. /// - /// Example: + /// Example: /// - /// using(WindowsFormsUtils.DCMapping mapping = new WindowsFormsUtils.DCMapping(hDC, new Rectangle(10,10, 50, 50) { + /// using(WindowsFormsUtils.DCMapping mapping = new WindowsFormsUtils.DCMapping(hDC, new Rectangle(10,10, 50, 50) { /// // inside here the hDC's mapping of (0,0) is inset by (10,10) and /// // all painting is clipped at (0,0) - (50,50) /// } @@ -686,8 +686,8 @@ public void Dispose() } /// - /// Allows you to get the graphics object based off of the translated HDC. - /// Note this will be disposed when the DCMapping object is disposed. + /// Allows you to get the graphics object based off of the translated HDC. + /// Note this will be disposed when the DCMapping object is disposed. /// public Graphics Graphics { diff --git a/src/System.Windows.Forms/src/misc/DbgUtil.cs b/src/System.Windows.Forms/src/misc/DbgUtil.cs index dcd82ce6ae8..f43ef02d772 100644 --- a/src/System.Windows.Forms/src/misc/DbgUtil.cs +++ b/src/System.Windows.Forms/src/misc/DbgUtil.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Internal { /// - /// Debug help utility. + /// Debug help utility. /// internal sealed class DbgUtil { diff --git a/src/System.Windows.Forms/src/misc/GDI/DeviceContext.cs b/src/System.Windows.Forms/src/misc/GDI/DeviceContext.cs index 2740cf52011..28676c7a9f8 100644 --- a/src/System.Windows.Forms/src/misc/GDI/DeviceContext.cs +++ b/src/System.Windows.Forms/src/misc/GDI/DeviceContext.cs @@ -89,9 +89,8 @@ internal sealed partial class DeviceContext : MarshalByRefObject, IDeviceContext #endif /// - /// Class properties... + /// Class properties... /// - /// /// Specifies whether a modification has been applied to the dc, like setting the clipping area or a coordinate transform. /// diff --git a/src/System.Windows.Forms/src/misc/GDI/DeviceContext2.cs b/src/System.Windows.Forms/src/misc/GDI/DeviceContext2.cs index 2c098a7e0e3..6f29c3152d9 100644 --- a/src/System.Windows.Forms/src/misc/GDI/DeviceContext2.cs +++ b/src/System.Windows.Forms/src/misc/GDI/DeviceContext2.cs @@ -93,20 +93,20 @@ public DeviceContextBinaryRasterOperationFlags SetRasterOperation(DeviceContextB } /// - /// Get the number of pixels per logical inch along the device axes. In a system with multiple display - /// monitors, this value is the same for all monitors. + /// Get the number of pixels per logical inch along the device axes. In a system with multiple display + /// monitors, this value is the same for all monitors. /// public Size Dpi => new Size(DpiX, DpiY); /// - /// Get the number of pixels per logical inch along the device width. In a system with multiple display - /// monitors, this value is the same for all monitors. + /// Get the number of pixels per logical inch along the device width. In a system with multiple display + /// monitors, this value is the same for all monitors. /// public int DpiX => Interop.Gdi32.GetDeviceCaps(new HandleRef(this, Hdc), Interop.Gdi32.DeviceCapability.LOGPIXELSX); /// - /// Get the number of pixels per logical inch along the device (screen) height. In a system with multiple - /// display monitors, this value is the same for all monitors. + /// Get the number of pixels per logical inch along the device (screen) height. In a system with multiple + /// display monitors, this value is the same for all monitors. /// public int DpiY => Interop.Gdi32.GetDeviceCaps(new HandleRef(this, Hdc), Interop.Gdi32.DeviceCapability.LOGPIXELSY); diff --git a/src/System.Windows.Forms/src/misc/GDI/DeviceContexts.cs b/src/System.Windows.Forms/src/misc/GDI/DeviceContexts.cs index 188faa5f09e..c2d67fd8b69 100644 --- a/src/System.Windows.Forms/src/misc/GDI/DeviceContexts.cs +++ b/src/System.Windows.Forms/src/misc/GDI/DeviceContexts.cs @@ -15,9 +15,9 @@ internal static class DeviceContexts private static ClientUtils.WeakRefCollection activeDeviceContexts; /// - /// WindowsGraphicsCacheManager needs to track DeviceContext - /// objects so it can ask them if a font is in use before they - /// it's deleted. + /// WindowsGraphicsCacheManager needs to track DeviceContext + /// objects so it can ask them if a font is in use before they + /// it's deleted. internal static void AddDeviceContext(DeviceContext dc) { if (activeDeviceContexts == null) diff --git a/src/System.Windows.Forms/src/misc/GDI/MeasurementDCInfo.cs b/src/System.Windows.Forms/src/misc/GDI/MeasurementDCInfo.cs index 8ed1c36d6de..6dd0abd1f93 100644 --- a/src/System.Windows.Forms/src/misc/GDI/MeasurementDCInfo.cs +++ b/src/System.Windows.Forms/src/misc/GDI/MeasurementDCInfo.cs @@ -12,17 +12,17 @@ namespace System.Windows.Forms.Internal { internal static class MeasurementDCInfo { - /// MeasurementDCInfo - /// This class optimizes the MeasurmentGraphics as it caches in the last used font and TextMargins used. - /// This prevents unnecessary p/invoke calls to GetCurrentObject, etc - /// It has been found to give close to 2x performance when drawing lots of text in rapid succession - /// DataGridView with lots of text, etc. - /// To turn it on for your DLL, use the OPTIMIZED_MEASUREMENTDC compiler switch and add this class to the sources. + /// MeasurementDCInfo + /// This class optimizes the MeasurmentGraphics as it caches in the last used font and TextMargins used. + /// This prevents unnecessary p/invoke calls to GetCurrentObject, etc + /// It has been found to give close to 2x performance when drawing lots of text in rapid succession + /// DataGridView with lots of text, etc. + /// To turn it on for your DLL, use the OPTIMIZED_MEASUREMENTDC compiler switch and add this class to the sources. [ThreadStatic] private static CachedInfo cachedMeasurementDCInfo; - /// IsMeasurementDC + /// IsMeasurementDC /// Returns whether the IDeviceContext passed in is our static MeasurementDC. /// If it is, we know a bit more information about it. internal static bool IsMeasurementDC(DeviceContext dc) @@ -31,7 +31,7 @@ internal static bool IsMeasurementDC(DeviceContext dc) return sharedGraphics != null && sharedGraphics.DeviceContext != null && sharedGraphics.DeviceContext.Hdc == dc.Hdc; } - /// LastUsedFont - + /// LastUsedFont - /// Returns the font we think was last selected into the MeasurementGraphics. /// internal static WindowsFont LastUsedFont @@ -50,9 +50,9 @@ internal static WindowsFont LastUsedFont } } - /// GetTextMargins - checks to see if we have cached information about the current font, - /// returns info about it. - /// An MRU of Font margins was considered, but seems like overhead. + /// GetTextMargins - checks to see if we have cached information about the current font, + /// returns info about it. + /// An MRU of Font margins was considered, but seems like overhead. internal static Interop.User32.DRAWTEXTPARAMS GetTextMargins(WindowsGraphics wg, WindowsFont font) { // PERF: operate on a local reference rather than party directly on the thread static one. @@ -96,7 +96,7 @@ internal static void ResetIfIsMeasurementDC(IntPtr hdc) } } } - /// Reset + /// Reset /// clear the current cached information about the measurement dc. internal static void Reset() { @@ -106,7 +106,7 @@ internal static void Reset() currentCachedInfo.UpdateFont(null); } } - /// CachedInfo + /// CachedInfo /// store all the thread statics together so we dont have to fetch individual fields out of TLS private sealed class CachedInfo { diff --git a/src/System.Windows.Forms/src/misc/GDI/UnsafeNativeMethods.cs b/src/System.Windows.Forms/src/misc/GDI/UnsafeNativeMethods.cs index 6582dbe47fc..683402a5460 100644 --- a/src/System.Windows.Forms/src/misc/GDI/UnsafeNativeMethods.cs +++ b/src/System.Windows.Forms/src/misc/GDI/UnsafeNativeMethods.cs @@ -64,11 +64,11 @@ public static int GetBkMode(HandleRef hDC) public static extern int GetBkColor(HandleRef hDC); /// - /// This method is currently used just for drawing the text background - /// (ComponentEditorForm.cs) and not for rendering text. - /// Prefer using DrawText over this method if possible, it handles issues on older - /// platforms properly. Ideally, we should remove this method but to avoid issues at this - /// point I'm leaving it here. + /// This method is currently used just for drawing the text background + /// (ComponentEditorForm.cs) and not for rendering text. + /// Prefer using DrawText over this method if possible, it handles issues on older + /// platforms properly. Ideally, we should remove this method but to avoid issues at this + /// point I'm leaving it here. /// [DllImport(ExternDll.Gdi32, SetLastError = true, ExactSpelling = false, CharSet = CharSet.Auto)] internal static extern bool ExtTextOut(HandleRef hdc, int x, int y, int options, ref Interop.RECT rect, string str, int length, int[] spacing); diff --git a/src/System.Windows.Forms/src/misc/GDI/WindowsFontQuality.cs b/src/System.Windows.Forms/src/misc/GDI/WindowsFontQuality.cs index c2ed9bb0d9d..3b7f0a9c9d6 100644 --- a/src/System.Windows.Forms/src/misc/GDI/WindowsFontQuality.cs +++ b/src/System.Windows.Forms/src/misc/GDI/WindowsFontQuality.cs @@ -9,43 +9,43 @@ namespace System.Windows.Forms.Internal /// internal enum WindowsFontQuality { - /// Appearance of the font does not matter. + /// Appearance of the font does not matter. Default = IntNativeMethods.DEFAULT_QUALITY, - /// Appearance of the font is less important than when PROOF_QUALITY is used. - /// For GDI raster fonts, scaling is enabled, which means that more font sizes are available, - /// but the quality may be lower. Bold, italic, underline, and strikeout fonts are synthesized if necessary. + /// Appearance of the font is less important than when PROOF_QUALITY is used. + /// For GDI raster fonts, scaling is enabled, which means that more font sizes are available, + /// but the quality may be lower. Bold, italic, underline, and strikeout fonts are synthesized if necessary. Draft = IntNativeMethods.DRAFT_QUALITY, - /// Character quality of the font is more important than exact matching of the logical-font attributes. - /// For GDI raster fonts, scaling is disabled and the font closest in size is chosen. - /// Although the chosen font size may not be mapped exactly when PROOF_QUALITY is used, the quality of - /// the font is high and there is no distortion of appearance. Bold, italic, underline, and strikeout - /// fonts are synthesized if necessary. + /// Character quality of the font is more important than exact matching of the logical-font attributes. + /// For GDI raster fonts, scaling is disabled and the font closest in size is chosen. + /// Although the chosen font size may not be mapped exactly when PROOF_QUALITY is used, the quality of + /// the font is high and there is no distortion of appearance. Bold, italic, underline, and strikeout + /// fonts are synthesized if necessary. Proof = IntNativeMethods.PROOF_QUALITY, /// - /// Font is never antialiased. + /// Font is never antialiased. /// NonAntiAliased = IntNativeMethods.NONANTIALIASED_QUALITY, /// - /// Font is always antialiased if the font supports it and the size of the font is not - /// too small or too large. + /// Font is always antialiased if the font supports it and the size of the font is not + /// too small or too large. /// AntiAliased = IntNativeMethods.ANTIALIASED_QUALITY, /// - /// The following situations do not support ClearType antialiasing: - /// - Text is rendered on a printer. - /// - Display set for 256 colors or less. - /// - Text is rendered to a terminal server client. - /// - The font is not a TrueType font or an OpenType font with TrueType outlines. + /// The following situations do not support ClearType antialiasing: + /// - Text is rendered on a printer. + /// - Display set for 256 colors or less. + /// - Text is rendered to a terminal server client. + /// - The font is not a TrueType font or an OpenType font with TrueType outlines. /// For example, the following do not support ClearType antialiasing: /// Type 1 fonts, Postscript OpenType fonts without TrueType outlines, bitmap fonts, vector fonts, and device fonts. - /// - The font has tuned embedded bitmaps, for any font sizes that contain the embedded bitmaps. + /// - The font has tuned embedded bitmaps, for any font sizes that contain the embedded bitmaps. /// For example, this occurs commonly in East Asian fonts. - /// If set, text is rendered (when possible) using ClearType antialiasing method. + /// If set, text is rendered (when possible) using ClearType antialiasing method. /// ClearType = IntNativeMethods.CLEARTYPE_QUALITY, diff --git a/src/System.Windows.Forms/src/misc/GDI/WindowsGraphics2.cs b/src/System.Windows.Forms/src/misc/GDI/WindowsGraphics2.cs index b22d1b4def9..de9755d9964 100644 --- a/src/System.Windows.Forms/src/misc/GDI/WindowsGraphics2.cs +++ b/src/System.Windows.Forms/src/misc/GDI/WindowsGraphics2.cs @@ -43,7 +43,7 @@ public TextPaddingOptions TextPadding } } - /// Drawing methods. + /// Drawing methods. public unsafe void DrawPie(WindowsPen pen, Rectangle bounds, float startAngle, float sweepAngle) { @@ -101,9 +101,8 @@ public void DrawAndFillEllipse(WindowsPen pen, WindowsBrush brush, Rectangle bou DrawEllipse(pen, brush, bounds.Left, bounds.Top, bounds.Right, bounds.Bottom); } - /// Text rendering methods + /// Text rendering methods /// - /// /// Draws the text at the specified point, using the given Font and foreColor. /// CR/LF are honored. diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls1.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls1.Designer.cs index 6450eea1bda..c31b29d8212 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls1.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls1.Designer.cs @@ -3,12 +3,12 @@ partial class Commontrol1 { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls2.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls2.Designer.cs index 5a9bb13b941..e7d9556645b 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls2.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/CommonControls2.Designer.cs @@ -3,12 +3,12 @@ partial class CommonControl2 { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/ContainersTesting.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/ContainersTesting.Designer.cs index 5d6d4a16e8a..1704c138ff5 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/ContainersTesting.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/ContainersTesting.Designer.cs @@ -3,12 +3,12 @@ partial class ContainersTesting { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/DataControls.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/DataControls.Designer.cs index dfc5ae630d1..ef3ed08a651 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/DataControls.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/DataControls.Designer.cs @@ -3,12 +3,12 @@ partial class DataControls { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/DialogsTesting.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/DialogsTesting.Designer.cs index 0e5dd174e45..05725d970d4 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/DialogsTesting.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/DialogsTesting.Designer.cs @@ -3,12 +3,12 @@ partial class DialogsTesting { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/Main.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/Main.Designer.cs index 4369320e974..1959bcd34ca 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/Main.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/Main.Designer.cs @@ -3,12 +3,12 @@ partial class Main { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/MenuForm.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/MenuForm.Designer.cs index ce53b8752ba..2398a81823c 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/MenuForm.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/MenuForm.Designer.cs @@ -3,12 +3,12 @@ partial class MenuForm { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/PrintingTesting.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/PrintingTesting.Designer.cs index 6bfea4eeeca..590e2f9bd62 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/PrintingTesting.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/PrintingTesting.Designer.cs @@ -3,12 +3,12 @@ partial class PrintingTesting { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/Program.cs b/src/System.Windows.Forms/tests/AccessibilityTests/Program.cs index c9ed93ab506..a80ddfe18d4 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/Program.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/Program.cs @@ -10,7 +10,7 @@ namespace AccessibilityTests static class Program { /// - /// The main entry point for the application. + /// The main entry point for the application. /// [STAThread] static void Main() diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/RemainingControls.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/RemainingControls.Designer.cs index da3a1d641df..d0232b83445 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/RemainingControls.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/RemainingControls.Designer.cs @@ -3,12 +3,12 @@ partial class RemainingControls { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/StripControls.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/StripControls.Designer.cs index 2fbb5f625dc..e517ca4ae92 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/StripControls.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/StripControls.Designer.cs @@ -3,12 +3,12 @@ partial class StripControls { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/AccessibilityTests/ToolStripContainer.Designer.cs b/src/System.Windows.Forms/tests/AccessibilityTests/ToolStripContainer.Designer.cs index 6b6ac5bfa7b..8b46f47295e 100644 --- a/src/System.Windows.Forms/tests/AccessibilityTests/ToolStripContainer.Designer.cs +++ b/src/System.Windows.Forms/tests/AccessibilityTests/ToolStripContainer.Designer.cs @@ -3,12 +3,12 @@ partial class ToolStripContainer { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -23,8 +23,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.IntegrationTests.Common/TestHelpers.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.IntegrationTests.Common/TestHelpers.cs index 51b20b95105..dc1c495cce9 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.IntegrationTests.Common/TestHelpers.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.IntegrationTests.Common/TestHelpers.cs @@ -14,7 +14,7 @@ namespace System.Windows.Forms.IntegrationTests.Common public static class TestHelpers { /// - /// Gets the current config + /// Gets the current config /// private static string Config { @@ -29,8 +29,8 @@ private static string Config } /// - /// Get the output exe path for a specified project. - /// Throws an exception if the path does not exist + /// Get the output exe path for a specified project. + /// Throws an exception if the path does not exist /// /// The name of the project /// The exe path @@ -49,10 +49,10 @@ public static string GetExePath(string projectName) } /// - /// Start a process with the specified path. - /// Also searches for a local .dotnet folder and adds it to the path. - /// If a local folder is not found, searches for a machine-wide install that matches - /// the version specified in the global.json. + /// Start a process with the specified path. + /// Also searches for a local .dotnet folder and adds it to the path. + /// If a local folder is not found, searches for a machine-wide install that matches + /// the version specified in the global.json. /// /// The path to the file to execute /// Set the current working directory to the process path @@ -91,7 +91,7 @@ public static Process StartProcess(string path, bool setCwd = false) } /// - /// Get the path where dotnet is installed + /// Get the path where dotnet is installed /// /// The full path of the folder containing the dotnet.exe private static string GetDotNetPath() @@ -113,16 +113,16 @@ private static string GetDotNetPath() } /// - /// Get the path of the globally installed dotnet that matches the version specified in the global.json + /// Get the path of the globally installed dotnet that matches the version specified in the global.json /// - /// The file looks something like this: + /// The file looks something like this: /// - /// { + /// { /// "tools": { /// "dotnet": "3.0.100-preview5-011568" /// }, /// - /// All we care about is the dotnet entry under tools + /// All we care about is the dotnet entry under tools /// /// The path to the globally installed dotnet that matches the version specified in the global.json. private static string GetGlobalDotNetPath() @@ -163,7 +163,7 @@ private static string GetGlobalDotNetPath() } /// - /// Get the full path to the root of the repository + /// Get the full path to the root of the repository /// /// The repo root private static string GetRepoRoot() @@ -174,7 +174,7 @@ private static string GetRepoRoot() } /// - /// Looks backwards form the current executing directory until it finds a sibling directory seek, then returns the full path of that sibling + /// Looks backwards form the current executing directory until it finds a sibling directory seek, then returns the full path of that sibling /// /// The sibling directory to look for /// The full path of the first sibling directory by the current executing directory, away from the root @@ -202,7 +202,7 @@ private static string RelativePathBackwardsUntilFind(string seek) } /// - /// Presses Enter on the given process if it can be made the foreground process + /// Presses Enter on the given process if it can be made the foreground process /// /// The process to send the Enter key to /// Whether or not the Enter key was pressed on the process @@ -213,7 +213,7 @@ public static bool PressEnterOnProcess(Process process) } /// - /// Presses Tab on the given process if it can be made the foreground process + /// Presses Tab on the given process if it can be made the foreground process /// /// The process to send the Tab key to /// Whether or not the Tab key was pressed on the process @@ -224,7 +224,7 @@ public static bool PressTabOnProcess(Process process) } /// - /// Presses Right on the given process if it can be made the foreground process + /// Presses Right on the given process if it can be made the foreground process /// /// The process to send the Right key to /// Whether or not the Right key was pressed on the process @@ -235,7 +235,7 @@ public static bool PressRightOnProcess(Process process) } /// - /// Presses Down on the given process if it can be made the foreground process + /// Presses Down on the given process if it can be made the foreground process /// /// The process to send the Down key to /// Whether or not the Down key was pressed on the process @@ -246,7 +246,7 @@ public static bool PressDownOnProcess(Process process) } /// - /// Presses Left on the given process if it can be made the foreground process + /// Presses Left on the given process if it can be made the foreground process /// /// The process to send the Left key to /// Whether or not the Left key was pressed on the process @@ -257,7 +257,7 @@ public static bool PressLeftOnProcess(Process process) } /// - /// Presses Up on the given process if it can be made the foreground process + /// Presses Up on the given process if it can be made the foreground process /// /// The process to send the Up key to /// Whether or not the Up key was pressed on the process @@ -268,7 +268,7 @@ public static bool PressUpOnProcess(Process process) } /// - /// Presses Tab any number of times on the given process if it can be made the foreground process + /// Presses Tab any number of times on the given process if it can be made the foreground process /// /// The process to send the Tab key(s) to /// The number of times to press tab in a row @@ -297,7 +297,7 @@ public static bool PressTabsOnProcess(Process process, int times) } /// - /// Bring the specified form to the foreground + /// Bring the specified form to the foreground /// /// The form public static void BringToForeground(this Form form) @@ -311,7 +311,7 @@ public static void BringToForeground(this Form form) } /// - /// Set the culture for the current thread + /// Set the culture for the current thread /// /// The culture public static void SetCulture(this Thread thread, string culture) @@ -325,7 +325,7 @@ public static void SetCulture(this Thread thread, string culture) } /// - /// Presses the given keys on the given process, then waits 200ms + /// Presses the given keys on the given process, then waits 200ms /// /// The process to send the key(s) to /// The key(s) to send to the process diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiDataAttribute.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiDataAttribute.cs index 2fd8214bf83..144a0533382 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiDataAttribute.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiDataAttribute.cs @@ -11,20 +11,20 @@ namespace System.Windows.Forms.Maui.IntegrationTests { /// - /// This is a custom xUnit memberdata attribute which allows us to execute code - /// before the data is resolved. It's needed because we want to read scenario names from - /// test results while still being able to use memberdata to parameterize the xUnit test, - /// but the normal MemberData attribute resolves before anything else (even the constructor) - /// is invoked. + /// This is a custom xUnit memberdata attribute which allows us to execute code + /// before the data is resolved. It's needed because we want to read scenario names from + /// test results while still being able to use memberdata to parameterize the xUnit test, + /// but the normal MemberData attribute resolves before anything else (even the constructor) + /// is invoked. /// - /// This code is based on an example at https://tpodolak.com/blog/2017/06/19/xunit-memberdataattribute-generic-type-inheritance/ + /// This code is based on an example at https://tpodolak.com/blog/2017/06/19/xunit-memberdataattribute-generic-type-inheritance/ /// [DataDiscoverer("Xunit.Sdk.MemberDataDiscoverer", "xunit.core")] [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] public class MauiDataAttribute : MemberDataAttributeBase { /// - /// The name of the maui test project to get scenarios for + /// The name of the maui test project to get scenarios for /// private readonly string _projectName; @@ -43,9 +43,9 @@ public MauiDataAttribute(string projectName) : base(null, null) } /// - /// This is the method that actually returns the data that will be parameterized into the - /// xUnit test method. We actually don't use the base class logic at all, - /// we just get the scenarios for the specified project name and return them. + /// This is the method that actually returns the data that will be parameterized into the + /// xUnit test method. We actually don't use the base class logic at all, + /// we just get the scenarios for the specified project name and return them. /// /// MethodInfo of the method being decorated /// The test data @@ -59,7 +59,7 @@ public override IEnumerable GetData(MethodInfo testMethod) } /// - /// Required to derive from MemberDataAttributeBase + /// Required to derive from MemberDataAttributeBase /// /// MethodInfo of the method being decorated /// The item representing a single line of data diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestHelper.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestHelper.cs index 784ca9f86d7..ae7b9289aa4 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestHelper.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestHelper.cs @@ -12,22 +12,22 @@ namespace System.Windows.Forms.Maui.IntegrationTests { /// - /// This class performs common operations for maui xUnit tests. + /// This class performs common operations for maui xUnit tests. /// public static class MauiTestHelper { /// - /// The test runner + /// The test runner /// private static readonly MauiTestRunner s_testRunner = new MauiTestRunner(); /// - /// The test results, indexed by project name + /// The test results, indexed by project name /// private static readonly Dictionary s_testResults = new Dictionary(); /// - /// Get the scenarios that will run for a specified maui project + /// Get the scenarios that will run for a specified maui project /// /// The project /// The scenarios that ran @@ -71,7 +71,7 @@ public static IEnumerable GetScenarios(string projectName) } /// - /// Validate a specified scenario passed. + /// Validate a specified scenario passed. /// /// The name of the maui project /// The name of the scenario @@ -90,7 +90,7 @@ public static void ValidateScenarioPassed(string projectName, string scenarioNam } /// - /// Run the maui test for the specified project name and store the results + /// Run the maui test for the specified project name and store the results /// /// The name of the project to run private static void RunMauiTest(string projectName) diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestRunner.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestRunner.cs index 10a0dff1660..97cd17d7b38 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestRunner.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/MauiTestRunner.cs @@ -9,16 +9,16 @@ namespace System.Windows.Forms.Maui.IntegrationTests { /// - /// This class is used to run maui tests (exe) and gather the results. - /// Maui tests are executables that run one or more scenarios, and the results are - /// stored in a results.log. This class handles running the exe, deserializing the log - /// into a TestCase object, and returning that object to the caller. + /// This class is used to run maui tests (exe) and gather the results. + /// Maui tests are executables that run one or more scenarios, and the results are + /// stored in a results.log. This class handles running the exe, deserializing the log + /// into a TestCase object, and returning that object to the caller. /// /// public class MauiTestRunner { /// - /// Run a Maui test at the specified path and return the results + /// Run a Maui test at the specified path and return the results /// /// The path to execute /// The test results diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiButtonTests.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiButtonTests.cs index b9c4c27b582..81f85e1245e 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiButtonTests.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiButtonTests.cs @@ -7,20 +7,20 @@ namespace System.Windows.Forms.Maui.IntegrationTests { /// - /// This class runs a maui executable, which contains one or more scenarios. + /// This class runs a maui executable, which contains one or more scenarios. /// - /// We want to be able to represent each scenario as a seperate xUnit test, but it's not - /// possible to run them independently. The workaround is to have a MauiTestRunner execute all - /// the scenarios once and store the results, then feed the scenario names in as member data. + /// We want to be able to represent each scenario as a seperate xUnit test, but it's not + /// possible to run them independently. The workaround is to have a MauiTestRunner execute all + /// the scenarios once and store the results, then feed the scenario names in as member data. /// - /// However, MemberData is resolved before any constructors (even static) are called. - /// This means the scenario names will not be available yet. + /// However, MemberData is resolved before any constructors (even static) are called. + /// This means the scenario names will not be available yet. /// - /// The solution to this is to inherit from MemberDataAttribute and execute custom code - /// (running the maui test) before returning the expected data. See MauiMemberDataAttribute.cs for more info. + /// The solution to this is to inherit from MemberDataAttribute and execute custom code + /// (running the maui test) before returning the expected data. See MauiMemberDataAttribute.cs for more info. /// - /// Also [Collection("Maui")] is used put all maui tests in the same collection, which makes them run sequentially - /// instead of in parallel. This is to migitate race conditions of multiple forms open at once. + /// Also [Collection("Maui")] is used put all maui tests in the same collection, which makes them run sequentially + /// instead of in parallel. This is to migitate race conditions of multiple forms open at once. /// [Collection("Maui")] public class WinformsMauiButtonTests diff --git a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiComboBoxTests.cs b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiComboBoxTests.cs index 1455266e411..582e686d1a2 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiComboBoxTests.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/System.Windows.Forms.Maui.IntegrationTests/WinformsMauiComboBoxTests.cs @@ -7,20 +7,20 @@ namespace System.Windows.Forms.Maui.IntegrationTests { /// - /// This class runs a maui executable, which contains one or more scenarios. + /// This class runs a maui executable, which contains one or more scenarios. /// - /// We want to be able to represent each scenario as a seperate xUnit test, but it's not - /// possible to run them independently. The workaround is to have a MauiTestRunner execute all - /// the scenarios once and store the results, then feed the scenario names in as member data. + /// We want to be able to represent each scenario as a seperate xUnit test, but it's not + /// possible to run them independently. The workaround is to have a MauiTestRunner execute all + /// the scenarios once and store the results, then feed the scenario names in as member data. /// - /// However, MemberData is resolved before any constructors (even static) are called. - /// This means the scenario names will not be available yet. + /// However, MemberData is resolved before any constructors (even static) are called. + /// This means the scenario names will not be available yet. /// - /// The solution to this is to inherit from MemberDataAttribute and execute custom code - /// (running the maui test) before returning the expected data. See MauiMemberDataAttribute.cs for more info. + /// The solution to this is to inherit from MemberDataAttribute and execute custom code + /// (running the maui test) before returning the expected data. See MauiMemberDataAttribute.cs for more info. /// - /// Also [Collection("Maui")] is used put all maui tests in the same collection, which makes them run sequentially - /// instead of in parallel. This is to migitate race conditions of multiple forms open at once. + /// Also [Collection("Maui")] is used put all maui tests in the same collection, which makes them run sequentially + /// instead of in parallel. This is to migitate race conditions of multiple forms open at once. /// [Collection("Maui")] public class WinformsMauiComboBoxTests diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Mocks/CollectionEditor.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Mocks/CollectionEditor.cs index c46caa1d229..13ccafee947 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Mocks/CollectionEditor.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Mocks/CollectionEditor.cs @@ -7,7 +7,7 @@ namespace System.ComponentModel.Design { /// - /// Mock for the editor that is not accessible in .NET 4.x + /// Mock for the editor that is not accessible in .NET 4.x /// public class CollectionEditor : UITypeEditor { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Program.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Program.cs index 0eb6646c62c..0603dbe4f4b 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Program.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinFormsControlsClassicTests/Program.cs @@ -11,7 +11,7 @@ namespace WinformsControlsTest static class Program { /// - /// The main entry point for the application. + /// The main entry point for the application. /// [STAThread] static void Main() diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Buttons.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Buttons.Designer.cs index d82e087e43a..9b1a0564887 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Buttons.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Buttons.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class Buttons { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Calendar.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Calendar.Designer.cs index c0ba819c32a..62d646bf6b7 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Calendar.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Calendar.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class Calendar { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ComboBoxes.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ComboBoxes.Designer.cs index b77fefd0be7..6af2ec7d76e 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ComboBoxes.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ComboBoxes.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class ComboBoxes { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DataGridViewHeaders.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DataGridViewHeaders.Designer.cs index 3ee73570a86..880e3461472 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DataGridViewHeaders.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DataGridViewHeaders.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class DataGridViewHeaders { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DateTimePicker.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DateTimePicker.Designer.cs index 3a00c536806..c0443a38fb3 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DateTimePicker.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DateTimePicker.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class DateTimePicker { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DesignTimeAligned.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DesignTimeAligned.Designer.cs index 54ac3c9fa10..ad15b5c1300 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DesignTimeAligned.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/DesignTimeAligned.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class DesignTimeAligned { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ListViewTest.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ListViewTest.Designer.cs index 44aa971eafd..1b82d439f69 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ListViewTest.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ListViewTest.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class ListViewTest { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MDIParent.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MDIParent.Designer.cs index bb923355206..cbc470dbb4a 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MDIParent.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MDIParent.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class MDIParent { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MainForm.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MainForm.Designer.cs index 4078fa1233f..2324787329a 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MainForm.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MainForm.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class MainForm { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MdiChild.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MdiChild.Designer.cs index f0702778f39..e63cb293b84 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MdiChild.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MdiChild.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class MdiChild { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MenuStripAndCheckedListBox.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MenuStripAndCheckedListBox.Designer.cs index cdd874b3f03..68e357170c2 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MenuStripAndCheckedListBox.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MenuStripAndCheckedListBox.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class MenuStripAndCheckedListBox { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MultipleControls.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MultipleControls.Designer.cs index 52447aaee4a..3ce9ed64c6f 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MultipleControls.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/MultipleControls.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class MultipleControls { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Panels.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Panels.Designer.cs index 229fe459486..7058400f622 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Panels.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Panels.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class Panels { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Program.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Program.cs index 8fb1b592a21..3b3bec6f36c 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Program.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Program.cs @@ -12,7 +12,7 @@ namespace WinformsControlsTest static class Program { /// - /// The main entry point for the application. + /// The main entry point for the application. /// [STAThread] static void Main() diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/PropertyGrid.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/PropertyGrid.Designer.cs index 5d0bd1ce5a1..be159199219 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/PropertyGrid.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/PropertyGrid.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class PropertyGrid { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ScalingBeforeChanges.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ScalingBeforeChanges.Designer.cs index b7f086fac41..4990c6c7222 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ScalingBeforeChanges.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/ScalingBeforeChanges.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class ScalingBeforeChanges { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Splitter.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Splitter.Designer.cs index c770b3bf1e2..76c1f13a99c 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Splitter.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/Splitter.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class Splitter { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/TreeViewTest.Designer.cs b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/TreeViewTest.Designer.cs index 90f63af5419..18b24d6ae3f 100644 --- a/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/TreeViewTest.Designer.cs +++ b/src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/TreeViewTest.Designer.cs @@ -7,12 +7,12 @@ namespace WinformsControlsTest partial class TreeViewTest { /// - /// Required designer variable. + /// Required designer variable. /// private System.ComponentModel.IContainer components = null; /// - /// Clean up any resources being used. + /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) @@ -27,8 +27,8 @@ protected override void Dispose(bool disposing) #region Windows Form Designer generated code /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. /// private void InitializeComponent() { diff --git a/src/System.Windows.Forms/tests/UnitTests/ButtonTests.cs b/src/System.Windows.Forms/tests/UnitTests/ButtonTests.cs index a70cd093c5d..cdecb39dd0b 100644 --- a/src/System.Windows.Forms/tests/UnitTests/ButtonTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/ButtonTests.cs @@ -21,7 +21,7 @@ public void Button_Constructor() } /// - /// Data for the AutoSizeModeGetSet test + /// Data for the AutoSizeModeGetSet test /// public static TheoryData AutoSizeModeGetSetData => CommonTestHelper.GetEnumTheoryData(); @@ -39,7 +39,7 @@ public void Button_AutoSizeModeGetSet(AutoSizeMode expected) } /// - /// Data for the AutoSizeModeGetSetInvalid test + /// Data for the AutoSizeModeGetSetInvalid test /// public static TheoryData AutoSizeModeGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -98,7 +98,7 @@ public void Button_GetPreferredSizeCore(Button button, Size proposed, Size expec } /// - /// Data for the DialogResultGetSet test + /// Data for the DialogResultGetSet test /// public static TheoryData DialogResultGetSetData => CommonTestHelper.GetEnumTheoryData(); @@ -116,7 +116,7 @@ public void Button_DialogResultGetSet(DialogResult expected) } /// - /// Data for the DialogResultGetSetInvalid test + /// Data for the DialogResultGetSetInvalid test /// public static TheoryData DialogResultGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -133,7 +133,7 @@ public void Button_DialogResultGetSetInvalid(DialogResult expected) } /// - /// Data for the NotifyDefault test + /// Data for the NotifyDefault test /// public static TheoryData NotifyDefaultData => CommonTestHelper.GetBoolTheoryData(); diff --git a/src/System.Windows.Forms/tests/UnitTests/CheckBoxTests.cs b/src/System.Windows.Forms/tests/UnitTests/CheckBoxTests.cs index cd2da51704a..2186feebc23 100644 --- a/src/System.Windows.Forms/tests/UnitTests/CheckBoxTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/CheckBoxTests.cs @@ -23,7 +23,7 @@ public void CheckBox_Constructor() } /// - /// Data for the AppearanceGetSet test + /// Data for the AppearanceGetSet test /// public static TheoryData AppearanceGetSetData => CommonTestHelper.GetEnumTheoryData(); @@ -41,7 +41,7 @@ public void CheckBox_AutoSizeModeGetSet(Appearance expected) } /// - /// Data for the AppearanceGetSetInvalid test + /// Data for the AppearanceGetSetInvalid test /// public static TheoryData AppearanceGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -57,7 +57,7 @@ public void CheckBox_AppearanceGetSetInvalid(Appearance expected) } /// - /// Data for the AutoCheck test + /// Data for the AutoCheck test /// public static TheoryData AutoCheckData => CommonTestHelper.GetBoolTheoryData(); @@ -75,7 +75,7 @@ public void CheckBox_AutoCheck(bool expected) } /// - /// Data for the ContentAlignmentGetSet test + /// Data for the ContentAlignmentGetSet test /// public static TheoryData ContentAlignmentGetSetData => CommonTestHelper.GetEnumTheoryData(); @@ -95,7 +95,7 @@ public void CheckBox_ContentAlignmentGetSet(ContentAlignment expected) } /// - /// Data for the ContentAlignmentGetSetInvalid test + /// Data for the ContentAlignmentGetSetInvalid test /// public static TheoryData ContentAlignmentGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -124,7 +124,7 @@ public void CheckBox_CheckedGetSet(bool sent, CheckState expected) } /// - /// Data for the CheckStateGetSet test + /// Data for the CheckStateGetSet test /// public static TheoryData CheckStateGetSetData => CommonTestHelper.GetEnumTheoryData(); @@ -142,7 +142,7 @@ public void CheckBox_CheckStateGetSet(CheckState expected) } /// - /// Data for the CheckStateGetSetInvalid test + /// Data for the CheckStateGetSetInvalid test /// public static TheoryData CheckStateGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -158,7 +158,7 @@ public void CheckBox_CheckStateGetSetInvalid(CheckState expected) } /// - /// Data for the ThreeState test + /// Data for the ThreeState test /// public static TheoryData ThreeStateData => CommonTestHelper.GetBoolTheoryData(); diff --git a/src/System.Windows.Forms/tests/UnitTests/CheckedListBoxTests.cs b/src/System.Windows.Forms/tests/UnitTests/CheckedListBoxTests.cs index ed377366240..cbbecd6ac76 100644 --- a/src/System.Windows.Forms/tests/UnitTests/CheckedListBoxTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/CheckedListBoxTests.cs @@ -19,7 +19,7 @@ public void CheckedListBox_Constructor() } /// - /// Data for the CheckOnClick test + /// Data for the CheckOnClick test /// public static TheoryData CheckOnClickData => CommonTestHelper.GetBoolTheoryData(); @@ -57,7 +57,7 @@ public void CheckedListBox_CheckedItemCollectionNotNull() } /// - /// Data for the DisplayMember test + /// Data for the DisplayMember test /// public static TheoryData DisplayMemberData => CommonTestHelper.GetStringTheoryData(); @@ -108,7 +108,7 @@ public void CheckedListBox_SelectionModeGetSetInvalidFromEnum(SelectionMode expe } /// - /// Data for the SelectionModeGetSetInvalid test + /// Data for the SelectionModeGetSetInvalid test /// public static TheoryData SelectionModeGetSetInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -124,7 +124,7 @@ public void CheckedListBox_CheckStateGetSetInvalid(SelectionMode expected) } /// - /// Data for the ThreeDCheckBoxes test + /// Data for the ThreeDCheckBoxes test /// public static TheoryData ThreeDCheckBoxesData => CommonTestHelper.GetBoolTheoryData(); @@ -142,7 +142,7 @@ public void CheckedListBox_ThreeDCheckBoxes(bool expected) } /// - /// Data for the ValueMember test + /// Data for the ValueMember test /// public static TheoryData ValueMemberData => CommonTestHelper.GetStringTheoryData(); @@ -199,7 +199,7 @@ public void CheckedListBox_SetItemCheckStateOutOfRange(int index) } /// - /// Data for the SetItemCheckState test + /// Data for the SetItemCheckState test /// public static TheoryData SetItemCheckStateData => CommonTestHelper.GetEnumTheoryData(); @@ -217,7 +217,7 @@ public void CheckedListBox_SetItemCheckState(CheckState expected) } /// - /// Data for the SetItemCheckStateInvalid test + /// Data for the SetItemCheckStateInvalid test /// public static TheoryData SetItemCheckStateInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); diff --git a/src/System.Windows.Forms/tests/UnitTests/CommonUnsafeNativeMethodsTests.cs b/src/System.Windows.Forms/tests/UnitTests/CommonUnsafeNativeMethodsTests.cs index 1aec0b3f542..55a2f748394 100644 --- a/src/System.Windows.Forms/tests/UnitTests/CommonUnsafeNativeMethodsTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/CommonUnsafeNativeMethodsTests.cs @@ -10,7 +10,7 @@ namespace System.Windows.Forms.Tests public class CommonUnsafeNativeMethodsTests { /*/// - /// Data for the TryFindDpiAwarenessContextsEqual test + /// Data for the TryFindDpiAwarenessContextsEqual test /// public static TheoryData TryFindDpiAwarenessContextsEqualData => CommonTestHelper.GetEnumTheoryData(); @@ -31,7 +31,7 @@ public void CommonUnsafeNativeMethods_AreDpiAwarenessContextsEqualNotForUnspecif } /// - /// Data for the TrySetThreadDpiAwarenessContextGetSet test + /// Data for the TrySetThreadDpiAwarenessContextGetSet test /// public static TheoryData TrySetThreadDpiAwarenessContextGetSetData => CommonTestHelper.GetEnumTheoryData(); diff --git a/src/System.Windows.Forms/tests/UnitTests/DpiHelperTests.cs b/src/System.Windows.Forms/tests/UnitTests/DpiHelperTests.cs index bd993771c44..e62f073acaa 100644 --- a/src/System.Windows.Forms/tests/UnitTests/DpiHelperTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/DpiHelperTests.cs @@ -11,7 +11,7 @@ namespace System.Windows.Forms.Tests public class DpiHelperTests { /// - /// Data for the LogicalToDeviceUnits test + /// Data for the LogicalToDeviceUnits test /// public static TheoryData LogicalToDeviceUnitsData => CommonTestHelper.GetIntTheoryData(); diff --git a/src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ControlTests.cs b/src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ControlTests.cs index 2e62bf5b9c5..80dc5bf7955 100644 --- a/src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ControlTests.cs +++ b/src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ControlTests.cs @@ -396,7 +396,7 @@ public void Control_CreateControl() } /// - /// Data for the CreateControlInternal test + /// Data for the CreateControlInternal test /// public static TheoryData CreateControlInternalData => CommonTestHelper.GetBoolTheoryData(); @@ -1174,7 +1174,7 @@ public void Control_AccessibleNameGetSet() } /// - /// Data for the AccessibleRole test + /// Data for the AccessibleRole test /// public static TheoryData AccessibleRoleData => CommonTestHelper.GetEnumTheoryData(); @@ -1192,7 +1192,7 @@ public void Control_SetItemCheckState(AccessibleRole expected) } /// - /// Data for the AccessibleRoleInvalid test + /// Data for the AccessibleRoleInvalid test /// public static TheoryData AccessibleRoleInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -1208,7 +1208,7 @@ public void Control_AccessibleRoleInvalid(AccessibleRole expected) } /// - /// Data for the IsAccessibleGetSet test + /// Data for the IsAccessibleGetSet test /// public static TheoryData IsAccessibleGetSetData => CommonTestHelper.GetBoolTheoryData(); @@ -1648,7 +1648,7 @@ public void Control_PreferedSizeGet() #region ApplySizeConstraints /// - /// Data for the ApplySizeConstraints test + /// Data for the ApplySizeConstraints test /// public static TheoryData ApplySizeConstraintsData => CommonTestHelper.GetIntTheoryData(); @@ -1679,7 +1679,7 @@ public void Control_ApplySizeConstraintsSize_Invoke_ReturnsExpected(Size expecte #region ApplyBoundsConstraints /// - /// Data for the ApplyBoundsConstraints test + /// Data for the ApplyBoundsConstraints test /// public static TheoryData ApplyBoundsConstraintsData => CommonTestHelper.GetIntTheoryData(); @@ -1835,7 +1835,7 @@ public void Control_BoundsGetSet() } /// - /// Data for the HeightGetSet test + /// Data for the HeightGetSet test /// public static TheoryData HeightGetSetData => CommonTestHelper.GetIntTheoryData(); @@ -1853,7 +1853,7 @@ public void Control_HeightGetSet(int expected) } /// - /// Data for the LeftGetSet test + /// Data for the LeftGetSet test /// public static TheoryData LeftGetSetData => CommonTestHelper.GetIntTheoryData(); @@ -1871,7 +1871,7 @@ public void Control_LeftGetSet(int expected) } /// - /// Data for the TopGetSet test + /// Data for the TopGetSet test /// public static TheoryData TopGetSetData => CommonTestHelper.GetIntTheoryData(); @@ -2200,7 +2200,7 @@ public void Control_SizeGetSet(Size value) } /// - /// Data for the WidthGetSet test + /// Data for the WidthGetSet test /// public static TheoryData WidthGetSetData => CommonTestHelper.GetIntTheoryData(); @@ -2759,7 +2759,7 @@ public void Control_Text_SetWithHandler_CallsTextChanged() #region Capture /// - /// Data for the CaptureGetSet test + /// Data for the CaptureGetSet test /// public static TheoryData CaptureGetSetData => CommonTestHelper.GetBoolTheoryData(); @@ -2777,7 +2777,7 @@ public void Control_CaptureGetSet(bool expected) } /// - /// Data for the CaptureInternalGetSet test + /// Data for the CaptureInternalGetSet test /// public static TheoryData CaptureInternalGetSetData => CommonTestHelper.GetBoolTheoryData(); @@ -2905,7 +2905,7 @@ public void Control_FindFormWithoutParent_ReturnsNull() #region GetChildAtPoint /// - /// Data for the GetChildAtPointNull test + /// Data for the GetChildAtPointNull test /// public static TheoryData GetChildAtPointNullData => CommonTestHelper.GetEnumTheoryData(); @@ -2922,7 +2922,7 @@ public void Control_GetChildAtPointNull(GetChildAtPointSkip skip) } /// - /// Data for the GetChildAtPointInvalid test + /// Data for the GetChildAtPointInvalid test /// public static TheoryData GetChildAtPointInvalidData => CommonTestHelper.GetEnumTheoryDataInvalid(); @@ -2962,7 +2962,7 @@ public void Control_GetHandleInternalShouldBeZero() } /// - /// Data for the DoDragDrop test + /// Data for the DoDragDrop test /// public static TheoryData DoDragDropData => CommonTestHelper.GetEnumTheoryData(); @@ -3368,7 +3368,7 @@ public void Control_Site_SetWithAmbientPropertiesSet_DoesNotUpdate() } /// - /// Data for the UseWaitCursorGetSet test + /// Data for the UseWaitCursorGetSet test /// public static TheoryData UseWaitCursorGetSetData => CommonTestHelper.GetBoolTheoryData(); @@ -3665,7 +3665,7 @@ public void Control_ContextMenuStripGetSet() } /// - /// Data for the ValidationCancelledGetSet test + /// Data for the ValidationCancelledGetSet test /// public static TheoryData ValidationCancelledGetSetData => CommonTestHelper.GetBoolTheoryData(); @@ -3683,7 +3683,7 @@ public void Control_ValidationCancelledGetSet(bool expected) } /// - /// Data for the IsTopMdiWindowClosingGetSet test + /// Data for the IsTopMdiWindowClosingGetSet test /// public static TheoryData IsTopMdiWindowClosingGetSetData => CommonTestHelper.GetBoolTheoryData();