From fb9307e36112b2437eaf6cd12f8500c68906a867 Mon Sep 17 00:00:00 2001 From: SimpleSamples Date: Fri, 2 Mar 2018 17:29:33 -0800 Subject: [PATCH 1/5] Update RunWorkerCompletedEventArgs.xml --- xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml index 241fc3b100c61..91179f1e1e3af 100644 --- a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml +++ b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml @@ -26,6 +26,8 @@ is an example of the name of such a method. If you add an instance of the delegate to the event, you will receive information about the outcome of asynchronous operations in the parameter of the corresponding event handler. > [!NOTE] From a3eb065076726288059ae0e94279119881d37767 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 14 Mar 2018 16:19:04 -0700 Subject: [PATCH 2/5] Modifed documentation based on discussion --- xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml index 91179f1e1e3af..0a0bb1ebf6e46 100644 --- a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml +++ b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml @@ -26,15 +26,12 @@ is an example of the name of such a method. If you add an instance of the delegate to the event, you will receive information about the outcome of asynchronous operations in the parameter of the corresponding event handler. +When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the is fired and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. > [!NOTE] > The attribute applied to this class has the following property value: . The does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the class or [SQL Server Programming and Host Protection Attributes](~/docs/framework/performance/sql-server-programming-and-host-protection-attributes.md). - - ## Examples The following code example illustrates the use of . This example is part of a larger sample for the class. From c1a93a636b7ad40d8264c239cede09d071a5a622 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 15 Mar 2018 08:20:55 -0700 Subject: [PATCH 3/5] Changed "fired" to "raised" --- xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml index 0a0bb1ebf6e46..0624e3b1be233 100644 --- a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml +++ b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml @@ -27,7 +27,7 @@ ## Remarks -When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the is fired and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. +When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the is raised and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. > [!NOTE] > The attribute applied to this class has the following property value: . The does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the class or [SQL Server Programming and Host Protection Attributes](~/docs/framework/performance/sql-server-programming-and-host-protection-attributes.md). From 4e5d6395dee15a6a83ec95b6cfdb8c3977946a26 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 15 Mar 2018 11:38:17 -0700 Subject: [PATCH 4/5] Fixed broken links. --- xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml index 0624e3b1be233..efc3c0b04c24d 100644 --- a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml +++ b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml @@ -27,7 +27,7 @@ ## Remarks -When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the is raised and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. +When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the displayProperty=nameWithType> event is raised and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. > [!NOTE] > The attribute applied to this class has the following property value: . The does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the class or [SQL Server Programming and Host Protection Attributes](~/docs/framework/performance/sql-server-programming-and-host-protection-attributes.md). From 869c33dc241a3dcba5bbb84ac16bccb3193f75df Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 20 Mar 2018 10:27:49 -0700 Subject: [PATCH 5/5] Corrected typo. --- xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml index efc3c0b04c24d..8b7c9feecfad1 100644 --- a/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml +++ b/xml/System.ComponentModel/RunWorkerCompletedEventArgs.xml @@ -27,7 +27,7 @@ ## Remarks -When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the displayProperty=nameWithType> event is raised and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. +When using the [event-based asynchronous pattern](~/docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-eap.md) for asynchronous operations, a Windows Forms form or control initiates an asyncronous operation by calling the method. The method in turn raises the event asynchronously and passes it a instance. If the asychronous operation returns a value, the event handler typically assigns it to the property. When the asynchronous operation completes, the event is raised and is passed a instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). If it completed successfully, its property contains the value returned by the asynchronous operation and previously assigned to the property. > [!NOTE] > The attribute applied to this class has the following property value: . The does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the class or [SQL Server Programming and Host Protection Attributes](~/docs/framework/performance/sql-server-programming-and-host-protection-attributes.md).