diff --git a/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs b/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs deleted file mode 100644 index 5947088a605..00000000000 --- a/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs +++ /dev/null @@ -1,98 +0,0 @@ -using System; -using System.Collections.Generic; -using System.ServiceModel; -using System.Workflow.Runtime; -using System.Workflow.Runtime.Hosting; -using System.ServiceModel.Description; -using System.Collections.Specialized; -using System.ServiceModel.Channels; - -namespace ChannelManagerServiceSnippets -{ - class snippets : ServiceHostBase - { - void Container0() - { - //ChannelManagerService.ChannelManagerService - WorkflowRuntime workflowRuntime = new WorkflowRuntime(); - // - // Add ChannelManager. - ChannelManagerService channelmgr = new ChannelManagerService(); - workflowRuntime.AddService(channelmgr); - // - } - void Container1() - { - string contextFileName; - WorkflowRuntime workflowRuntime = new WorkflowRuntime(); - LocalServiceHost localServiceHost = null; - String contextFileExtension = null; - //ChannelManagerService.ChannelManagerService(IList) - // - contextFileName = localServiceHost.Description.ServiceType.Name + contextFileExtension; - - // add local client endpoints - workflowRuntime = this.Description.Behaviors.Find().WorkflowRuntime; - workflowRuntime.AddService(new ChannelManagerService(localServiceHost.ClientEndpoints)); - - localServiceHost.Open(); - - // - } - void Container2() - { - //ChannelManagerService.ChannelManagerService(NameValueCollection) - // - NameValueCollection parameters = new NameValueCollection(); - parameters.Add("idleTimeout", TimeSpan.FromMinutes(10).ToString()); - parameters.Add("leaseTimeout", TimeSpan.FromMinutes(1).ToString()); - parameters.Add("maxIdleChannelsPerEndpoint", "10"); - ChannelManagerService service = new ChannelManagerService(parameters); - // - } - void Container3() - { - //ChannelManagerService.ChannelManagerService(ChannelPoolSettings) - // - ChannelPoolSettings settings = new ChannelPoolSettings(); - settings.IdleTimeout = TimeSpan.FromMinutes(10); - settings.LeaseTimeout = TimeSpan.FromMinutes(1); - settings.MaxOutboundChannelsPerEndpoint = 10; - ChannelManagerService service = new ChannelManagerService(settings); - // - } - void Container4() - { - //ChannelManagerService.ChannelManagerService(ChannelPoolSettings, Ilist) - ContractDescription contractDescription = null; - // - ChannelPoolSettings settings = new ChannelPoolSettings(); - settings.IdleTimeout = TimeSpan.FromMinutes(10); - settings.LeaseTimeout = TimeSpan.FromMinutes(1); - settings.MaxOutboundChannelsPerEndpoint = 10; - IList endpoints = new List(); - endpoints.Add(new ServiceEndpoint(contractDescription)); - ChannelManagerService service = new ChannelManagerService(settings, endpoints); - // - } - - class LocalServiceHost : ServiceHost - { - public LocalServiceHost(object singletonInstance, params Uri[] baseAddresses) - : base(singletonInstance, baseAddresses) - { - } - - IList clientEndpoints = null; - internal IList ClientEndpoints - { - get { return clientEndpoints; } - } - } - - protected override ServiceDescription CreateDescription(out IDictionary implementedContracts) - { - throw new NotImplementedException(); - } - } -} diff --git a/snippets/csharp/VS_Snippets_CFX/freeformactivitydesigner/cs/snippets.cs b/snippets/csharp/VS_Snippets_CFX/freeformactivitydesigner/cs/snippets.cs deleted file mode 100644 index 9ae475a46ca..00000000000 --- a/snippets/csharp/VS_Snippets_CFX/freeformactivitydesigner/cs/snippets.cs +++ /dev/null @@ -1,41 +0,0 @@ -using System; -using System.ComponentModel.Design; -using System.Workflow.ComponentModel; -using System.Workflow.ComponentModel.Design; - -namespace FreeformActivityDesignerSnippets -{ - // - class ProcessActvityDesigner : FreeformActivityDesigner - { - private ConnectionPoint GetConnectionPoint(Activity activity, Int32 connectorIndex, DesignerEdges edge) - { - ActivityDesigner designer = null; - - if (activity != null && activity.Site != null) - { - IDesignerHost designerHost = activity.Site.GetService(typeof(IDesignerHost)) as IDesignerHost; - if (designerHost != null) - designer = designerHost.GetDesigner(activity) as ActivityDesigner; - } - return new ConnectionPoint(designer, edge, connectorIndex); - } - - protected override void OnLayoutPosition(ActivityDesignerLayoutEventArgs e) - { - base.OnLayoutPosition(e); - - // Draw a connector between the first and second activities contained in - // the sequence activity used by this designer - if (this.IsRootDesigner) - { - CompositeActivity parentActivity = (CompositeActivity)this.Activity; - ConnectionPoint sourcePoint = GetConnectionPoint(parentActivity.Activities[0], 1, DesignerEdges.Bottom); - ConnectionPoint targetPoint = GetConnectionPoint(parentActivity.Activities[1], 0, DesignerEdges.Top); - - this.AddConnector(sourcePoint, targetPoint); - } - } - // - } -} diff --git a/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs b/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs deleted file mode 100644 index 0659549c0b4..00000000000 --- a/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs +++ /dev/null @@ -1,94 +0,0 @@ -using System; -using System.ComponentModel; -using System.ComponentModel.Design; -using System.Collections; -using System.Drawing; -using System.Linq; -using System.Workflow.ComponentModel; -using System.Workflow.ComponentModel.Design; -using System.Workflow.ComponentModel.Compiler; -using System.Workflow.ComponentModel.Serialization; -using System.Workflow.Runtime; -using System.Workflow.Activities; -using System.Workflow.Activities.Rules; - -namespace wf_activities_project -{ - // - [ActivityValidator(typeof(ConsoleWriteLineActivityValidator))] - public partial class ConsoleWriteLineActivity : System.Workflow.ComponentModel.Activity - { - public ConsoleWriteLineActivity() - { - InitializeComponent(); - } - - public static DependencyProperty MsgProperty = System.Workflow.ComponentModel.DependencyProperty.Register("Msg", typeof(string), typeof(ConsoleWriteLineActivity)); - - [Browsable(true)] - [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] - public string Msg - { - get - { - return ((string)(base.GetValue(ConsoleWriteLineActivity.MsgProperty))); - } - set - { - base.SetValue(ConsoleWriteLineActivity.MsgProperty, value); - } - } - - protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext) - { - Console.WriteLine(Msg); - return ActivityExecutionStatus.Closed; - } - } - // - - // - class ConsoleWriteLineActivityValidator : ActivityValidator - { - // - public override ValidationErrorCollection Validate(ValidationManager manager, object obj) - { - // Invoke the base class method implementation to - // perform default validation. - ValidationErrorCollection errors = base.Validate(manager, obj); - - // Make sure there is an activity instance. - ConsoleWriteLineActivity crw = obj as ConsoleWriteLineActivity; - if (crw == null) - { - throw new InvalidOperationException(); - } - - // If the activity has no parent then this validation - // is occurring during the compilation of the activity - // and not during the hosting or creation of an - // activity instance. - if (crw.Parent == null) - { - // Can skip the rest of the validation because - // it deals with the hosting and the creation - // of the activity. - return errors; - } - - // Msg is required. Add a validation error if there is no - // Msg specified or Msg is not bound to another property. - if (string.IsNullOrEmpty(crw.Msg) && - crw.GetBinding(ConsoleWriteLineActivity.MsgProperty) == null) - { - // - errors.Add(new ValidationError("Msg is required", 100, false, "Msg")); - // - } - - return errors; - } - // - } - // -} diff --git a/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb b/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb deleted file mode 100644 index 5dd24157d3b..00000000000 --- a/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb +++ /dev/null @@ -1,98 +0,0 @@ -Imports System.Collections.Generic -Imports System.ServiceModel -Imports System.Workflow.Runtime -Imports System.Workflow.Runtime.Hosting -Imports System.ServiceModel.Description -Imports System.Collections.Specialized -Imports System.ServiceModel.Channels - -Namespace ChannelManagerServiceSnippets - Friend Class snippets - Inherits ServiceHostBase - Private Sub Container0() - ' ChannelManagerService.ChannelManagerService. - Dim workflowRuntime As New WorkflowRuntime() - ' - ' Add ChannelManager. - Dim channelmgr As New ChannelManagerService() - workflowRuntime.AddService(channelmgr) - ' - End Sub - Private Sub Container1() - Dim contextFileName As String - Dim workflowRuntime As New WorkflowRuntime() - Dim localServiceHost As LocalServiceHost = Nothing - Dim contextFileExtension As String = Nothing - ' ChannelManagerService.ChannelManagerService(IList). - ' - contextFileName = localServiceHost.Description.ServiceType.Name & contextFileExtension - - ' add local client endpoints. - workflowRuntime = Me.Description.Behaviors.Find(Of WorkflowRuntimeBehavior)().WorkflowRuntime - workflowRuntime.AddService(New ChannelManagerService(localServiceHost.ClientEndpoints)) - - localServiceHost.Open() - - ' - End Sub - Private Sub Container2() - ' ChannelManagerService.ChannelManagerService(NameValueCollection). - ' - Dim parameters As New NameValueCollection() - With parameters - .Add("idleTimeout", TimeSpan.FromMinutes(10).ToString()) - .Add("leaseTimeout", TimeSpan.FromMinutes(1).ToString()) - .Add("maxIdleChannelsPerEndpoint", "10") - End With - Dim service As New ChannelManagerService(parameters) - ' - End Sub - Private Sub Container3() - ' ChannelManagerService.ChannelManagerService(ChannelPoolSettings). - ' - Dim settings As New ChannelPoolSettings() - With settings - .IdleTimeout = TimeSpan.FromMinutes(10) - .LeaseTimeout = TimeSpan.FromMinutes(1) - .MaxOutboundChannelsPerEndpoint = 10 - End With - Dim service As New ChannelManagerService(settings) - ' - End Sub - Private Sub Container4() - ' ChannelManagerService.ChannelManagerService(ChannelPoolSettings, Ilist). - Dim contractDescription As ContractDescription = Nothing - ' - Dim settings As New ChannelPoolSettings() - With settings - settings.IdleTimeout = TimeSpan.FromMinutes(10) - settings.LeaseTimeout = TimeSpan.FromMinutes(1) - settings.MaxOutboundChannelsPerEndpoint = 10 - End With - Dim endpoints As IList(Of ServiceEndpoint) = New List(Of ServiceEndpoint)() - endpoints.Add(New ServiceEndpoint(contractDescription)) - Dim service As New ChannelManagerService(settings, endpoints) - ' - End Sub - - Private Class LocalServiceHost - Inherits ServiceHost - Public Sub New(ByVal singletonInstance As Object, ParamArray ByVal baseAddresses() As Uri) - MyBase.New(singletonInstance, baseAddresses) - End Sub - - Private clientEndpoints_Renamed As IList(Of ServiceEndpoint) = Nothing - Friend ReadOnly Property ClientEndpoints() As IList(Of ServiceEndpoint) - Get - Return clientEndpoints_Renamed - End Get - End Property - End Class - - - Protected Overrides Function _ - CreateDescription( ByRef implementedContracts As IDictionary(Of String, ContractDescription)) As ServiceDescription - Throw New NotImplementedException() - End Function - End Class -End Namespace diff --git a/snippets/visualbasic/VS_Snippets_CFX/freeformactivitydesigner/vb/snippets.vb b/snippets/visualbasic/VS_Snippets_CFX/freeformactivitydesigner/vb/snippets.vb deleted file mode 100644 index 7c5f8e5bc9f..00000000000 --- a/snippets/visualbasic/VS_Snippets_CFX/freeformactivitydesigner/vb/snippets.vb +++ /dev/null @@ -1,47 +0,0 @@ -Imports System.ComponentModel.Design -Imports System.Workflow.ComponentModel -Imports System.Workflow.ComponentModel.Design - - -Namespace FreeformActivityDesignerSnippets - - ' - Class ProcessActvityDesigner - Inherits System.Workflow.ComponentModel.Design.FreeformActivityDesigner - - - Function GetConnectionPoint(ByVal activity As Activity, ByVal connectorIndex As Int32, ByVal edge As DesignerEdges) As ConnectionPoint - - Dim designer As ActivityDesigner = Nothing - - If Activity IsNot Nothing And Activity.Site IsNot Nothing Then - - Dim designerHost As IDesignerHost = activity.Site.GetService(GetType(IDesignerHost)) - If designerHost IsNot Nothing Then - designer = CType(designerHost.GetDesigner(activity), ActivityDesigner) - End If - End If - - Return New ConnectionPoint(designer, edge, connectorIndex) - End Function - - - Protected Overrides Sub OnLayoutPosition(ByVal e As ActivityDesignerLayoutEventArgs) - - MyBase.OnLayoutPosition(e) - - ' Draw a connector between the first and second activities contained in - ' the sequence activity used by me designer - If Me.IsRootDesigner Then - - Dim parentActivity As CompositeActivity = CType(Me.Activity, CompositeActivity) - Dim sourcePoint As ConnectionPoint = GetConnectionPoint(parentActivity.Activities(0), 1, DesignerEdges.Bottom) - Dim targetPoint As ConnectionPoint = GetConnectionPoint(parentActivity.Activities(1), 0, DesignerEdges.Top) - - Me.AddConnector(sourcePoint, targetPoint) - End If - End Sub - - End Class - ' -End Namespace diff --git a/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb b/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb deleted file mode 100644 index 65f02d56f05..00000000000 --- a/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb +++ /dev/null @@ -1,73 +0,0 @@ -' - _ -Public Class ConsoleWriteLineActivity - Inherits System.Workflow.ComponentModel.Activity - - Public Shared MsgProperty As DependencyProperty = DependencyProperty.Register("Msg", GetType(String), GetType(ConsoleWriteLineActivity)) - - _ - _ - Public Property Msg() As String - Get - Return (CType((MyBase.GetValue(ConsoleWriteLineActivity.MsgProperty)), String)) - End Get - Set(ByVal Value As String) - MyBase.SetValue(ConsoleWriteLineActivity.MsgProperty, Value) - End Set - End Property - - Protected Overrides Function Execute(ByVal executionContext As System.Workflow.ComponentModel.ActivityExecutionContext) As System.Workflow.ComponentModel.ActivityExecutionStatus - Console.WriteLine(Msg) - Return ActivityExecutionStatus.Closed - End Function - -End Class -' - -' -Class ConsoleWriteLineActivityValidator - Inherits ActivityValidator - - ' - Public Overrides Function Validate( _ - ByVal manager As System.Workflow.ComponentModel.Compiler.ValidationManager, _ - ByVal obj As Object) As System.Workflow.ComponentModel.Compiler.ValidationErrorCollection - - 'Invoke the base class method implementation to - 'perform default validation. - Dim errors As ValidationErrorCollection = MyBase.Validate(manager, obj) - - 'Make sure there is an activity instance. - Dim crw As ConsoleWriteLineActivity = CType(obj, ConsoleWriteLineActivity) - If crw Is Nothing Then - Throw New InvalidOperationException() - End If - - 'If the activity has no parent then this validation - 'is occurring during the compilation of the activity - 'and not during the hosting or creation of an - 'activity instance. - If crw.Parent Is Nothing Then - 'Can skip the rest of the validation because - 'it deals with the hosting and the creation - 'of the activity. - Return errors - End If - - 'Msg is required. Add a validation error if there is no - 'Msg specified or Msg is not bound to another property. - If String.IsNullOrEmpty(crw.Msg) And _ - crw.GetBinding(ConsoleWriteLineActivity.MsgProperty) Is Nothing Then - - ' - errors.Add(New ValidationError("Msg is required", 100, False, "Msg")) - ' - - End If - - Return errors - End Function - ' -End Class -' - diff --git a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml index 6de9ff36817..41b7de894fd 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml @@ -23,21 +23,13 @@ Derivative of that is a base class for all activity validator components. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following example shows a complete used for a custom activity. The custom activity is a `ConsoleWriteLineActivity` activity that has a single dependency property named `Msg` of type . The validator ensures that the `Msg` property is set. If it is not set, the compiler displays an error when the method is called on the and the compilation fails. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb" id="Snippet1"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -86,21 +78,13 @@ Verifies that the given activity is valid. A object that contains any errors or warnings that occurred during validation. - to validate the properties of the . - - This method only validates the uniqueness of the for the if the is not a root . - - - -## Examples - The following example shows how to override the method for an used for a custom activity that has a single dependency property named `Msg` of type . The custom validator ensures that the `Msg` property is set. If it is not set, the compiler displays an error when the method is called on the and the compilation fails. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb" id="Snippet3"::: - + to validate the properties of the . + + This method only validates the uniqueness of the for the if the is not a root . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml b/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml index cfdc571f312..5785dee6035 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml @@ -82,17 +82,7 @@ Gets the programming language used by the environment, such as Visual Studio, when compiling the workflow. The name of the programming language used by the development environment. - - - + To be added. @@ -120,14 +110,6 @@ ## Remarks This property is used in Visual Basic compilation environment to pass the root namespace of the project to the compiler. - - -## Examples - The following example shows an implementation of the `RootNamespace` property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet122"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet122"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml b/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml index 43b11256cdd..feb5e941c82 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml @@ -33,18 +33,18 @@ An implementation of that acts as a container of types within the indicated assemblies and code compile units. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This implementation, in addition to handling compiled assemblies ( and methods), can handle types that have not been compiled yet (). The limited implementation of is returned for types referenced using . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This implementation, in addition to handling compiled assemblies ( and methods), can handle types that have not been compiled yet (). The limited implementation of is returned for types referenced using . + > [!NOTE] -> only returns public types from referenced assemblies, and both public and non-public types from local assemblies. - +> only returns public types from referenced assemblies, and both public and non-public types from local assemblies. + ]]> @@ -68,17 +68,7 @@ The encapsulated for this instance. Initializes a new instance of the class. - - class. This code example is part of the BasicDesignerHosting SDK Sample from the WorkflowLoader.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet256"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet256"::: - - ]]> - + To be added. @@ -130,17 +120,7 @@ The path of the to add. Adds a reference to the to the internal list. This assembly is used for the lookup in the method. - - class and run the method. This code example is part of the BasicDesignerHosting SDK Sample from the WorkflowLoader.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet256"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet256"::: - - ]]> - + To be added. is a null reference (Visual Basic ). @@ -330,11 +310,11 @@ Gets the that provides the designated service . The that provides the designated service . - associated with this instance is a null reference (`Nothing` in Visual Basic) then a null reference (`Nothing`) is returned. - + associated with this instance is a null reference (`Nothing` in Visual Basic) then a null reference (`Nothing`) is returned. + ]]> @@ -375,11 +355,11 @@ Gets the type from the set of assemblies added to the using , , or . The requested . - @@ -415,11 +395,11 @@ Gets the type from the set of assemblies added to the using , , or . The requested . - @@ -666,11 +646,11 @@ The to delegate this event to. Updates the reference associated with this instance. - is raised when this method is invoked. - + is raised when this method is invoked. + ]]> @@ -701,11 +681,11 @@ The to remove from this instance. Removes all references to the subject from this instance. - is raised when this method is invoked. - + is raised when this method is invoked. + ]]> @@ -735,11 +715,11 @@ The path of the to be removed. Removes a path-based reference from this instance. - is raised when this method is invoked. - + is raised when this method is invoked. + ]]> @@ -769,11 +749,11 @@ The to be removed. Removes all references to the subject from this instance. - is raised when this method is invoked. - + is raised when this method is invoked. + ]]> @@ -803,11 +783,11 @@ The used to set this value. Sets the value of the local to the referenced . - is raised when this method is invoked. Call before you call otherwise it has no affect on the . - + is raised when this method is invoked. Call before you call otherwise it has no affect on the . + ]]> @@ -835,11 +815,11 @@ Gets an of load error exceptions keyed by the that causes the . An of load error exceptions keyed by the that causes the . - is created at each reference to this property. - + is created at each reference to this property. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/ValidationOptionAttribute.xml b/xml/System.Workflow.ComponentModel.Compiler/ValidationOptionAttribute.xml index abc2f2acdb4..f679a2c35c9 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/ValidationOptionAttribute.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/ValidationOptionAttribute.xml @@ -27,51 +27,19 @@ Custom attribute that contains information. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This attribute should only be used as dependency property option. Attributes are ignored if declared on a .NET property. - - The is intended to be used on Meta-properties only. It will be ignored for instance properties. For more information, see [Using Activity Properties](https://msdn.microsoft.com/library/974353d4-28f9-4202-890d-b36981876148) for more details. - - If the is not specified, the behavior defaults to . - -```csharp -public sealed partial class Activity1: Activity -{ - public Activity1() - { - } - - public static DependencyProperty MyPropertyProperty = - DependencyProperty.Register( - "MyProperty", - typeof(string), - typeof(Activity1), - new PropertyMetadata( - DependencyPropertyOptions.Metadata, - new ValidationOptionAttribute(ValidationOption.Required))); - - [Browsable(true)] - [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] - public string MyProperty - { - get - { - return ((string)(base.GetValue(Activity1.MyPropertyProperty))); - } - set - { - base.SetValue(Activity1.MyPropertyProperty, value); - } - } -} -``` - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This attribute should only be used as dependency property option. Attributes are ignored if declared on a .NET property. + + The is intended to be used on Meta-properties only. It will be ignored for instance properties. For more information, see [Using Activity Properties](https://msdn.microsoft.com/library/974353d4-28f9-4202-890d-b36981876148) for more details. + + If the is not specified, the behavior defaults to . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml index d0871443415..6ac5a0f7686 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml @@ -23,21 +23,13 @@ Represents the compiler for workflows that are developed using C# or Visual Basic code and/or XAML markup. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following code example demonstrates how to create a new instance of the class and run the method. The code also creates a new instance of the class and sets some of its values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -57,17 +49,7 @@ Initializes a new instance of the class. - - class. The code also creates a new instance of the class and sets some of its values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - - ]]> - + To be added. @@ -103,13 +85,13 @@ Compiles a list of workflows contained in the files that are passed as parameters based on the . The representing the results of the operation. - method. The code also creates new instances of the and classes and sets some values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - - + method. The code also creates new instances of the and classes and sets some values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). + + + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml index 09c2f0e908e..51fb556c925 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml @@ -32,15 +32,7 @@ ## Remarks > [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following code example demonstrates how to create a new instance of the class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] ]]> @@ -92,17 +84,7 @@ The names of the assemblies used in compilation. Initializes a new instance of the class, with the names of the assemblies used in compilation. - - class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - - ]]> - + To be added. @@ -267,14 +249,6 @@ ## Remarks The compiler adds standard library paths to the collection. - - -## Examples - The following code example demonstrates how to create a new instance of the class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerResults.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerResults.xml index 133f6a0db30..d1884858d2d 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerResults.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerResults.xml @@ -27,21 +27,13 @@ Represents the results of a workflow compilation. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following code example demonstrates how to set the value of the class, and assumes that `results` is of type , which is created earlier in the file. The code also creates new instances of the and classes and sets some values. This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml index 574be2dfced..76c2500c387 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml @@ -77,14 +77,6 @@ lets the user extend the metadata associated with the activity. - - -## Examples - The following example shows a complete implementation of an for a custom activity. The designer has a flag that can be toggled to allow the base class to control the painting or to utilize the various methods the class to draw the activity. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet72"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet72"::: - ]]> @@ -195,16 +187,6 @@ ## Remarks You can use the rectangle returned by the bounds method to determine the area enclosed by the designer plus the selection area. - - -## Examples - The following code example demonstrates how you can use the property to determine the new bounding rectangle for a glyph displayed on an . - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet133"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet133"::: - ]]> Workflow Monitor @@ -242,14 +224,6 @@ This method is called when a user initiates an insertion operation, such as drag-and-drop or paste. - - -## Examples - The following example demonstrates how to ensure that a custom activity is parented to specific activity types. In this case, the custom activity can only be parented to a `ParallelIfActivity`. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet23"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet23"::: - ]]> @@ -777,14 +751,6 @@ ## Remarks The property is set to the to display. You can do this at design time or at run time. - - -## Examples - The following example demonstrates loading a object from an embedded resource. In this case, the `ToolboxImage` is the same Image that is used when the base class draws the custom . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet76"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet76"::: - ]]> @@ -814,14 +780,6 @@ ## Remarks Use the to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. - - -## Examples - The following example shows how to override the property. In this example, the is calculated using the Bounds of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet74"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet74"::: - ]]> @@ -854,14 +812,6 @@ ## Remarks Initialize loads the designer with the Activity specified. The designer loads the Activity service, updates the verbs associated with the activity and assigns the default text and image to the designer. - - -## Examples - The following example shows how to override the base class implementation of the Initialize method. The method in this example is loading a object from an embedded resource. The `ToolboxImage` resource is the that is used when the base class draws the custom . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet76"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet76"::: - ]]> @@ -1799,17 +1749,7 @@ The that contains the event data. Returns the size of the visual cues or child activity designers on the . The new size settings for the visual cues or child activity designers. - - method. For this example, the size of the `Activity` remains static with a height and width of 64. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet77"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet77"::: - - ]]> - + To be added. contains a null reference ( in Visual Basic). @@ -2388,17 +2328,7 @@ An that contains the event data. Draws the visual representation of the activity at design time. - - that delegates the painting responsibility to the base class or draws itself based on a Boolean value. If `useBasePaint` is false, the custom activity will draw itself using the various methods of the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - - ]]> - + To be added. contains a null reference ( in Visual Basic). @@ -3921,14 +3851,6 @@ This member is an explicit interface member implementation. It can be used only ## Remarks Use to determine the location on the designer where will be displayed. - - -## Examples - The following example shows how to override the property. In this example, the is calculated using the Bounds of the as well as the location and size of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet75"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet75"::: - ]]> @@ -3958,14 +3880,6 @@ This member is an explicit interface member implementation. It can be used only ## Remarks Use the Verbs method to determine the verbs to show on the Context Menu. - - -## Examples - The following example demonstrates how to override the property to insert custom verb actions for a . The `CreateActivityVerbs` creates a new named `"Add New Parallel Branch"` and associates an event handler named `OnAddParallelBranch`. When the verb is clicked in the workflow designer, the event handler is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet73"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet73"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml index 533c46b84d6..b958c310c09 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml @@ -23,21 +23,13 @@ Provides static methods used to draw user interface elements on activity designer surfaces. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following example demonstrates a way to use the class to draw a custom activity on the workflow design surface. A rounded rectangle is first drawn using the method. Text is then drawn using and is placed at the location of the of the . Additionally, the associated with the is drawn using the method of the class. Finally, an expand button used by a is drawn using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -106,17 +98,7 @@ to draw an expanded button; otherwise, . The associated with the activity designer used to render the button. Draws a button that is used to expand and collapse composite designers on the activity designer surface. - - class to draw a custom activity on the workflow design surface. A rounded rectangle is first drawn using the method. Text is then drawn using and is placed at the location of the of the . Additionally, the associated with the is drawn using the method of the class. Finally, an expand button used by a is drawn using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - - ]]> - + To be added. or contains a null reference ( in Visual Basic). @@ -159,19 +141,11 @@ The that specifies how the image is aligned in the bounding rectangle. Draws an image on the activity designer surface by using a , an , a , and a . - , the source rectangle is set to the size, in pixels, of the image, the transparency setting is set to 1.0f, and drawing grayscales is not allowed. - - - -## Examples - The following example demonstrates a way to use the class to draw a custom activity on the workflow design surface. A rounded rectangle is first drawn using the method. Text is then drawn using and is placed at the location of the of the . Additionally, the associated with the is drawn using the method of the class. Finally, an expand button used by a is drawn using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - + , the source rectangle is set to the size, in pixels, of the image, the transparency setting is set to 1.0f, and drawing grayscales is not allowed. + ]]> @@ -215,10 +189,10 @@ Draws an image on the activity designer surface by using a , an , a source and destination , an , a single-precision floating-point number, and a Boolean value. To be added. - , , , or contains a null reference ( in Visual Basic). - - -or- - + , , , or contains a null reference ( in Visual Basic). + + -or- + is less than 0, or greater than 1.0f. @@ -251,19 +225,11 @@ The integer value of the radius to use for the rounded edges. Draws a rounded rectangle on the activity designer surface. - uses the method to obtain the path to draw. - - - -## Examples - The following example demonstrates a way to use the class to draw a custom activity on the workflow design surface. A rounded rectangle is first drawn using the method. Text is then drawn using and is placed at the location of the of the . Additionally, the associated with the is drawn using the method of the class. Finally, an expand button used by a is drawn using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - + uses the method to obtain the path to draw. + ]]> @@ -304,17 +270,7 @@ The that specifies the quality setting to draw the text. The to draw the text. Draws text on the activity designer surface. - - class to draw a custom activity on the workflow design surface. A rounded rectangle is first drawn using the method. Text is then drawn using and is placed at the location of the of the . Additionally, the associated with the is drawn using the method of the class. Finally, an expand button used by a is drawn using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet78"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet78"::: - - ]]> - + To be added. , , , or contains a null reference ( in Visual Basic). @@ -345,18 +301,18 @@ Returns the graphics path used to draw the specified rounded rectangle. A that draws the rounded path of the specified rectangle. - method uses to obtain the path to draw. - + method uses to obtain the path to draw. + ]]> - is set to . - - -or- - + is set to . + + -or- + is less than or equal to 0. diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml index bd568720724..f0cf2aa07f3 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml @@ -23,30 +23,17 @@ Provides the look and feel property settings to a designer in a design-time environment. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Designer themes define the look and feel of a designer. This includes any background styles, foreground styles, fonts, and icons defined for the designer. - - You can create a custom designer theme if you want to provide configuration abilities to properties unique to your designer. If you do not specify a designer theme for a custom designer, the theme from the base class is used. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Designer themes define the look and feel of a designer. This includes any background styles, foreground styles, fonts, and icons defined for the designer. + + You can create a custom designer theme if you want to provide configuration abilities to properties unique to your designer. If you do not specify a designer theme for a custom designer, the theme from the base class is used. + ]]> @@ -107,24 +94,11 @@ Gets or sets the to end with when using a color gradient for the background color. The background ending . - indicates the ending color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the starting color to the ending color. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + indicates the ending color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the starting color to the ending color. + ]]> @@ -163,24 +137,11 @@ Gets or sets the starting color of the background when using a color gradient on the background. The background starting . - indicates the background color, or the beginning color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the start color to the end color. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + indicates the background color, or the beginning color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the start color to the end color. + ]]> @@ -211,36 +172,23 @@ Gets or sets the background style. A that describes the background style. - to get or set how the background displays color. The can be set to one of four modes: - - `BackwardDiagonal` - Specifies a gradient from upper right to lower left. - - `ForwardDiagonal` - Specifies a gradient from upper left to lower right. - - `Horizontal` - Specifies a gradient from left to right. - - `Vertical` - Specifies a gradient from top to bottom. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + to get or set how the background displays color. The can be set to one of four modes: + + `BackwardDiagonal`\ + Specifies a gradient from upper right to lower left. + + `ForwardDiagonal`\ + Specifies a gradient from upper left to lower right. + + `Horizontal`\ + Specifies a gradient from left to right. + + `Vertical`\ + Specifies a gradient from top to bottom. + ]]> @@ -275,11 +223,11 @@ Gets the font for the theme. The of the theme. - represents the font to use for highlighted text for the theme. - + represents the font to use for highlighted text for the theme. + ]]> @@ -318,24 +266,11 @@ Gets or sets the for the theme. A that represents the of the theme. - is the color used to draw borders for shapes. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + is the color used to draw borders for shapes. + ]]> @@ -370,11 +305,11 @@ Gets the BorderPen for the theme. A that represents the of the theme. - is the pen used to draw borders for shapes. - + is the pen used to draw borders for shapes. + ]]> @@ -409,24 +344,11 @@ Gets or sets the style used for the border. A enumeration that represents the style used for the border. - is the style of line to draw for borders of shapes. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + is the style of line to draw for borders of shapes. + ]]> @@ -461,11 +383,11 @@ Gets the width of the border in pixels. The width of the border in pixels. - is the width in pixels for borders of shapes. - + is the width in pixels for borders of shapes. + ]]> @@ -500,17 +422,17 @@ Gets the geometry of the designer. An enumeration that describes the geometry of the designer. - represents the default geometry of shapes for the theme. - - `Rectangle` - Draws shapes with squared corners. - - `RoundedRectangle` - Draws shapes with rounded corners. - + represents the default geometry of shapes for the theme. + + `Rectangle` + Draws shapes with squared corners. + + `RoundedRectangle` + Draws shapes with rounded corners. + ]]> @@ -545,11 +467,11 @@ Gets the image associated with the designer. The to display for the designer. - is the default image to display for the designer. - + is the default image to display for the designer. + ]]> @@ -584,11 +506,11 @@ Gets or sets the image path for the designer. The image path for the designer. - is the path to the image file to use as the default image to display for the designer. - + is the path to the image file to use as the default image to display for the designer. + ]]> @@ -617,11 +539,11 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources and optionally releases the managed resources used by . - references. This method invokes the `Dispose` method of each referenced object. - + references. This method invokes the `Dispose` method of each referenced object. + ]]> @@ -656,11 +578,11 @@ Gets the font of the text used by the theme. The font of the designer theme. - @@ -699,24 +621,11 @@ Gets or sets the color of the foreground. A that represents the foreground color of the theme. - property to specify the foreground color of the theme. The foreground color is usually the color of the text. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet80"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet80"::: - - To use the theme on an , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet79"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet79"::: - + property to specify the foreground color of the theme. The foreground color is usually the color of the text. + ]]> @@ -751,11 +660,11 @@ Gets the object associated with the theme. A object associated with the theme. - @@ -790,11 +699,11 @@ Gets the used for painting the foreground of the theme. A that is used to paint the foreground of the theme. - is used to draw a line of a specified width and style. The line drawn by a `Pen` object can be filled in a variety of fill styles, including solid colors and textures. The fill style depends on which brush or texture used as the fill object. - + is used to draw a line of a specified width and style. The line drawn by a `Pen` object can be filled in a variety of fill styles, including solid colors and textures. The fill style depends on which brush or texture used as the fill object. + ]]> @@ -833,11 +742,11 @@ Gets a brush used to paint the area specified by the rectangle passed. A that is used to fill interiors of graphical shapes such as rectangles, ellipses, pies, polygons, and paths. - @@ -872,11 +781,11 @@ Gets the size of the image of the theme. A that represents the size of the image. - is the of the default image used by the theme for the designer. - + is the of the default image used by the theme for the designer. + ]]> @@ -901,11 +810,11 @@ Initializes the designer theme. - with the ambient theme. - + with the ambient theme. + ]]> @@ -933,11 +842,11 @@ The property that has changed. Called to signal changes to ambient settings. - is used to notify the theme to apply changes to ambient properties. - + is used to notify the theme to apply changes to ambient properties. + ]]> @@ -972,11 +881,11 @@ Gets the size of the designer. A that represents the size of the designer. - of the designer. - + of the designer. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml index d91f0cdf12b..20da29005e7 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml @@ -1059,17 +1059,7 @@ Gets the collection of verbs to associate with the . An that contains the verbs associated with . - - property to insert custom verb actions for a . The `CreateActivityVerbs` creates a new named `"Add New Parallel Branch"` and associates an event handler named `OnAddParallelBranch`. When the verb is clicked in the workflow designer, the event handler is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet73"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet73"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml b/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml index af3ccf50de4..d3a6ca57a62 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml @@ -27,25 +27,17 @@ Provides a base class for all toolbox items associated with an activity in a workflow designer. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - All toolbox items associated with an class are derived from . This class displays a graphical representation of an class in the toolbox of a design-time environment and creates an instance of the class it is associated with when a user drags it onto the design surface. The activity toolbox item typically represents an activity to create when invoked on a design-mode document. - - This class inherits directly from the class. - - - -## Examples - The following example shows a complete class for a custom activity. In this example, the method is overridden in order to place 2 custom activities within a . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet70"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet70"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + All toolbox items associated with an class are derived from . This class displays a graphical representation of an class in the toolbox of a design-time environment and creates an instance of the class it is associated with when a user drags it onto the design surface. The activity toolbox item typically represents an activity to create when invoked on a design-mode document. + + This class inherits directly from the class. + ]]> @@ -75,11 +67,11 @@ Initializes a new instance of the class. - class. - + class. + ]]> @@ -128,19 +120,11 @@ The that provides the deserialization context for the toolbox item. Initializes a new instance of the class by using the specified and . - is called, it deserializes the toolbox item. - - - -## Examples - The following example shows a complete class for a custom activity. The method is called within the constructor in order to initialize a new instance of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet70"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet70"::: - + is called, it deserializes the toolbox item. + ]]> @@ -169,19 +153,11 @@ Creates an component or an array of components when the toolbox item is invoked. An array of created objects. - method returns the component or components that the creates. - - - -## Examples - The following example shows a complete class for a custom activity. In this example, the method is overridden in order to insert 2 custom activities within a . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet70"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet70"::: - + method returns the component or components that the creates. + ]]> @@ -210,11 +186,11 @@ Creates an component or an array of components that generate a dialog box on the design surface when the toolbox item is invoked. An array of created objects. - . - + . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml b/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml index ca09121bb29..c238074c5c0 100644 --- a/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml @@ -804,20 +804,7 @@ Gets the ambient height and width of glyphs on the workflow design surface. A value that represents the ambient height and width of glyphs on the workflow design surface. - - property from a class that derives from the class. - - This code example is part of the Workflow Monitor SDK Sample from the DatabaseService.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet133"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet133"::: - - ]]> - - Workflow Monitor + To be added. @@ -1463,20 +1450,7 @@ Gets or sets a value that indicates whether the workflow design surface displays configuration errors. if the workflow design surface is to display configuration errors; otherwise, . The default is . - - to false. Doing this for a workflow design surface means that none of the objects displayed on the design surface will display their associated objects. - - This code example is part of the Tracking Profile Designer SDK Sample from the WorkflowDesignerControl.cs file. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet125"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet125"::: - - ]]> - - Workflow Monitor + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml index 4d7c9bebc4f..a3266fd04bf 100644 --- a/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml @@ -160,14 +160,6 @@ ## Remarks Use to determine if a list of activities can be inserted into a composite activity. - - -## Examples - The following example shows how to lock a by not allowing the insertion of child activities. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet25"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet25"::: - ]]> @@ -204,14 +196,6 @@ ## Remarks Use to determine if a list of activities can be moved from within a composite activity. - - -## Examples - The following example shows how to override the method to allow the moving of child activities within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet26"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet26"::: - ]]> @@ -246,14 +230,6 @@ ## Remarks Use to determine if a list of contained activities can be removed from the composite activity. - - -## Examples - The following example shows how to override the method to allow the moving of child activities within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet27"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet27"::: - ]]> @@ -442,19 +418,8 @@ ## Remarks In combination with and , use to determine the proper action when a user clicks the expand or collapse button on the . - - -## Examples - The following code example demonstrates how you can set the property based on a `Boolean` value passed as an argument to a method. - - This code example is part of the Workflow Monitor SDK sample from the ViewHost.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet135"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet135"::: - ]]> - Workflow Monitor @@ -631,14 +596,6 @@ ## Remarks Use the to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. - - -## Examples - The following example shows how to override the property. In this example, the is calculated using the Bounds of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet74"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet74"::: - ]]> @@ -756,14 +713,6 @@ Prior to calling , use to make sure the specified list of activities can be inserted. - - -## Examples - The following example demonstrates the addition of a new branch using a designer based off of the class. If returns true, a new branch is created using the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet28"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet28"::: - ]]> @@ -1494,14 +1443,6 @@ ## Remarks Use to determine the location on the designer where the text description will be displayed. - - -## Examples - The following example shows how to override the property. In this example, the is calculated using the Bounds of the as well as the location and size of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet75"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet75"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml index 7196697238d..d04e15b7f34 100644 --- a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml @@ -23,28 +23,15 @@ Provides theme settings to objects. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The class controls the look and feel of a object on a workflow design surface. - - - -## Examples - The following example shows how to create a custom by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The class controls the look and feel of a object on a workflow design surface. + ]]> @@ -68,22 +55,7 @@ The to associate with the composite designer theme. Initializes a new instance of the class. - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. @@ -115,22 +87,7 @@ Gets or sets a value that determines the shape that appears at the end of a connector. A enumeration value that defines the shape that appears at the end of the connector. The default value is . - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. @@ -194,22 +151,7 @@ Gets or sets a value that determines the shape that appears at the beginning of a connector. A enumeration value that defines the shape that appears at the beginning of the connector. The default value is . - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. @@ -294,11 +236,11 @@ Retrieves a brush that defines the background display properties of the expand button on the composite activity designer. A object that uses the parameter to define the button area in which the brush applies two colors in a linear gradient from the upper-left corner to the lower-right corner of the expand button. - is called, the method disposes of the previous brush and creates a new one. - + is called, the method disposes of the previous brush and creates a new one. + ]]> @@ -323,11 +265,11 @@ Performs further initialization tasks beyond those provided by the constructor. - property is set to `true`, the method obtains settings for the object from the operating system. - + property is set to `true`, the method obtains settings for the object from the operating system. + ]]> @@ -355,13 +297,13 @@ The enumeration value which the composite designer theme should now use. Notifies the object that the ambient property settings for the designer have changed. - and properties to . - - The enumeration determines where a designer theme obtains its ambient property settings. If the value is set, the designer theme class obtains its ambient settings from the property. If the value is set, the designer theme class obtains its ambient settings from the operating system on which the designer is installed. - + and properties to . + + The enumeration determines where a designer theme obtains its ambient property settings. If the value is set, the designer theme class obtains its ambient settings from the property. If the value is set, the designer theme class obtains its ambient settings from the operating system on which the designer is installed. + ]]> @@ -396,22 +338,7 @@ Gets or sets a value indicating whether the composite designer theme will display drop shadows around the composite activity designer. if the displays drop shadows around the ; otherwise, . The default is . - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. @@ -443,22 +370,7 @@ Gets or sets the alignment of the watermark image in the . A enumeration value that indicates where in the the watermark image will be placed. The default value is . - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet30"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. @@ -491,11 +403,11 @@ Gets the watermark image to use on the composite activity designer. The object to use as the watermark for the . - property value is `null` (`Nothing` in Visual Basic) this property will provide the image for the watermark. If the property is set to a valid value, this property is set to `null` (`Nothing`). - + property value is `null` (`Nothing` in Visual Basic) this property will provide the image for the watermark. If the property is set to a valid value, this property is set to `null` (`Nothing`). + ]]> @@ -529,22 +441,7 @@ Gets or sets the relative path to the watermark image to use on the composite activity designer. A string value that represents the relative path to the watermark image to use on the . - - by deriving from the class and setting the appropriate properties for the new theme. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - To use the theme on a , apply the to the class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet24"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml b/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml index aebcbbbcc22..297fc81c06a 100644 --- a/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml +++ b/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml @@ -23,13 +23,13 @@ Contains information about a connector at a specified coordinate in and all classes that inherit from it. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -57,17 +57,7 @@ A that defines the location on the connector that the user clicked. The index identifier of the connector that was clicked. Initializes a new instance of the class. - - class. If returns `true`, a new branch is created using the method. A object is created as a parameter to the method. When this is finished, the method is used to ensure that the newly added branch is displayed in the workflow designer. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet29"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet29"::: - - ]]> - + To be added. Prior to the constructor call the connector index was set to less than zero. @@ -186,11 +176,11 @@ Gets a selectable object associated with the hit area. A selectable associated with the area where the user clicked. - always returns the current . - + always returns the current . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml b/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml index b52380746b6..a0f1be0ff92 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml @@ -34,22 +34,11 @@ Activity designer developers can use classes that inherit from to draw custom glyphs onto the surface of an . classes draw such glyphs at the top-level Z order, which places the custom glyph visually on top of all other glyphs on the designer based on the value of the custom glyph. A lower value for the property indicates a higher priority and therefore draws the glyph at the top-most Z order position on an activity designer. - - -## Examples - The following code example demonstrates a glyph class that derives from the class. The code overrides the and methods. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet132"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet132"::: - ]]> When you inherit from , you must override the following members: . - Workflow Monitor @@ -90,17 +79,7 @@ Gets a value indicating whether the can gain focus on the with which it is associated. if the designer glyph can be activated; otherwise, . The default is . - - - + To be added. @@ -135,21 +114,10 @@ ## Remarks Unless overridden in a derived class, returns the bounds of the activity designer with which the glyph is associated. - - -## Examples - The following code example demonstrates how you can override the method. The code sets the size and location of the custom glyph object. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet133"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet133"::: - ]]> contains a null reference ( in Visual Basic). - Workflow Monitor @@ -270,17 +238,7 @@ The on which the glyph is drawn. Indicates to the glyph that an action has been performed which has activated the glyph. - - - + To be added. @@ -318,19 +276,8 @@ ## Remarks uses to draw the bounds of the comment glyph and to fill it. - - -## Examples - The following code example demonstrates how you can override the method. The code customizes how to draw the glyph object on the activity designer with which the glyph is associated. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet134"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet134"::: - ]]> - Workflow Monitor diff --git a/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml index 15d87e15c64..1e5d368718e 100644 --- a/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml @@ -126,14 +126,6 @@ ## Remarks is called when a user adds a to the . - - -## Examples - The following example shows how to use the `AddConnector` method in a custom activity designer's `OnLayoutPosition` method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/freeformactivitydesigner/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/freeformactivitydesigner/vb/snippets.vb" id="Snippet0"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml b/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml index 4f4a2065198..8c077f7d2fd 100644 --- a/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml +++ b/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml @@ -26,23 +26,15 @@ Describes the area of the designer that contains the point passed to a method. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - is used by methods to describe the area of the designer hit by mouse clicks and drag and drop operations. Use the to decide what kind of action to take in response to a successful hit test. - - - -## Examples - The following example shows the addition of a new branch using a designer based off of the class. If returns `true`, a new branch is created using the method. A object is created as a parameter to the method using the location of the workflow designer by specifying the Designer flag. When this is finished, the method is used to ensure that the newly added branch is displayed in the workflow designer. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet29"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet29"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + is used by methods to describe the area of the designer hit by mouse clicks and drag and drop operations. Use the to decide what kind of action to take in response to a successful hit test. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProvider.xml b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProvider.xml index 734f2874ff3..c45223f60cd 100644 --- a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProvider.xml +++ b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProvider.xml @@ -29,19 +29,8 @@ This interface defines the method that implementing classes must use to provide an appropriate set of objects to activity designers. The implementing class should also render the objects onto the object. - - -## Examples - The following code example demonstrates how you can implement the interface. It shows how you can implement the method to draw custom glyph objects on an activity designer surface. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet130"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet130"::: - ]]> - Workflow Monitor @@ -67,20 +56,7 @@ The object for which to retrieve the glyphs. Returns an array of glyphs that are associated with the specified activity designer. An array of objects to render to the activity designer. - - method to draw custom glyph objects on an activity designer surface. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet130"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet130"::: - - ]]> - - Workflow Monitor + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml index 87dda23af1f..f4ed77d1f66 100644 --- a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml +++ b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml @@ -29,18 +29,8 @@ Classes that implement this interface can add and remove custom glyph providers--any classes that implement the interface -- to and from classes. - - -## Examples - The following code example shows how to obtain a so that you can add a custom glyph provider to an activity designer. The code uses the method to add the provider to the activity designer. - - This code example is part of the Workflow Monitor SDK Sample from the ViewHost.cs file. The type `WorkflowMonitorDesignerGlyphProvider` is defined in the sample code. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet136"::: - ]]> - Workflow Monitor @@ -65,19 +55,7 @@ The to add. Adds a class that implements the interface to the list of glyph providers that an activity designer uses. - - method to add the provider to an activity designer. - - This code example is part of the Workflow Monitor SDK Sample from the ViewHost.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet136"::: - - ]]> - - Workflow Monitor + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml b/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml index 27e0a9928e0..7ee7546be16 100644 --- a/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml +++ b/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml @@ -20,23 +20,15 @@ Provides a mechanism to create uniquely named identifiers throughout a specified range of activities. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - provides a mechanism to create uniquely named identifiers throughout a range of activities. - - - -## Examples - The following example shows an implementation of the . This service ensures that each of the identifiers used within the current workflow is unique. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet41"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet41"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + provides a mechanism to create uniquely named identifiers throughout a range of activities. + ]]> @@ -66,19 +58,11 @@ A collection of activities to ensure that activities are uniquely named. Provides a mechanism to ensure that Activities added to a are uniquely named. - to ensure activities inserted into a have unique identifiers. - - - -## Examples - The following example shows an implementation of the . This service ensures that each of the identifiers used within the current workflow is unique. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet43"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet43"::: - + to ensure activities inserted into a have unique identifiers. + ]]> @@ -108,19 +92,11 @@ The identifier to test for validity. Provides a mechanism to test that an identifier is unique within an . - to make sure an identifier is unique and properly formatted for use within a specified . - - - -## Examples - The following example shows an implementation of the . This service ensures that each of the identifiers used within the current workflow is unique. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet42"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet42"::: - + to make sure an identifier is unique and properly formatted for use within a specified . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml index e8e3dbeb844..f6e3ab3a282 100644 --- a/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml @@ -23,15 +23,15 @@ Provides methods and properties for all activity designers that display parallel vertical layouts on a workflow design surface. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - An activity designer that displays a parallel vertical layout represents an activity on the workflow design surface that has two code paths that a workflow can follow. For example, the designer used for the activity displays the activity on the workflow design surface and has a parallel vertical layout. Each branch of the parallel layout visually represents an activity contained in the activity. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + An activity designer that displays a parallel vertical layout represents an activity on the workflow design surface that has two code paths that a workflow can follow. For example, the designer used for the activity displays the activity on the workflow design surface and has a parallel vertical layout. Each branch of the parallel layout visually represents an activity contained in the activity. + ]]> @@ -80,17 +80,7 @@ Returns a value that indicates whether child activities of the activity associated with the can be moved. if the activities can be moved from the parent activity; otherwise . - - method to allow the moving of child activities within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet26"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet26"::: - - ]]> - + To be added. @@ -117,17 +107,7 @@ Returns a value that indicates whether child activities of the activity associated with the can be deleted. if the activities can be deleted from the parent activity; otherwise . - - method to allow the moving of child activities within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet27"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet27"::: - - ]]> - + To be added. @@ -150,11 +130,11 @@ Gets the first selectable object in the navigation order of the . An that is the first selectable object in the designer navigation order. - property or the property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If the property count is greater than 0, returns the associated with the first activity designer in the collection. - + property or the property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If the property count is greater than 0, returns the associated with the first activity designer in the collection. + ]]> @@ -233,11 +213,11 @@ Gets the last selectable object in the navigation order of the . The that is the last selectable object in the designer navigation order. - or property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If contains child activity designers, returns the last selectable object associated with the first child activity designer. If the child activity designer is collapsed, returns the associated with the first activity designer in the collection. - + or property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If contains child activity designers, returns the last selectable object associated with the first child activity designer. If the child activity designer is collapsed, returns the associated with the first activity designer in the collection. + ]]> @@ -363,21 +343,13 @@ Gets the collection of designer verbs to be associated with the . An that contains the designer verbs to associate with the . - property determines the commands that are displayed on the context menu. - - The verb collection includes any designer verbs inherits from the designer classes it extends. - - - -## Examples - The following example demonstrates how to override the property to insert custom verb actions for a . The `CreateActivityVerbs` creates a new named `"Add New Parallel Branch"` and associates an event handler named `OnAddParallelBranch`. When the verb is clicked in the workflow designer, the event handler is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet73"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet73"::: - + property determines the commands that are displayed on the context menu. + + The verb collection includes any designer verbs inherits from the designer classes it extends. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowHeaderFooter.xml b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowHeaderFooter.xml index 589bb3a601f..43dd54a17b5 100644 --- a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowHeaderFooter.xml +++ b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowHeaderFooter.xml @@ -23,15 +23,15 @@ Represents a header or footer that is associated with a . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - provides header and footer information for the when it is displayed in print preview mode. If provided by the workflow designer, users can configure headers and footers on the **Header/Footer** tab on the **Page Setup** dialog box. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + provides header and footer information for the when it is displayed in print preview mode. If provided by the workflow designer, users can configure headers and footers on the **Header/Footer** tab on the **Page Setup** dialog box. + ]]> @@ -146,17 +146,7 @@ Gets the bounding rectangle for the image associated with the header or footer. The that defines the bounds for the associated with the . - - property. In this example, the is calculated using the Bounds of the to draw the image in the upper left corner of the header/footer. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet74"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet74"::: - - ]]> - + To be added. @@ -252,17 +242,7 @@ Gets the bounding rectangle for the text associated with the header or footer. The that defines the bounds for the associated with the . - - property. In this example, the is calculated using the Bounds of the as well as the location and size of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet75"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet75"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml index a2afc842747..194299a7806 100644 --- a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml @@ -23,15 +23,15 @@ Contains properties and methods to provide consistent look and feel to all root designers on a workflow design surface. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Typically, an instance of a sequential workflow root designer class is created when a workflow is created in a workflow designer and it represents the designer surface on which users can add and edit activities. A workflow root designer does not have a parent designer unless it is the child of an activity. All workflow root designers must derive from . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Typically, an instance of a sequential workflow root designer class is created when a workflow is created in a workflow designer and it represents the designer surface on which users can add and edit activities. A workflow root designer does not have a parent designer unless it is the child of an activity. All workflow root designers must derive from . + ]]> @@ -79,11 +79,11 @@ to allow the activity associated with to be the parent of the activity associated with the ; otherwise, . - returns `false`. - + returns `false`. + ]]> @@ -109,11 +109,11 @@ if the can be expanded and collapsed; otherwise, . The default is . - is always set to `false`. - + is always set to `false`. + ]]> @@ -138,11 +138,11 @@ Gets the footer associated with the root designer. The that represents the footer associated with the . - appear at the bottom of the root designer on the workflow design surface. Icons and text can be displayed in the footer, including button icons that change the designer view when a user selects one of them. - + appear at the bottom of the root designer on the workflow design surface. Icons and text can be displayed in the footer, including button icons that change the designer view when a user selects one of them. + ]]> @@ -171,11 +171,11 @@ Returns a read-only collection of points that represent the inner connection of the designer. A collection that contains the objects used for a connectable designer. - @@ -222,11 +222,11 @@ Gets the header associated with the root designer. The that represents the header associated with the . - appear at the top of the root designer on the workflow design surface. Icons and text can be displayed in the header, including text that indicates the designer view that is currently displayed on the design surface. - + appear at the top of the root designer on the workflow design surface. Icons and text can be displayed in the header, including text that indicates the designer view that is currently displayed on the design surface. + ]]> @@ -251,13 +251,13 @@ Gets the image associated with the designer. The to associate with the designer. - property is set to the to display. You can do this at design time or at run time. - - Unless overridden in a derived class, returns a null reference (`Nothing` in Visual Basic). - + property is set to the to display. You can do this at design time or at run time. + + Unless overridden in a derived class, returns a null reference (`Nothing` in Visual Basic). + ]]> @@ -282,19 +282,11 @@ Gets the value for the enclosing bounds of the image associated with the designer in logical coordinates. A that encloses the displayed for the . - to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. - - - -## Examples - The following example shows how to override the property. In this example, the is calculated using the Bounds of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet74"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet74"::: - + to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. + ]]> @@ -341,11 +333,11 @@ Gets the minimum size for the . A that represents the minimum size of the sequential workflow designer. - represents the smallest size to which a user can resize the . - + represents the smallest size to which a user can resize the . + ]]> @@ -399,13 +391,13 @@ The that contains the event data. Draws any headers and footers associated with the . - draws any text to include in the headers and footers with the appropriate theme settings. It also draws any images to include in the headers and footers. - - **Note** When you override in a derived class, be sure to call the method of the base class so that registered delegates receive the event. - + draws any text to include in the headers and footers with the appropriate theme settings. It also draws any images to include in the headers and footers. + + **Note** When you override in a derived class, be sure to call the method of the base class so that registered delegates receive the event. + ]]> @@ -436,13 +428,13 @@ to display smart tags on the designer surface; otherwise, . Notifies the designer whether smart tags are to be shown or hidden on the . - invalidates the text rectangle associated with the . - - **Note** When you override in a derived class, be sure to call the base class's method so that registered delegates receive the event. - + invalidates the text rectangle associated with the . + + **Note** When you override in a derived class, be sure to call the base class's method so that registered delegates receive the event. + ]]> @@ -468,11 +460,11 @@ if the displays smart tags; otherwise, . The default is . - property is not set to a null reference (`Nothing` in Visual Basic) and the corresponding property is not an empty string or set to a null reference (`Nothing`), returns `true`. - + property is not set to a null reference (`Nothing` in Visual Basic) and the corresponding property is not an empty string or set to a null reference (`Nothing`), returns `true`. + ]]> @@ -497,11 +489,11 @@ Gets the rectangle on the designer surface in which to display a smart tag. A that defines the bounds in which to display the smart tag. - and to display a smart tag of available at the location specified by . - + and to display a smart tag of available at the location specified by . + ]]> @@ -526,11 +518,11 @@ Gets the description associated with the designer. A string that contains the description associated with the designer. - returns . - + returns . + ]]> @@ -555,13 +547,13 @@ Gets the height of the title area of the designer. An integer that represents the height of the title area of the . - calculates the integer it returns by getting the value of its base implementation and adding the height integer defined for the . - + calculates the integer it returns by getting the value of its base implementation and adding the height integer defined for the . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml index ecef715e935..408c4762212 100644 --- a/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml @@ -23,15 +23,15 @@ Provides common methods and properties for composite activity designers that contain structured layouts. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The is the base class for all designers that contain child designers and the child designers are connected to each other using lines rendered on the design surface, called connectors. The class is provided so that activity designer developers can provide a number of activity designer layout types, rather than being tied to the layout provided in the class. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The is the base class for all designers that contain child designers and the child designers are connected to each other using lines rendered on the design surface, called connectors. The class is provided so that activity designer developers can provide a number of activity designer layout types, rather than being tied to the layout provided in the class. + ]]> @@ -80,11 +80,11 @@ Gets or sets the that contains information about the current designer view displayed by the . A that contains information about the current view displayed by the . - contains the view ID and any text, images, activity designers, and user data associated with the view. - + contains the view ID and any text, images, activity designers, and user data associated with the view. + ]]> @@ -115,17 +115,7 @@ Returns a value that indicates whether the specified activities can be added to the at the specified location on the workflow design surface. if the specified activities can be inserted at the specified location on the workflow design surface; otherwise, . - - by not allowing the insertion of child activities. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet25"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet25"::: - - ]]> - + To be added. @@ -152,17 +142,7 @@ Returns a value that indicates whether the specified activities can be removed from the . if the specified activities can be removed; otherwise, . - - method to allow the moving of child activities within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet27"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet27"::: - - ]]> - + To be added. @@ -184,17 +164,7 @@ Gets a generic read-only collection that contains all activity designers that are children of the . An read-only collection that contains the child designers. - - class. If returns true, a new branch is created using the method. A object is created as a parameter to the method. When this is finished, the method is used to ensure that the newly added branch is displayed in the workflow designer by accessing a single object in the collection. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet28"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet28"::: - - ]]> - + To be added. @@ -250,11 +220,11 @@ A that determines the graphic to draw at connector end points. Draws all of the connectors to display on the . - @@ -304,11 +274,11 @@ Gets the first selectable object in the navigation order of the . An that is the first selectable object in the designer navigation order. - returns the associated with the property that is exposed through . - + returns the associated with the property that is exposed through . + ]]> @@ -363,11 +333,11 @@ Returns a read-only collection of points that represent the inner connection points for the . A generic read-only collection that contains the inner connection points for the designer. - class can contain other designers, and returns a read-only collection of all the connection points for the designers associated with `edges` that are contained by the . - + class can contain other designers, and returns a read-only collection of all the connection points for the designers associated with `edges` that are contained by the . + ]]> @@ -423,11 +393,11 @@ The with which to initialize the . Initializes the designer by using the specified activity. - ensures that the active view loaded into the workflow design surface is a valid view. - + ensures that the active view loaded into the workflow design surface is a valid view. + ]]> @@ -479,11 +449,11 @@ Gets the last selectable object in the navigation order of the . The that is the last selectable object in the designer navigation order. - is the active activity designer, returns `null` (`Nothing` in Visual Basic). If a child activity designer is the active designer, it returns the last selectable object associated with the active child designer. - + is the active activity designer, returns `null` (`Nothing` in Visual Basic). If a child activity designer is the active designer, it returns the last selectable object associated with the active child designer. + ]]> @@ -890,11 +860,11 @@ Gets a read-only collection of designer actions that are associated with the smart tags on the designer. A read-only collection that contains all the actions associated with the smart tags on the designer. - hosts multiple views. Use the property to determine how many views the current designer hosts. - + hosts multiple views. Use the property to determine how many views the current designer hosts. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml index 68229c661e9..3217077775a 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml @@ -23,15 +23,15 @@ Provides common designer loader functionality that can be used to implement custom workflow designer loaders. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Designer loader classes are used to load the designer and save any changes to the state of the designer when the user so instructs. The class can be implemented to support custom loading of a workflow designer and workflow designer components. A workflow designer loader is also responsible for writing changes to an open document back to the storage the loader used when loading the document after the method is called. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Designer loader classes are used to load the designer and save any changes to the state of the designer when the user so instructs. The class can be implemented to support custom loading of a workflow designer and workflow designer components. A workflow designer loader is also responsible for writing changes to an open document back to the storage the loader used when loading the document after the method is called. + ]]> @@ -54,17 +54,7 @@ When implemented in a derived class, initializes a new instance of the class. - - object. In this case, the `WorkflowLoader` class is derived from . When the is created, a is also created and associated with the using the `BeginLoad` method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet47"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet47"::: - - ]]> - + To be added. @@ -90,17 +80,7 @@ to add. Adds an activity to the designer host after it has been added to the parent activities collection. - - to the designer. Before the activity is added to the designer using the method, it is first added to the Activities collection of the root activity within the workflow. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet55"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet55"::: - - ]]> - + To be added. @@ -123,19 +103,11 @@ Releases all resources used by the . - releases all services used by the designer host, but it does not write pending changes to the designer loader. If you want to save any pending changes prior to releasing all resources, call before you call . - - - -## Examples - The following example demonstrates an implementation of the method. In this implementation, various services that have been added to the LoaderHost object are removed in preparation for closing the application. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet121"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet121"::: - + releases all services used by the designer host, but it does not write pending changes to the designer loader. If you want to save any pending changes prior to releasing all resources, call before you call . + ]]> @@ -159,17 +131,7 @@ When overridden in a derived class, gets the file name of the designer to load. A string that contains the file name of the designer to load. - - property to return the path of the currently loaded workflow file used by the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet32"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet32"::: - - ]]> - + To be added. @@ -191,17 +153,7 @@ Writes pending changes to the location that the designer was loaded from. - - method to serialize a workflow using the . In this example, the overridden delegates to the method defined in the derived class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet35"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet35"::: - - ]]> - + To be added. @@ -249,17 +201,7 @@ A string that contains a path to the file to read from. When overridden in a derived class, retrieves an object that uses to read from the specified file. A to read the specified file. - - overloaded method is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet33"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet33"::: - - ]]> - + To be added. @@ -285,17 +227,7 @@ A string that contains the path to the file to write to. When overridden in a derived class, gets an object that the uses to write to the specified file. A to write to the file. - - overloaded method is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet34"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet34"::: - - ]]> - + To be added. @@ -318,17 +250,7 @@ Gets a value that indicates whether the workflow should be loaded in debug mode. if the workflow should be loaded in debug mode; otherwise, . The default is . - - property of the current `WorkflowDesignerLoader` returns `true`. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet54"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet54"::: - - ]]> - + To be added. @@ -350,17 +272,7 @@ Initializes the with any services required by the designer loader host. - - method in a derived class to add the services needed for the designer. The services can vary based on the level of service support required by your application. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - - ]]> - + To be added. @@ -387,17 +299,7 @@ An that is created for the serialized layout. List of errors that occurred during the deserialization. Applies the serialized layout to the root designer in the current designer host. - - method. An object is created using the file name of a designer layout file that was created using . When the layout has finished loading, any errors that might have occurred are displayed to the user. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet39"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet39"::: - - ]]> - + To be added. @@ -456,17 +358,7 @@ if load operation is successful; otherwise, . Contains the load errors. Called when loading of the designer is completed. - - method to display errors that might have occurred during the loading of a workflow. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet36"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet36"::: - - ]]> - + To be added. @@ -491,17 +383,7 @@ Class that implements the interface, which manages design-time serialization. Writes cached changes to the location that the designer was loaded from. - - method to serialize the workflow using the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet35"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet35"::: - - ]]> - + To be added. @@ -526,17 +408,7 @@ Class that implements the interface, which manages design-time serialization. Loads the designer from a design document. - - - + To be added. @@ -561,17 +433,7 @@ Activity to be removed from the designer. Removes an activity from the designer host after it has been added to the parent activities collection. - - . Before the last child activity in the workflow is removed from the , it is first removed from the workflow collection. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet40"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet40"::: - - ]]> - + To be added. @@ -601,17 +463,7 @@ Root activity from which you get the layout information. Errors encountered during serialization. Serializes the designer layout. - - method. After the object is created, the for the `RootComponent` of the workflow is retrieved and passed to the method. To load the layout file that is generated by this method, see . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet38"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet38"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml index cac07d56944..3acfab47595 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml @@ -38,19 +38,8 @@ Derive from the class to create message filters that can respond to workflow designer events, such as drag operations, layout and paint operations, and other designer events. To add a custom message filter to the message filters chain, call the on the or override the virtual property on the custom root activity and add the custom message filter to the collection returned from the base class. - - -## Examples - The following code example shows a custom designer message filter that derives from . The class, named `CustomMessageFilter`, overrides a number of its base class methods including , , , , , , , , , and . - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet237"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet237"::: - ]]> - Basic Designer Hosting @@ -299,19 +288,8 @@ ## Remarks occurs when the mouse pointer enters the bounds of an object during a drag operation. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet247"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet247"::: - ]]> - Basic Designer Hosting @@ -341,16 +319,6 @@ ## Remarks occurs when the mouse pointer leaves the bounds of an object during a drag operation. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet249"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet249"::: - ]]> @@ -385,16 +353,6 @@ ## Remarks occurs when the mouse pointer moves within the bounds of an object during a drag operation. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet248"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet248"::: - ]]> @@ -429,16 +387,6 @@ ## Remarks occurs when a drag operation is started. allows the source of a drag operation to modify the appearance of the mouse pointer to give you visual feedback during a drag operation. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet251"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet251"::: - ]]> @@ -473,19 +421,8 @@ ## Remarks occurs when a key is pressed when a specific object has focus. - - -## Examples - The following code example shows how to override the method to customize how to remove activities from a workflow design surface. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet253"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet253"::: - ]]> - Basic Designer Hosting @@ -518,16 +455,6 @@ ## Remarks occurs when a key is released when a specific object has focus. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet254"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet254"::: - ]]> @@ -591,19 +518,8 @@ ## Remarks occurs when the items selected by dragging the mouse changes. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet246"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet246"::: - ]]> - Basic Designer Hosting @@ -636,16 +552,6 @@ ## Remarks occurs when you double-click the mouse. The double-click is determined by the mouse settings of the operating system. You can set the time between clicks of a mouse button that is considered a double-click rather than two clicks. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet241"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet241"::: - ]]> @@ -680,19 +586,8 @@ ## Remarks occurs when a mouse button is clicked. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet238"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet238"::: - ]]> - Basic Designer Hosting @@ -725,19 +620,8 @@ ## Remarks occurs when the mouse pointer enters the bounds of an object. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet242"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet242"::: - ]]> - Basic Designer Hosting @@ -770,19 +654,8 @@ ## Remarks occurs when the mouse pointer hovers above an object. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet243"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet243"::: - ]]> - Basic Designer Hosting @@ -812,19 +685,8 @@ ## Remarks occurs when the mouse pointer leaves the bounds of an object. - - -## Examples - The following code example shows how to override the method to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet244"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet244"::: - ]]> - Basic Designer Hosting @@ -857,19 +719,8 @@ ## Remarks occurs when the mouse pointer moves while within the bounds of an object. - - -## Examples - The following code example shows how to override the method to return the scroll position and to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet239"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet239"::: - ]]> - Basic Designer Hosting @@ -902,19 +753,8 @@ ## Remarks occurs when you release a mouse button. - - -## Examples - The following code example shows how to override the method to return the scroll position and to return `false` so that other components in the designer architecture can process the method. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet240"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet240"::: - ]]> - Basic Designer Hosting @@ -947,14 +787,6 @@ ## Remarks occurs when the mouse wheel moves. - - -## Examples - The following code example shows how to override the method to zoom the object based on the property of the and to return `false` so that other components in the designer architecture can process the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet245"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet245"::: - ]]> @@ -1065,16 +897,6 @@ ## Remarks `OnQueryContinueDrag` occurs during a drag operation. The `OnQueryContinueDrag` event allows the drag source to determine whether the drag operation should be canceled. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet252"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet252"::: - ]]> @@ -1147,16 +969,6 @@ ## Remarks occurs when the workflow should show a context menu. - - -## Examples - The following code example shows how to override the method so that it always returns `true`. - - This code example is part of the Basic Designer Hosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet255"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet255"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml index 304a2556d63..22d55d840ae 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml @@ -23,28 +23,15 @@ Defines a set of fields that each corresponds to a command function provided by the workflow designers. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - contains a set of fields that can be used to specify a command to link when adding a command using the method of the . - - - -## Examples - The following example demonstrates how to create a custom . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + contains a set of fields that can be used to specify a command to link when adding a command using the method of the . + ]]> @@ -64,22 +51,7 @@ Initializes a new instance of the class. - - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - - ]]> - + To be added. @@ -101,11 +73,11 @@ Gets the for the breakpoint action menu. This field is read-only. - @@ -129,11 +101,11 @@ Gets the for the breakpoint condition menu. This field is read-only. - @@ -157,11 +129,11 @@ Gets the for the breakpoint constraints menu. This field is read-only. - @@ -185,11 +157,11 @@ Gets the for the breakpoint hit count menu. This field is read-only. - @@ -213,11 +185,11 @@ Gets the for the breakpoint location menu. This field is read-only. - @@ -241,11 +213,11 @@ Gets the for the change theme menu. This field is read-only. - @@ -269,11 +241,11 @@ A that can be used to access the clear breakpoints menu. This field is read-only. - @@ -297,24 +269,11 @@ A that can be used to access the collapse menu. This field is read-only. - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - + @@ -359,11 +318,11 @@ A that can be used to access the create theme menu. This field is read-only. - @@ -408,11 +367,11 @@ A that can be used to access the debug step branch menu. This field is read-only. - @@ -436,11 +395,11 @@ A that can be used to access the debug step instance menu. This field is read-only. - @@ -485,11 +444,11 @@ A that can be used to access the default filter menu. This field is read-only. - @@ -513,11 +472,11 @@ A that can be used to access the default page menu. This field is read-only. - @@ -541,11 +500,11 @@ A that can be used to access the designer actions menu. This field is read-only. - @@ -569,11 +528,11 @@ A that can be used to access the designer properties menu. This field is read-only. - @@ -597,24 +556,11 @@ A that can be used to access the disable menu. This field is read-only. - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - + @@ -638,24 +584,11 @@ A that can be used to access the enable menu. This field is read-only. - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - + @@ -679,11 +612,11 @@ A that can be used to access the enable breakpoint menu. This field is read-only. - @@ -707,11 +640,11 @@ A that can be used to access the execution state menu. This field is read-only. - @@ -735,24 +668,11 @@ A that can be used to access the expand menu. This field is read-only. - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - + @@ -777,11 +697,11 @@ A that can be used to access the zoom first menu. This field is read-only. - @@ -805,11 +725,11 @@ A that can be used to access the goto disassembly menu. This field is read-only. - @@ -833,11 +753,11 @@ A that can be used to access the insert breakpoint menu. This field is read-only. - @@ -861,11 +781,11 @@ A that can be used to access the insert tracepoint menu. This field is read-only. - @@ -890,11 +810,11 @@ A that can be used to access the zoom last menu. This field is read-only. - @@ -939,11 +859,11 @@ A that can be used to access the new data breakpoint menu. This field is read-only. - @@ -967,11 +887,11 @@ A that can be used to access the new file tracepoint menu. This field is read-only. - @@ -995,11 +915,11 @@ A that can be used to access the PageDown menu. This field is read-only. - @@ -1023,11 +943,11 @@ A that can be used to access the page layout menu. This field is read-only. - @@ -1051,11 +971,11 @@ A that can be used to access the page setup menu. This field is read-only. - @@ -1079,11 +999,11 @@ A that can be used to access the PageUp menu. This field is read-only. - @@ -1107,11 +1027,11 @@ A that can be used to access the pan menu. This field is read-only. - @@ -1135,11 +1055,11 @@ A that can be used to access the pan menu. This field is read-only. - @@ -1163,11 +1083,11 @@ A that can be used to access the print menu. This field is read-only. - @@ -1191,11 +1111,11 @@ A that can be used to access the print preview menu. This field is read-only. - @@ -1219,11 +1139,11 @@ A that can be used to access the print preview page menu. This field is read-only. - @@ -1247,11 +1167,11 @@ A that can be used to access the run to cursor menu. This field is read-only. - @@ -1275,11 +1195,11 @@ A that can be used to access the save as image menu. This field is read-only. - @@ -1303,24 +1223,11 @@ A that can be used to access the selection menu. This field is read-only. - . In this example, a context menu is created when the `ShowContextMenu` is called. In the `GetSelectionMenuItems` method, the class is utilized to associate the proper menu commands provided by the workflow designer with their corresponding text. When this is finished, an event handler is associated with each command so that when the command is selected, the appropriate `MenuCommand` is invoked. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet44"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet44"::: - - To enable this service, call the `AddService` method of the property in a class as shown in the following example. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet31"::: - + @@ -1344,11 +1251,11 @@ A that can be used to access the set next statement menu. This field is read-only. - @@ -1372,11 +1279,11 @@ A that can be used to access the show all menu. This field is read-only. - @@ -1400,11 +1307,11 @@ A that can be used to access the show next statement menu. This field is read-only. - @@ -1428,11 +1335,11 @@ A that can be used to access the toggle breakpoint menu. This field is read-only. - @@ -1456,11 +1363,11 @@ A that can be used to access the verb group actions menu. This field is read-only. - @@ -1484,11 +1391,11 @@ A that can be used to access the verb group designer actions menu. This field is read-only. - @@ -1512,11 +1419,11 @@ A that can be used to access the edit verb group menu. This field is read-only. - @@ -1540,11 +1447,11 @@ A that can be used to access the general verb group menu. This field is read-only. - @@ -1568,11 +1475,11 @@ A that can be used to access the miscellaneous verb group menu. This field is read-only. - @@ -1596,11 +1503,11 @@ A that can be used to access the options verb group menu. This field is read-only. - @@ -1624,11 +1531,11 @@ A that can be used to access the view verb group menu. This field is read-only. - @@ -1674,11 +1581,11 @@ A that can be used to access the workflow toolbar menu. This field is read-only. - @@ -1702,11 +1609,11 @@ A that can be used to access the zoom 100% menu. This field is read-only. - @@ -1730,11 +1637,11 @@ A that can be used to access the zoom 150% menu. This field is read-only. - @@ -1758,11 +1665,11 @@ A that can be used to access the zoom 200% menu. This field is read-only. - @@ -1786,11 +1693,11 @@ A that can be used to access the zoom 300% menu. This field is read-only. - @@ -1814,11 +1721,11 @@ A that can be used to access the zoom 400% menu. This field is read-only. - @@ -1842,11 +1749,11 @@ A that can be used to access the zoom 50% menu. This field is read-only. - @@ -1870,11 +1777,11 @@ A that can be used to access the zoom 75% menu. This field is read-only. - @@ -1898,11 +1805,11 @@ A that can be used to access the zoom in menu. This field is read-only. - @@ -1926,11 +1833,11 @@ A that can be used to access the zoom level combo menu. This field is read-only. - @@ -1954,11 +1861,11 @@ A that can be used to access the zoom level list handler menu. This field is read-only. - @@ -1982,11 +1889,11 @@ A that can be used to access the zoom menu. This field is read-only. - @@ -2010,11 +1917,11 @@ A that can be used to access the zoom out menu. This field is read-only. - diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml index d64897db088..bebf52780ff 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml @@ -91,14 +91,6 @@ ## Remarks The describes the look and feel of a workflow design surface. This includes background styles, foreground styles, fonts, and icons defined for the workflow design surface. - - -## Examples - The following example demonstrates how to access the `AmbientTheme` property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet124"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet124"::: - ]]> @@ -226,19 +218,8 @@ ## Remarks Use to make changes to the theme used to display the workflow. - - -## Examples - The following code example shows how to use the property to access the associated with a workflow. - - This code example is part of the Workflow Monitor SDK Sample from the DesignerGlyphProvider.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet133"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet133"::: - ]]> - Workflow Monitor @@ -652,17 +633,7 @@ Gets or sets a value that indicates whether the workflow theme is read-only. if the workflow theme is read-only; otherwise, . The default is . - - property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet124"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet124"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml index 2840c22f5ef..b5d6b223efa 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml @@ -47,19 +47,8 @@ is the design surface which renders a visual representation of process flow described in workflow markup. offers a rich set of user interface functionality needed by the activity designers for rendering and for responding to various Windows-generated events. Also, the offers a set of common functions which can be used by all designers to perform certain activities. - - -## Examples - The following code example demonstrates how you can obtain an instance of the class using the method. The code then sets several properties, including and , and calls the method. - - This code example is part of the Workflow Tracking Profile Designer SDK Sample from the WorkflowDesignerControl.cs file. For more information, see [Workflow Tracking Profile Designer](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet126"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet126"::: - ]]> - Workflow Tracking Profile Designer @@ -108,20 +97,7 @@ An object that implements the interface. Initializes an instance of a with the specified service provider. - - object. In this example, a new object is created and the `BeginLoad` method is called passing a object as the parameter. After creating a new , a object is created using the created earlier as a parameter to the constructor. - - This code example is part of the Outlook Workflow Wizard SDK Sample from the WorkflowViewWrapper.cs file. For more information, see [Outlook Workflow Wizard Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet97"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet97"::: - - ]]> - - Workflow Monitor + To be added. @@ -156,21 +132,6 @@ Mouse events, keyboard events, paint and layout events are passed on to a associated with the . - - -## Examples - In the following example, a is created and a object is associated with the workflow design surface. In order to retrieve notifications of messages, a is created and added to the object. - - This code example is part of the Outlook Workflow Wizard SDK Sample from the WorkflowViewWrapper.cs file. For more information, see [Outlook Workflow Wizard Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet102"::: - - The `MessageFilter` object created in the previous code is derived from the class. By overriding the methods of this class, the message filter is notified whenever a user interface event occurs on the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet104"::: - ]]> @@ -381,17 +342,7 @@ Enables the button on the design surface that, when clicked, changes the zoom level of the workflow design surface so that the entire workflow is displayed in the . if the dynamic button is enabled; otherwise, . - - interface for the designer and then retrieves the object by using the method before modifying the property. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet50"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet50"::: - - ]]> - + To be added. @@ -422,14 +373,6 @@ ## Remarks Use when you are working with an object in the workflow that requires user interface cues. will expand parent objects and scroll the as necessary to make the object visible on the designer. - - -## Examples - The following example uses the method of the object to return an interface. If the service exists, is called passing the currently selected activity using the `PrimarySelection` property of the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet64"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet64"::: - ]]> @@ -461,17 +404,8 @@ ## Remarks The actual zoom level is dependent upon the settings of the user's workflow designer. - - -## Examples - The following example shows how to enable the fit to screen button. The method first obtains the interface for the designer and then retrieves the object by using the method before modifying the property. Finally, the method is called to display the entire workflow within the bounds of the displayable area of the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet50"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet50"::: - ]]> - Workflow Tracking Profile Designer @@ -493,17 +427,7 @@ Changes the zoom level to one hundred percent to display the full size of the workflow in the . - - object be setting several properties. The causes the object to display the full size of the workflow within the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet65"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet65"::: - - ]]> - + To be added. @@ -535,14 +459,6 @@ ## Remarks `GetService` returns a implementing the requested service, or a null reference (`Nothing`) if the service cannot be resolved. - - -## Examples - The following example uses the method of the object to return an interface. If the service exists, is called passing the currently selected activity using the `PrimarySelection` property of the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet64"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet64"::: - ]]> @@ -566,18 +482,7 @@ Gets the horizontal scrollbar for the . A you can use to adjust the settings and visibility of the horizontal scrollbar. - - class. The code then sets several properties, including and , and calls the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet65"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet65"::: - - ]]> - - Workflow Tracking Profile Designer + To be added. @@ -702,14 +607,6 @@ Override this method when you need to customize how a custom designer restores its view-state. - - -## Examples - The following example demonstrates how to load the view state for a object by creating a object with the `FileMode.Open` flag and passing it to the method. The view state file was created using the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet60"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet60"::: - ]]> @@ -1714,14 +1611,6 @@ ## Remarks Use the object to set the properties that describe how to print, and call the `Print` method to start the printing process. - - -## Examples - The following example demonstrates how to retrieve the object, display a and associate the that were selected by a user before printing the document. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet56"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet56"::: - ]]> @@ -1746,17 +1635,7 @@ Gets or sets the print preview mode of the . if print preview mode is active; otherwise, . - - - + To be added. @@ -1816,16 +1695,6 @@ ## Remarks The root designer of the workflow is the designer associated with the design surface of the workflow. It contains all child designers, and subsequently all activities in the workflow. - - -## Examples - The following example shows how to retrieve the RootDesigner of a WorkflowView object. The workflowPanel field contains a method named GetWorkflowView that returns the active WorkflowView instance. The RootDesigner is then cast to a SequentialWorkflowRootDesigner before any action is taken on it. - - This code example is part of the Basic DesignerHosting SDK Sample from the DesignerShell.cs file. For more information, see [Basic Designer Hosting Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet236"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet236"::: - ]]> @@ -1879,15 +1748,6 @@ ## Remarks View state is the accumulation of the values of the properties and child controls of a view. Property values are persisted to the stream after saving and can be restored using the method. - - - -## Examples - The following example demonstrates saving the view state for a object by creating a object using the `FileMode.Create` flag and passing it to the method. To load this view state at a later time, see . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet59"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet59"::: - ]]> @@ -1931,14 +1791,6 @@ ## Remarks The workflow view image is created as a bitmap. - - -## Examples - The following example shows how to save the currently loaded workflow image using a . In this example, a is created to prompt the user for the filename of the image to save. A object is then created using the filename and then passed to the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet63"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet63"::: - ]]> @@ -1975,14 +1827,6 @@ ## Remarks The workflow view image is created as a bitmap. - - -## Examples - The following example shows how to save the currently loaded workflow image using a . In this example, a is created to prompt the user for the filename of the image to save. The filename and the `ImageFormat.Bmp` flag are then passed to the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet62"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet62"::: - ]]> @@ -2073,14 +1917,6 @@ ## Remarks Use the to get or adjust the location of the scrollbar in the design surface. - - -## Examples - The following example demonstrates setting the ScrollPosition property inside an implementation of a control's OnMouseMove method. This example is from the Outlook Workflow Wizard SDK sample. For more information, see [Outlook Workflow Wizard Sample](https://msdn.microsoft.com/library/7b2ba92b-8456-43f3-87fc-184ffdec4408). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet105"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet105"::: - ]]> @@ -2110,19 +1946,6 @@ ## Remarks Use the to get or adjust the shadow depth of text shown on the workflow design surface. - - -## Examples - The following code example demonstrates how you can obtain an instance of the class using the method. The code then sets several properties, including and , , and calls the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet48"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet48"::: - - The `UnloadWorkflow` method that is called in the code above removes a currently loaded workflow in order to prepare for the loading of a new workflow and is implemented as follows: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet49"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet49"::: - ]]> @@ -2286,14 +2109,6 @@ ## Remarks If the `serviceType` is `CommandID` this method will return a specific `CommandID`. For any other `Type`, `GetService` will return an Object that implements the requested service, or a null reference (`Nothing`) if the service cannot be resolved. - - -## Examples - The following example uses the method of the object to return an interface. If the service exists, is called passing the currently selected activity using the `PrimarySelection` property of the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet64"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet64"::: - ]]> @@ -2353,14 +2168,6 @@ ## Remarks The contains the visible area of the workflow. - - -## Examples - The following example shows a method of handling the Paint event of the object to draw an image directly on the . The property returns the viewable area on the design surface to correctly constrain the image being drawn. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet58"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet58"::: - ]]> @@ -2419,17 +2226,8 @@ ## Remarks Use to get the vertical scrollbar on the , which you can use to make user interface adjustments. - - -## Examples - The following code example demonstrates how you can obtain an instance of the class. The code then sets several properties, including and , and calls the method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet65"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet65"::: - ]]> - Workflow Tracking Profile Designer @@ -2494,16 +2292,6 @@ ## Remarks Use the zoom feature to enlarge or reduce the size of the components inside the . The sets the minimum and maximum zoom levels for the . - - -## Examples - The following example shows how to set the property of a . - - This code example is part of the Workflow Monitor SDK Sample from the MainForm.cs file. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet138"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet138"::: - ]]> If the zoom level is less than the minimum zoom level of the @@ -2538,18 +2326,8 @@ ## Remarks The workflow view image is created as a bitmap. - - -## Examples - The following code example demonstrates how you can assign a handler to the event. - - This code example is part of the Workflow Monitor SDK Sample from the ViewHost.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet136"::: - ]]> - Workflow Monitor diff --git a/xml/System.Workflow.ComponentModel/Activity.xml b/xml/System.Workflow.ComponentModel/Activity.xml index ebfa9ebc7ec..672d19a7778 100644 --- a/xml/System.Workflow.ComponentModel/Activity.xml +++ b/xml/System.Workflow.ComponentModel/Activity.xml @@ -80,7 +80,7 @@ ## Remarks > [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] An is the fundamental building block of workflows. An defines a set of properties and events, such as any class, along with execution logic that defines the activity's run-time behavior. A set of additional components can be associated with an . These include, but are not limited to a validator, a code generator, custom serializers, and a designer. @@ -88,33 +88,6 @@ The execution logic of an fulfills a contract that exists between any and the workflow runtime. You must document the execution logic of any in a functional sense, so that a workflow developer who uses the knows how it behaves. The execution logic itself is hidden from the workflow developer who includes the activity in a workflow, because the execution logic is part of a contract that exists strictly between the workflow runtime and the . - - -## Examples - This example defines an activity whose purpose is to send an email. The activity defines one property, `Subject`, that uses a dependency property in its implementation. Other properties can be defined in a similar way. The `Execute` method is overridden to provide the logic for sending the email. For a complete example, see the [Send Email Activity Sample](https://msdn.microsoft.com/library/bfb5939e-60a9-4037-af4e-2cea9e654669). - -```csharp -public class SendEmail : Activity -{ - public static readonly DependencyProperty SubjectProperty = - DependencyProperty.Register("Subject", typeof(string), typeof(SendEmail)); - - public string Subject - { - get { return base.GetValue(SubjectProperty) as string; } - set { base.SetValue(SubjectProperty, value); } - } - - // Define other properties... - - protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext) - { - // Logic to send the email goes here... - return ActivityExecutionStatus.Closed; - } -} -``` - ]]> @@ -143,19 +116,7 @@ public class SendEmail : Activity Initializes a new instance of the class. - - - + To be added. @@ -607,14 +568,6 @@ For more information about handling events, see [Handling and Raising Events](/d The running occurs synchronously, returning control to the caller when the activity is completed or reaches an intermediate state. - - -## Examples - The following code example shows an implementation of the `Execute` method. In this example, an Outlook email message is constructed and sent. This example is from the Outlook Workflow Wizard SDK sample. For more information, see [Outlook Workflow Wizard Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet98"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet98"::: - ]]> @@ -1256,16 +1209,6 @@ For more information about handling events, see [Handling and Raising Events](/d This property is a meta property, which means it cannot be changed at runtime. Meta properties do not change after a property instance is created at runtime, so the property must be set to a literal value at design time. - - -## Examples - The following code shows how to create activities and add them as children to a composite activity and set the value for . - - This code example is part of the Throw SDK sample and is from the ThrowWorkFlow.cs file. For more information, see [Throw Sample](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet179"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet179"::: - ]]> @@ -1456,19 +1399,7 @@ For more information about handling events, see [Handling and Raising Events](/d The source of the . The associated with the . Raises an associated with the specified dependency property. - - . - - This code example is part of the Send Email Activity sample and is from the SendEmailActivity.cs file. For more information, see [Send Email Activity Sample](https://msdn.microsoft.com/library/bfb5939e-60a9-4037-af4e-2cea9e654669) - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet233"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet233"::: - - ]]> - + To be added. @@ -1766,17 +1697,7 @@ For more information about handling events, see [Handling and Raising Events](/d that contains the tracking information. Informs the run-time tracking infrastructure of pending tracking information. - - - + To be added. is a null reference ( in Visual Basic). diff --git a/xml/System.Workflow.ComponentModel/ActivityBind.xml b/xml/System.Workflow.ComponentModel/ActivityBind.xml index b184972e7ef..c60148cba59 100644 --- a/xml/System.Workflow.ComponentModel/ActivityBind.xml +++ b/xml/System.Workflow.ComponentModel/ActivityBind.xml @@ -80,19 +80,7 @@ Initializes a new instance of the class. - - . - - This code example is part of the Throw Activity SDK sample and is from the ThrowActivity.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet178"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet178"::: - - ]]> - + To be added. @@ -138,19 +126,7 @@ The name of the . The path of the new . Initializes a new instance of the class with and parameters. - - . - - The code example is part of the Throw Activity SDK sample and is from the ThrowActivity.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet178"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet178"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel/ActivityCollection.xml b/xml/System.Workflow.ComponentModel/ActivityCollection.xml index d127ed05d4a..1dfa85c414f 100644 --- a/xml/System.Workflow.ComponentModel/ActivityCollection.xml +++ b/xml/System.Workflow.ComponentModel/ActivityCollection.xml @@ -68,14 +68,6 @@ > [!NOTE] > Only call methods derived from and not , such as using to add activities instead of . Calling methods derived from will have unexpected consequences. - - -## Examples - The following example shows access of the which is the member of a composite activity class containing all child activities. This code example is part of the Using Throw SDK Sample and is from the ThrowWorkflow.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet179"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet179"::: - ]]> @@ -138,17 +130,7 @@ The to be added to the . Adds the to the . - - which is the member of a composite activity class containing all child activities. This example illustrates the use of . This code example is part of the Throw SDK sample and is from the ThrowWorkflow.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet179"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet179"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel/CompensatableTransactionScopeActivity.xml b/xml/System.Workflow.ComponentModel/CompensatableTransactionScopeActivity.xml index 495dfabeeb9..57b2379ceea 100644 --- a/xml/System.Workflow.ComponentModel/CompensatableTransactionScopeActivity.xml +++ b/xml/System.Workflow.ComponentModel/CompensatableTransactionScopeActivity.xml @@ -108,18 +108,7 @@ The user-defined name of the activity. Initializes a new instance of the class using the name of the activity. - - object. This example is from the Compensation SDK sample. For more information, see [Compensation Sample](https://msdn.microsoft.com/library/c847a694-9978-46af-aa80-5bd1833f813b). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet148"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet148"::: - - ]]> - - Using the CompensatableTransactionScopeActivity Activity + To be added. @@ -318,18 +307,7 @@ Gets the associated with this instance. The associated with this instance. - - - - Using the CompensatableTransactionScopeActivity Activity + To be added. diff --git a/xml/System.Workflow.ComponentModel/CompensateActivity.xml b/xml/System.Workflow.ComponentModel/CompensateActivity.xml index a51c8ee8d82..6b341f244c8 100644 --- a/xml/System.Workflow.ComponentModel/CompensateActivity.xml +++ b/xml/System.Workflow.ComponentModel/CompensateActivity.xml @@ -43,15 +43,15 @@ Triggers the compensation of a completed child that implements the interface. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Any that implements is compensatable. A compensatable activity is a valid target of a , as long as that activity is a child of the associated with the . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Any that implements is compensatable. A compensatable activity is a valid target of a , as long as that activity is a child of the associated with the . + ]]> @@ -80,17 +80,7 @@ Initializes a new instance of the class. - - object. This example is from the Compensation SDK sample. For more information, see [Compensation Sample](https://msdn.microsoft.com/library/c847a694-9978-46af-aa80-5bd1833f813b). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet144"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet144"::: - - ]]> - + To be added. @@ -229,17 +219,7 @@ Gets or sets the name of the to compensate. A string that contains the name of the to compensate. - - - + To be added. @@ -261,11 +241,11 @@ Represents the that targets the property. - diff --git a/xml/System.Workflow.ComponentModel/CompensationHandlerActivity.xml b/xml/System.Workflow.ComponentModel/CompensationHandlerActivity.xml index 44761cc8b17..934b02b002f 100644 --- a/xml/System.Workflow.ComponentModel/CompensationHandlerActivity.xml +++ b/xml/System.Workflow.ComponentModel/CompensationHandlerActivity.xml @@ -47,15 +47,15 @@ Specifies workflow logic that undoes, or compensates for, the successful execution of the associated . This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Any definition can implement . The parent of a must implement this interface. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Any definition can implement . The parent of a must implement this interface. + ]]> @@ -84,17 +84,7 @@ Initializes a new instance of the class. - - - + To be added. diff --git a/xml/System.Workflow.ComponentModel/CompositeActivity.xml b/xml/System.Workflow.ComponentModel/CompositeActivity.xml index 3050814050b..458213c97b2 100644 --- a/xml/System.Workflow.ComponentModel/CompositeActivity.xml +++ b/xml/System.Workflow.ComponentModel/CompositeActivity.xml @@ -43,44 +43,17 @@ Derivative of that is the base class for all activities that contain other activities. A is responsible for managing the execution of its child activities. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A manages the execution of its child activities using class methods and events defined on the class. For example, a child activity is scheduled for execution using the of . A activity can be notified when a child activity completes its execution by subscribing to the event defined on . - - The workflow runtime enforces certain constraints on execution, the most fundamental of which is that a activity cannot move to the state if any child activities are still in a , , , or , state. - - - -## Examples - This example shows a basic `CompositeActivity` that executes its first child activity for execution. When the child activity moves to the Closed state, the composite activity is notified and then completes its execution. - -```csharp -public class HasOneChildActivity : CompositeActivity -{ - protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext) - { - Activity child = this.EnabledActivities[0]; - child.Closed += this.ChildClosed; - executionContext.ExecuteActivity(child); - - return ActivityExecutionStatus.Executing; - } - - void ChildClosed(object sender, ActivityExecutionStatusChangedEventArgs e) - { - e.Activity.Closed -= this.ChildClosed; - ActivityExecutionContext executionContext = sender as ActivityExecutionContext; - - executionContext.CloseActivity(); - } -} -``` - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A manages the execution of its child activities using class methods and events defined on the class. For example, a child activity is scheduled for execution using the of . A activity can be notified when a child activity completes its execution by subscribing to the event defined on . + + The workflow runtime enforces certain constraints on execution, the most fundamental of which is that a activity cannot move to the state if any child activities are still in a , , , or , state. + ]]> @@ -189,21 +162,11 @@ public class HasOneChildActivity : CompositeActivity of all child activities. - permissive for this type. - - This code example is part of the Throw SDK sample and is from the ThrowWorkFlow.cs file. For more information, see [Throw Sample](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet179"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet179"::: - + @@ -255,19 +218,7 @@ public class HasOneChildActivity : CompositeActivity Gets or sets a value which controls whether the individual activities within can be modified. if the individual activities within can be modified; otherwise . - - permissive for this type. - - This code example is part of the Throw SDK sample and is from the ThrowWorkFlow.cs file. For more information, see [Throw Sample](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet179"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet179"::: - - ]]> - + To be added. @@ -294,11 +245,11 @@ public class HasOneChildActivity : CompositeActivity to release both managed and unmanaged resources used by this instance and all child activities of this instance; to release only the unmanaged resources of this instance. Calls on this instance, and optionally calls on all child activities of this instance. - method is called on each activity). When the workflow instance is loaded back into memory, a new .NET object is created for each activity with the state from the corresponding unload. - + method is called on each activity). When the workflow instance is loaded back into memory, a new .NET object is created for each activity with the state from the corresponding unload. + ]]> @@ -480,11 +431,11 @@ public class HasOneChildActivity : CompositeActivity The specified . Called when an activity is removed. - @@ -613,11 +564,11 @@ public class HasOneChildActivity : CompositeActivity The associated with this instance. Called after changes have been made to the collection of this instance. - @@ -645,11 +596,11 @@ public class HasOneChildActivity : CompositeActivity An that implements and provides services to this instance. Called by the workflow runtime engine when an activity transitions into the state from the state. - diff --git a/xml/System.Workflow.ComponentModel/DependencyObject.xml b/xml/System.Workflow.ComponentModel/DependencyObject.xml index bc4b7a74623..6b3798a4f36 100644 --- a/xml/System.Workflow.ComponentModel/DependencyObject.xml +++ b/xml/System.Workflow.ComponentModel/DependencyObject.xml @@ -38,13 +38,13 @@ The base class for all objects that have dependency properties. This class must be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -92,19 +92,11 @@ The that represents the value of this property. In this case, a type. Adds a handler for an event of a . - Either of the arguments is a null reference ( in Visual Basic). @@ -229,11 +221,11 @@ The represents a non-event to clean up any unmanaged resources deterministically. - @@ -296,11 +288,11 @@ The represents a non-event that is the subject of an . The that is the subject of an . - that is the subject of an . When overridden in a derived class, this method can be used to customize the way in which a specified binding is resolved. - + that is the subject of an . When overridden in a derived class, this method can be used to customize the way in which a specified binding is resolved. + ]]> @@ -369,19 +361,11 @@ The represents a non-event . The object that represents the value of the designated . - to return the value represented by a named dependency property in the context of get and set. This code example is part of the Send Email SDK sample and is from the SendMailActivity.cs file. For more information, see [Send Email Activity Sample](https://msdn.microsoft.com/library/bfb5939e-60a9-4037-af4e-2cea9e654669). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet231"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet231"::: - + @@ -416,13 +400,13 @@ The represents a non-event and bypasses the override. The bound object of a . This bypasses the override. - override implementation. Typically, the override code invokes the , and then adds additional code. - - For implementing the override, can be used in / calls. - + override implementation. Typically, the override code invokes the , and then adds additional code. + + For implementing the override, can be used in / calls. + ]]> @@ -449,11 +433,11 @@ The represents a non-event @@ -512,11 +496,11 @@ The represents a non-event if the are equal; otherwise, . - . - + . + ]]> @@ -568,21 +552,13 @@ The represents a non-event The that represents the value of this property. In this case, a type. Removes an from an associated . - Either of the arguments is a null reference ( in Visual Basic). @@ -647,25 +623,13 @@ The is not an event. The to set to. Sets the for the specified . - sets the value directly to the . Similarly, adds a handler directly to properties of type event. - - These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . - - - -## Examples - The following code shows how to create activities and add them as children to a composite activity and includes setting the permission for this type. - - In addition, the use of the method is illustrated. - - This code example is part of the Throw SDK sample and is from the ThrowWorkFlow.cs file. For more information, see [Using Throw](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet215"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet215"::: - + sets the value directly to the . Similarly, adds a handler directly to properties of type event. + + These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . + ]]> Either of the arguments is a null reference ( in Visual Basic). @@ -761,23 +725,15 @@ The is not an event. The to set the value to. Sets the value of the to the object. - sets a binding for the dependency property. - - sets a value directly to the (similarly, adds a handler directly to properties of type event). - - These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . - - - -## Examples - The following code shows how a dependency property is set within a dependency object using . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet166"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet166"::: - + sets a binding for the dependency property. + + sets a value directly to the (similarly, adds a handler directly to properties of type event). + + These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . + ]]> @@ -813,13 +769,13 @@ The is not an event. The that becomes the value of the . Sets the value of the to the specified , bypassing the . - override implementation. Typically, the override code would do some custom logic before calling the method. - - For setting a override, can be used in , , or calls. - + override implementation. Typically, the override code would do some custom logic before calling the method. + + For setting a override, can be used in , , or calls. + ]]> @@ -888,7 +844,7 @@ The is not an event. @@ -925,13 +881,13 @@ When you create a Disposed delegate, you identify the method that handles the ev Gets an that associates custom data with this class instance. A dictionary that acts as an extensibility hook for developers to manipulate declarations for a design tool and associate custom data with individual activity declarations. - declaration implementations provided by Windows Workflow Foundation. This collection is not serialized; data that the collection contains is not persisted from design time to run time. - + declaration implementations provided by Windows Workflow Foundation. This collection is not serialized; data that the collection contains is not persisted from design time to run time. + ]]> diff --git a/xml/System.Workflow.ComponentModel/DependencyProperty.xml b/xml/System.Workflow.ComponentModel/DependencyProperty.xml index e985b690e13..278ee51d580 100644 --- a/xml/System.Workflow.ComponentModel/DependencyProperty.xml +++ b/xml/System.Workflow.ComponentModel/DependencyProperty.xml @@ -31,23 +31,15 @@ A special kind of property that can be defined or attached to a . There are three kinds of dependency properties: instance properties, meta properties, and attached properties. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Dependency properties support three use cases. First, if an instance property of an activity is implemented by using a dependency property, that property can be assigned an instead of an actual value. Second, activity properties that are metadata (that is, the value cannot change at run time) should be implemented by using dependency properties, specifying the option. Third, dependency properties support attached properties, which are properties that are applied to dependency objects dynamically. - - - -## Examples - The following example shows how to register a for use by a . This code example is part of the Send Email SDK sample and is from the SendMailActivity.cs file. For more information, see [Send Mail Activity](https://msdn.microsoft.com/library/bfb5939e-60a9-4037-af4e-2cea9e654669). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet230"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet230"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Dependency properties support three use cases. First, if an instance property of an activity is implemented by using a dependency property, that property can be assigned an instead of an actual value. Second, activity properties that are metadata (that is, the value cannot change at run time) should be implemented by using dependency properties, specifying the option. Third, dependency properties support attached properties, which are properties that are applied to dependency objects dynamically. + ]]> @@ -150,11 +142,11 @@ Returns the hash code for this instance. A hash code for this instance. - , and attributes of this . - + , and attributes of this . + ]]> @@ -180,11 +172,11 @@ if attached to a ; otherwise, . - has been registered by using the method. - + has been registered by using the method. + ]]> @@ -315,17 +307,7 @@ Owner of the dependency property. Initializes a new instance of the class that has the properties parameterized according to the input parameters. The class that has the properties parameterized according to the input parameters. - - for use by a . This code example is part of the Send Email SDK Sample and is from the SendMailActivity.cs file. For more information, see [Send Mail Activity](https://msdn.microsoft.com/library/bfb5939e-60a9-4037-af4e-2cea9e654669). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet230"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet230"::: - - ]]> - + To be added. @@ -521,11 +503,11 @@ Overrides the method to return the property value. The property value. - . - + . + ]]> diff --git a/xml/System.Workflow.ComponentModel/FaultHandlerActivity.xml b/xml/System.Workflow.ComponentModel/FaultHandlerActivity.xml index 21065015168..a13eecac81b 100644 --- a/xml/System.Workflow.ComponentModel/FaultHandlerActivity.xml +++ b/xml/System.Workflow.ComponentModel/FaultHandlerActivity.xml @@ -86,17 +86,7 @@ Initializes a new instance of the class. - - class. This example is from the Compensation SDK sample. For more information, see [Compensation Sample](https://msdn.microsoft.com/library/c847a694-9978-46af-aa80-5bd1833f813b). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet145"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet145"::: - - ]]> - + To be added. @@ -242,14 +232,6 @@ ## Remarks This property must be set to use the . - - -## Examples - The following example shows how to set the `FaultType` property. This example is from the Compensation SDK sample. For more information, see [Compensation Sample](https://msdn.microsoft.com/library/c847a694-9978-46af-aa80-5bd1833f813b). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet151"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet151"::: - ]]> diff --git a/xml/System.Workflow.ComponentModel/SuspendActivity.xml b/xml/System.Workflow.ComponentModel/SuspendActivity.xml index 5c93a436aa5..f444fa65e3f 100644 --- a/xml/System.Workflow.ComponentModel/SuspendActivity.xml +++ b/xml/System.Workflow.ComponentModel/SuspendActivity.xml @@ -39,17 +39,17 @@ Suspends the running workflow instance when executed. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - causes a running workflow instance to pause in running, perhaps to reflect an error condition that requires attention beyond the scope of the workflow. All the state information for the workflow instance is saved, and will be reinstated when the administrator resumes the workflow instance. - - You cannot include a inside an atomic transaction. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + causes a running workflow instance to pause in running, perhaps to reflect an error condition that requires attention beyond the scope of the workflow. All the state information for the workflow instance is saved, and will be reinstated when the administrator resumes the workflow instance. + + You cannot include a inside an atomic transaction. + ]]> @@ -70,25 +70,15 @@ Initializes a new instance of the class. - class. - -|Property|Value| -|--------------|-----------| -||`Null` (`Nothing` in Visual Basic).| - - - -## Examples - This example illustrates using the constructor for a , and other things discussed elsewhere within this type. - - This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173"::: - + class. + +|Property|Value| +|--------------|-----------| +||`Null` (`Nothing` in Visual Basic).| + ]]> @@ -149,21 +139,11 @@ Gets or sets an error message to report to administrators providing the reason for suspension. An error message that provides the reason for the workflow instance suspension. The default value is . - property of a , and other concepts discussed elsewhere in this type. - - This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173"::: - + @@ -187,11 +167,11 @@ Represents the that targets the property. - diff --git a/xml/System.Workflow.ComponentModel/SynchronizationScopeActivity.xml b/xml/System.Workflow.ComponentModel/SynchronizationScopeActivity.xml index 64409f2ec4c..a334155480d 100644 --- a/xml/System.Workflow.ComponentModel/SynchronizationScopeActivity.xml +++ b/xml/System.Workflow.ComponentModel/SynchronizationScopeActivity.xml @@ -39,13 +39,13 @@ Represents a section of workflow that requires controlled access to shared variables. If two or more instances of a access the same variables, then the execution of these activities is effectively serialized. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -74,17 +74,7 @@ Initializes a new instance of the class. - - object. This example is from the Nested Exception Handlers SDK sample. For more information, see [Nested Exception Handlers Sample](https://msdn.microsoft.com/library/d1da0209-842b-41c8-9b7c-0cbaa1034265). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet162"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet162"::: - - ]]> - + To be added. @@ -242,17 +232,7 @@ Gets or sets a collection of strings that represents handles that determine the synchronization behavior of this . When two or more activities share a synchronization handle, they execute in a serial fashion; there is no interleaved execution of the child activities within them. A multiline string that contains synchronization handles for this instance. - - - + To be added. diff --git a/xml/System.Workflow.ComponentModel/TerminateActivity.xml b/xml/System.Workflow.ComponentModel/TerminateActivity.xml index 709f91d3295..d26f6c8aa22 100644 --- a/xml/System.Workflow.ComponentModel/TerminateActivity.xml +++ b/xml/System.Workflow.ComponentModel/TerminateActivity.xml @@ -35,15 +35,15 @@ Terminates the running workflow instance when an abnormal situation occurs. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - immediately ends the execution of the current workflow instance. Unlike a suspended workflow instance, a terminated workflow instance can never be resumed. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + immediately ends the execution of the current workflow instance. Unlike a suspended workflow instance, a terminated workflow instance can never be resumed. + ]]> @@ -64,25 +64,15 @@ Initializes a new instance of the class. - class. - -|Property|Value| -|--------------|-----------| -||null (`Nothing` in Visual Basic).| - - - -## Examples - This example illustrates using the constructor for a , and other things discussed elsewhere within this type. - - This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173"::: - + class. + +|Property|Value| +|--------------|-----------| +||null (`Nothing` in Visual Basic).| + ]]> @@ -143,21 +133,13 @@ Gets or sets an error message to report to administrators, providing the reason for termination. An error message that provides the reason for the workflow instance termination. The default value is . - property is set to `false`) a is thrown. - - Propagation of this error message is determined by the host (the instance manager or the persistence provider). - - - -## Examples - The following example demonstrates setting the Error property. This example is from the Suspend and Terminate SDK sample. For more information, see [Suspend and Terminate Sample](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet176"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet176"::: - + property is set to `false`) a is thrown. + + Propagation of this error message is determined by the host (the instance manager or the persistence provider). + ]]> @@ -180,19 +162,7 @@ Represents the that targets the property. - - property for a , and other things discussed elsewhere within this type. - - This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.ComponentModel/ThrowActivity.xml b/xml/System.Workflow.ComponentModel/ThrowActivity.xml index d769f478604..f8935345d1b 100644 --- a/xml/System.Workflow.ComponentModel/ThrowActivity.xml +++ b/xml/System.Workflow.ComponentModel/ThrowActivity.xml @@ -42,23 +42,15 @@ Models the throwing of an exception. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The purpose of the is to allow declarative modeling of the throwing of an exception. The is functionally equivalent to a activity whose code-beside handler throws the indicated exception. - - - -## Examples - The following code shows the use of a single throw activity in a workflow to implement exception handling. This code example is part of the Throw SDK sample and is from the ThrowWorkflow.cs file. For more information, see [Using Throw](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet178"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet178"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The purpose of the is to allow declarative modeling of the throwing of an exception. The is functionally equivalent to a activity whose code-beside handler throws the indicated exception. + ]]> @@ -87,17 +79,7 @@ Initializes a new instance of the class. - - - + To be added. @@ -184,11 +166,11 @@ Gets or sets the exception object that should be thrown by the . The associated with this instance. - @@ -218,11 +200,11 @@ The representing the property for this instance. - @@ -264,17 +246,7 @@ Gets or sets the type of exception that should be thrown by the . The type representing the fault associated with this instance. - - to `null`. This code example is part of the Throw SDK sample and is from the ThrowWorkflow.cs file. For more information, see [Using Throw](https://msdn.microsoft.com/library/aa5b9546-ec95-4e43-8337-20e26f8d71cc). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet178"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet178"::: - - ]]> - + To be added. @@ -302,13 +274,13 @@ The representing the property for this instance. - @@ -425,11 +397,11 @@ Returns the access type for the specified property. An enumeration value denoting the access level of the property. - @@ -463,11 +435,11 @@ Returns the of the specified property. The for the property whose name is passed as the parameter. - diff --git a/xml/System.Workflow.ComponentModel/WorkflowChanges.xml b/xml/System.Workflow.ComponentModel/WorkflowChanges.xml index 32189734502..dd9e1558ec9 100644 --- a/xml/System.Workflow.ComponentModel/WorkflowChanges.xml +++ b/xml/System.Workflow.ComponentModel/WorkflowChanges.xml @@ -34,17 +34,8 @@ When a object is constructed in application code (outside the workflow instance), the object that is passed to the constructor must be the object that is returned by the method of the class. - - -## Examples - The following example demonstrates creating a new instance of a object. This example is from the Ordering State Machine SDK sample. For more information, see [Ordering State Machine Sample](https://msdn.microsoft.com/library/59272cf4-bc98-439c-bcfa-b66999ebce5c). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet87"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet87"::: - ]]> - Using Workflow Changes in Workflows @@ -205,17 +196,7 @@ Returns a cloned activity tree to which changes can be made and then applied to the running workflow instance. A that contains the cloned root activity for the workflow. - - - + To be added. diff --git a/xml/System.Workflow.ComponentModel/WorkflowParameterBinding.xml b/xml/System.Workflow.ComponentModel/WorkflowParameterBinding.xml index edbf3c2ed94..80a9ebdfdf8 100644 --- a/xml/System.Workflow.ComponentModel/WorkflowParameterBinding.xml +++ b/xml/System.Workflow.ComponentModel/WorkflowParameterBinding.xml @@ -31,15 +31,15 @@ A general-purpose class that represents a binding to a named parameter. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The binding is to the source of an `in` parameter, or the target of an `out` parameter. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The binding is to the source of an `in` parameter, or the target of an `out` parameter. + ]]> @@ -68,17 +68,7 @@ Initializes a new instance of the class. - - object. This example is from the Ordering State Machine SDK sample. For more information, see [Ordering State Machine Sample](https://msdn.microsoft.com/library/59272cf4-bc98-439c-bcfa-b66999ebce5c). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet90"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet90"::: - - ]]> - + To be added. @@ -123,11 +113,11 @@ Gets or sets the property. Represents the name of the parameter being bound. The name of the parameter being bound. - @@ -151,13 +141,13 @@ The dependency property which targets . - . This is the `public static field` named `XProperty`, respectively `XEvent`, where X is the corresponding `property`,respectively `event`. - - [!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)] - + . This is the `public static field` named `XProperty`, respectively `XEvent`, where X is the corresponding `property`,respectively `event`. + + [!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)] + ]]> @@ -209,20 +199,13 @@ The dependency property which targets . - . This is the `public static field` named `XProperty`, respectively `XEvent`, where X is the corresponding `property`, respectively `event`. - - [!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)] - - - -## Examples - The following sample demonstrates accessing the ValueProperty field. This example is from the Host Communication SDK sample. For more information, see [Host Communication Sample](https://msdn.microsoft.com/library/ce4b0b8c-bfa3-4c24-b85a-5835a440ea8f). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets38.cs" id="Snippet300"::: - + . This is the `public static field` named `XProperty`, respectively `XEvent`, where X is the corresponding `property`, respectively `event`. + + [!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)] + ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml b/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml index a4742b28e3c..ec70f7c452e 100644 --- a/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml @@ -23,15 +23,15 @@ Provides functionality for constructing client-side channels, caching channels, and channel factories. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The is responsible for creating a channel for a based on the channel token defined in the activity's . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The is responsible for creating a channel for a based on the channel token defined in the activity's . + ]]> @@ -60,17 +60,7 @@ Initializes a new instance of the class. - - object. This example was adapted from the `SequentialWorkflowService` SDK sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet0"::: - - ]]> - + To be added. @@ -93,21 +83,13 @@ A collection of service endpoints. Initializes a new instance of the class. - class are usually created by the runtime using configuration files. - - The endpoints defined in the service's constructor will be used to create channels that match the configuration name in the . The endpoints defined in the configuration take precedence over the endpoints defined in code, so if a service endpoint added through code has the same name and contract type as one in the configuration file, then the endpoint defined in code will not be used. - - - -## Examples - The following example demonstrates how to create a new instance of the object. This example was adapted from the `WorkflowServiceUtility` SDK sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet1"::: - + class are usually created by the runtime using configuration files. + + The endpoints defined in the service's constructor will be used to create channels that match the configuration name in the . The endpoints defined in the configuration take precedence over the endpoints defined in code, so if a service endpoint added through code has the same name and contract type as one in the configuration file, then the endpoint defined in code will not be used. + ]]> @@ -132,27 +114,17 @@ Configuration parameters for the service. Initializes a new instance of the class. - that a cached channel can be idle. - -- `leaseTimeout`: The maximum that a cached channel can be checked out or in use by a . - -- `maxIdleChannelsPerEndpoint`: The maximum number of idle channels matching a single endpoint that can be cached at any point. - - Instances of the class are usually created by the runtime using configuration files. - - - -## Examples - The following example demonstrates how to create a new instance of the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet2"::: - + that a cached channel can be idle. +- `leaseTimeout`: The maximum that a cached channel can be checked out or in use by a . +- `maxIdleChannelsPerEndpoint`: The maximum number of idle channels matching a single endpoint that can be cached at any point. + + Instances of the class are usually created by the runtime using configuration files. + ]]> @@ -176,17 +148,7 @@ Settings for quotas for the pool of channels managed by this service. Initializes a new instance of the class. - - object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet3"::: - - ]]> - + To be added. @@ -210,17 +172,7 @@ Settings for quotas for the pool of channels managed by this service. A collection of service endpoints. Initializes a new instance of the class. - - object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet4"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowCommitWorkBatchService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowCommitWorkBatchService.xml index 9ae356dbee6..9a192a1b4da 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowCommitWorkBatchService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowCommitWorkBatchService.xml @@ -23,25 +23,17 @@ Allows custom logic for the commitment of work batches. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When a work batch is committed the runtime calls into the and gives it a delegate to call to do the actual committing of the work batch. The runtime still has the primary responsibility of committing the work batch but allows the to insert itself in the process for customization around the commit process. - - This process allows custom error handling logic. If the owns the transaction, which is the case when the property returns `null` therefore necessitating the need to create a new ambient transaction, it is allowed to call the delegate more than once, creating a new transaction for each call. The most common case for this for example is to handle intermittent network problems or SQL cluster failovers. If the call to the throws an exception can catch this exception, start a new transaction and call the delegate again. This gives a level of resilience to workflow instance execution that otherwise would cause workflows to terminate. - - - -## Examples - The following example demonstrates a class that inherits from . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet0"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When a work batch is committed the runtime calls into the and gives it a delegate to call to do the actual committing of the work batch. The runtime still has the primary responsibility of committing the work batch but allows the to insert itself in the process for customization around the commit process. + + This process allows custom error handling logic. If the owns the transaction, which is the case when the property returns `null` therefore necessitating the need to create a new ambient transaction, it is allowed to call the delegate more than once, creating a new transaction for each call. The most common case for this for example is to handle intermittent network problems or SQL cluster failovers. If the call to the throws an exception can catch this exception, start a new transaction and call the delegate again. This gives a level of resilience to workflow instance execution that otherwise would cause workflows to terminate. + ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml index 684e90da2e2..2d15a49691c 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml @@ -23,23 +23,23 @@ The abstract base class from which all persistence services are derived. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When certain conditions occur while the workflow is running, the workflow runtime engine persists state information about the workflow instance. Persistence can occur, for example, when an atomic transaction finishes, when the workflow instance becomes idle, when the host calls on the workflow instance, or when a workflow instance is terminated or finishes. When the workflow runtime engine semantics dictate that persistence should occur, the workflow runtime engine calls methods that are supplied by a persistence service to save state information about the workflow instance. Likewise, when the workflow runtime engine needs to restore a previously persisted workflow instance, it calls methods that are supplied by the persistence service to load this state information. The workflow runtime engine handles all the semantics regarding when to perform persistence. The persistence service handles actually saving and loading the workflow state information to or from a data store. - - You can create a persistence service by deriving a class from the class. You can add your persistence service to the workflow runtime engine by calling or by making an appropriate entry in the application configuration file. The should only contain one persistence service. Windows Workflow Foundation provides the class, an out-of-box persistence service, which you can use as is or extend. - - The workflow runtime engine has semantics for locking workflow state information for use in environments where persistence services that run in different processes might have access to a single data store. The class provides the capability to support this functionality of the workflow runtime engine by providing a parameter to that specifies whether the state information of a workflow instance should be unlocked in the data store, and by providing a method to unlock previously locked workflow state information. In a persistence service that implements locking, a call to should lock the state information for a workflow instance. - - Your persistence service should throw a if it fails to save state information to its data store or load state information from its data store. The workflow runtime engine expects this behavior. - - A batching mechanism is provided for services that use a durable store to save workflow state information. It is important in these cases to maintain consistency between the durable store that is used by the persistence service and the internal state of the workflow runtime engine. You can add functionality defined by the interface to your service, and then participate in workflow transaction batching provided by the by adding changes to your data store as work items to the . The durable store itself should implement the interface, so that workflow information is not persisted incorrectly in the event of a transaction rollback. For more information, see or . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When certain conditions occur while the workflow is running, the workflow runtime engine persists state information about the workflow instance. Persistence can occur, for example, when an atomic transaction finishes, when the workflow instance becomes idle, when the host calls on the workflow instance, or when a workflow instance is terminated or finishes. When the workflow runtime engine semantics dictate that persistence should occur, the workflow runtime engine calls methods that are supplied by a persistence service to save state information about the workflow instance. Likewise, when the workflow runtime engine needs to restore a previously persisted workflow instance, it calls methods that are supplied by the persistence service to load this state information. The workflow runtime engine handles all the semantics regarding when to perform persistence. The persistence service handles actually saving and loading the workflow state information to or from a data store. + + You can create a persistence service by deriving a class from the class. You can add your persistence service to the workflow runtime engine by calling or by making an appropriate entry in the application configuration file. The should only contain one persistence service. Windows Workflow Foundation provides the class, an out-of-box persistence service, which you can use as is or extend. + + The workflow runtime engine has semantics for locking workflow state information for use in environments where persistence services that run in different processes might have access to a single data store. The class provides the capability to support this functionality of the workflow runtime engine by providing a parameter to that specifies whether the state information of a workflow instance should be unlocked in the data store, and by providing a method to unlock previously locked workflow state information. In a persistence service that implements locking, a call to should lock the state information for a workflow instance. + + Your persistence service should throw a if it fails to save state information to its data store or load state information from its data store. The workflow runtime engine expects this behavior. + + A batching mechanism is provided for services that use a durable store to save workflow state information. It is important in these cases to maintain consistency between the durable store that is used by the persistence service and the internal state of the workflow runtime engine. You can add functionality defined by the interface to your service, and then participate in workflow transaction batching provided by the by adding changes to your data store as work items to the . The durable store itself should implement the interface, so that workflow information is not persisted incorrectly in the event of a transaction rollback. For more information, see or . + ]]> @@ -59,17 +59,7 @@ When implemented in a derived class, initializes a new instance of the class. - - - + To be added. @@ -203,21 +193,13 @@ When implemented in a derived class, loads the specified completed scope back into memory. An that represents the completed scope. - to implement compensation. You must restore an identical copy of the completed scope. To do this, you must restore a valid from your representation of the completed scope in the data store. Then you must pass this to one of the overloaded methods of to perform deserialization of the scope. - - If your persistence service cannot load the completed scope from its data store, it should throw a with an appropriate message. - - - -## Examples - The following example demonstrates an implementation of the `LoadCompletedContextActivity` method. This example is from the Custom Persistence Service sample, from the FilePersistenceService.cs file. For more information, see [Custom Persistence Service Sample](https://msdn.microsoft.com/library/869dfadf-5298-4551-bc80-f4cf7918729d). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet269"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet269"::: - + to implement compensation. You must restore an identical copy of the completed scope. To do this, you must restore a valid from your representation of the completed scope in the data store. Then you must pass this to one of the overloaded methods of to perform deserialization of the scope. + + If your persistence service cannot load the completed scope from its data store, it should throw a with an appropriate message. + ]]> @@ -246,21 +228,13 @@ When implemented in a derived class, loads the specified state of the workflow instance back into memory. An that represents the root activity of the workflow instance. - from your representation of the workflow instance in the data store; then you must pass this to one of the overloaded methods to deserialize the workflow instance state. If your persistence service cannot load the workflow instance state from its data store, it should throw a with an appropriate message. - - The workflow runtime engine implements locking semantics to restrict access to a workflow instance state that is saved in a data store. This can be accessed by persistence services that run in multiple processes. The locking semantics are designed to prevent persistence services that run in two different processes from loading the same workflow instance into memory at the same time. Depending on the type of environment that your persistence service is designed to support, you may choose whether to support this functionality. If you choose to support the runtime locking semantics, and if this workflow instance state has been previously locked by another process, then you should throw a . Otherwise, you should lock access to the workflow instance state in your data store. The workflow instance state can be unlocked by a call to or a call to with the unlock parameter set to `true`. - - - -## Examples - The following example demonstrates an implementation of the `LoadWorkflowInstanceState` method. This example is from the Custom Persistence Service sample, from the FilePersistenceService.cs file. For more information, see [Custom Persistence Service Sample](https://msdn.microsoft.com/library/869dfadf-5298-4551-bc80-f4cf7918729d). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet266"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet266"::: - + from your representation of the workflow instance in the data store; then you must pass this to one of the overloaded methods to deserialize the workflow instance state. If your persistence service cannot load the workflow instance state from its data store, it should throw a with an appropriate message. + + The workflow runtime engine implements locking semantics to restrict access to a workflow instance state that is saved in a data store. This can be accessed by persistence services that run in multiple processes. The locking semantics are designed to prevent persistence services that run in two different processes from loading the same workflow instance into memory at the same time. Depending on the type of environment that your persistence service is designed to support, you may choose whether to support this functionality. If you choose to support the runtime locking semantics, and if this workflow instance state has been previously locked by another process, then you should throw a . Otherwise, you should lock access to the workflow instance state in your data store. The workflow instance state can be unlocked by a call to or a call to with the unlock parameter set to `true`. + ]]> @@ -290,17 +264,7 @@ The outer , containing the to restore. Restores the from its serialized form. The restored . - - - + To be added. @@ -326,27 +290,19 @@ An that represents the completed scope. When implemented in a derived class, saves the specified completed scope to a data store. - methods to serialize `activity` into a ; you may then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the activity. - - You must be able to associate the completed scope with its enclosing workflow instance to mark the scope as unneeded in your data store when the workflow instance finishes or is terminated. Therefore, you should also save the of the workflow instance that is associated with the completed scope; this can be obtained from the property of the associated with `activity`. - - takes the of the completed scope as a parameter. Therefore, you must also save the property associated with `activity`. This property can be referenced through the field of `activity`. - - If you are implementing a persistence service that uses a durable store, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item to the property that represents the pending changes to the database, and implement the interface in your persistence service. - - If you cannot save the completed scope to your data store, you should throw a with an appropriate error message. - - - -## Examples - The following example demonstrates an implementation of the `SaveCompletedContextActivity` method. This example is from the Custom Persistence Service sample, from the FilePersistenceService.cs file. For more information, see [Custom Persistence Service Sample](https://msdn.microsoft.com/library/869dfadf-5298-4551-bc80-f4cf7918729d). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet268"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet268"::: - + methods to serialize `activity` into a ; you may then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the activity. + + You must be able to associate the completed scope with its enclosing workflow instance to mark the scope as unneeded in your data store when the workflow instance finishes or is terminated. Therefore, you should also save the of the workflow instance that is associated with the completed scope; this can be obtained from the property of the associated with `activity`. + + takes the of the completed scope as a parameter. Therefore, you must also save the property associated with `activity`. This property can be referenced through the field of `activity`. + + If you are implementing a persistence service that uses a durable store, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item to the property that represents the pending changes to the database, and implement the interface in your persistence service. + + If you cannot save the completed scope to your data store, you should throw a with an appropriate error message. + ]]> @@ -377,27 +333,19 @@ if the workflow instance should not be locked; if the workflow instance should be locked. When implemented in a derived class, saves the workflow instance state to a data store. - methods to serialize `rootActivity` into a . You can then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the root activity. If you cannot save the workflow instance state to your data store, you should throw a with an appropriate error message. - - The workflow runtime engine provides locking semantics to restrict access to a workflow instance state that is saved in the data store. This can be accessed by the persistence services running in multiple hosts and pointing to the same data store. The locking semantics are designed to prevent persistence services that run in two different workflow runtimes from loading the same workflow instance into memory at the same time. Depending on the type of environment your persistence service is designed to support, you can choose whether to support this functionality. If you choose to support the runtime locking semantics, then, if a persistence service tries to save a workflow instance state that has been previously locked by another persistence service, you should throw a . If `unlock` is `true`, you should unlock access to the workflow instance state after you save it. - - takes the of the workflow instance as a parameter. Therefore, you should save this . You can also use this to associate the workflow instance with the saved states of its completed scopes. You must do this because you must be able to mark these completed scopes as unneeded when the workflow instance completes. - - The workflow runtime engine calls a final time when the workflow instance is completed or terminated. Therefore, if is equal to or , you can safely delete the workflow instance and all its associated completed scopes from your data store. Alternatively, you can subscribe to the or events to determine when it is safe to delete records associated with the workflow instance. Whether you actually delete the records from your data store depends on your implementation. - - If you implement a persistence service that uses a durable store, then, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item that represents the pending changes to your durable store to the property, and implement the interface in your persistence service. - - - -## Examples - The following example demonstrates an implementation of the `SaveWorkflowInstanceState` method. This example is from the Custom Persistence Service sample, from the FilePersistenceService.cs file. For more information, see [Custom Persistence Service Sample](https://msdn.microsoft.com/library/869dfadf-5298-4551-bc80-f4cf7918729d). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet264"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet264"::: - + methods to serialize `rootActivity` into a . You can then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the root activity. If you cannot save the workflow instance state to your data store, you should throw a with an appropriate error message. + + The workflow runtime engine provides locking semantics to restrict access to a workflow instance state that is saved in the data store. This can be accessed by the persistence services running in multiple hosts and pointing to the same data store. The locking semantics are designed to prevent persistence services that run in two different workflow runtimes from loading the same workflow instance into memory at the same time. Depending on the type of environment your persistence service is designed to support, you can choose whether to support this functionality. If you choose to support the runtime locking semantics, then, if a persistence service tries to save a workflow instance state that has been previously locked by another persistence service, you should throw a . If `unlock` is `true`, you should unlock access to the workflow instance state after you save it. + + takes the of the workflow instance as a parameter. Therefore, you should save this . You can also use this to associate the workflow instance with the saved states of its completed scopes. You must do this because you must be able to mark these completed scopes as unneeded when the workflow instance completes. + + The workflow runtime engine calls a final time when the workflow instance is completed or terminated. Therefore, if is equal to or , you can safely delete the workflow instance and all its associated completed scopes from your data store. Alternatively, you can subscribe to the or events to determine when it is safe to delete records associated with the workflow instance. Whether you actually delete the records from your data store depends on your implementation. + + If you implement a persistence service that uses a durable store, then, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item that represents the pending changes to your durable store to the property, and implement the interface in your persistence service. + ]]> @@ -425,17 +373,7 @@ An that represents the completed scope. Determines whether a workflow should be unloaded when idle. If , the workflow runtime engine unloads the specified workflow when it becomes idle. - - - + To be added. @@ -461,21 +399,13 @@ The root activity of the workflow instance. When overridden in a derived class, unlocks the workflow instance state. - method based on the value of the unlock parameter. - - - -## Examples - The following example demonstrates an implementation of the `UnlockWorkflowInstanceState` method. This example is from the Custom Persistence Service sample, from the FilePersistenceService.cs file. For more information, see [Custom Persistence Service Sample](https://msdn.microsoft.com/library/869dfadf-5298-4551-bc80-f4cf7918729d). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet267"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet267"::: - + method based on the value of the unlock parameter. + ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml index e75467ed801..82f87917b25 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml @@ -230,14 +230,6 @@ should only be called by the workflow runtime engine. - - -## Examples - The following example demonstrates calling the Start method on an object derived from , TerminationTrackingService. This example is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet112"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet112"::: - ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml index 8de8c037b3c..266acd97ffe 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml @@ -23,15 +23,15 @@ Provides a mechanism to implement your own thread pool to execute the workflow and manage in-memory timer registration and events. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - is that base class for all classes that create threads that run workflow instances on the workflow runtime engine host. These include and . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + is that base class for all classes that create threads that run workflow instances on the workflow runtime engine host. These include and . + ]]> @@ -54,17 +54,7 @@ When implemented in a derived class, initializes a new instance of the class. - - object (that inherits from ) and adding it to the runtime. This example is from the Nested Exception Handlers SDK sample, from the Program.cs file. For more information, see [Nested Exception Handlers Sample](https://msdn.microsoft.com/library/d1da0209-842b-41c8-9b7c-0cbaa1034265). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet161"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet161"::: - - ]]> - + To be added. @@ -90,11 +80,11 @@ The associated with the existing scheduled thread to cancel. When overridden in a derived class, cancels the scheduled work item with the given . - removes from the pending work items queue a previous request to schedule a workflow instance. - + removes from the pending work items queue a previous request to schedule a workflow instance. + ]]> @@ -133,11 +123,11 @@ A that represents the workflow instance. When overridden in a derived class, this method is called by the runtime to schedule a work item (callback) for a particular instance ID. - constructor to create your delegate method to run in the new thread. - + constructor to create your delegate method to run in the new thread. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml index ee7f2740bc9..ee6ae54f19a 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml @@ -23,21 +23,21 @@ Defines a point, associated with an activity execution status change, to be tracked that is in the potential execution path of a workflow instance. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Whenever the execution status of an activity changes, the workflow instance emits an activity status event to the runtime tracking infrastructure. An defines a point of interest in the potential execution path of a workflow, qualified by such an activity status event. An contains locations that are included in matching, locations that are excluded from matching, and the data that should be extracted from the workflow instance when the track point is matched. You can add an to to instruct the runtime tracking infrastructure to send an to the tracking service when the specified set of activity status events occur. A single may be matched at multiple points in the workflow instance. - - An contains match conditions for a location or locations in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching by the track point. Similarly, you can add objects to to define locations that should be excluded from matching by the track point. - - You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be included in the . - - You can add to to specify additional information associated with the track point. These annotations will be included in the sent when the track point is matched. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Whenever the execution status of an activity changes, the workflow instance emits an activity status event to the runtime tracking infrastructure. An defines a point of interest in the potential execution path of a workflow, qualified by such an activity status event. An contains locations that are included in matching, locations that are excluded from matching, and the data that should be extracted from the workflow instance when the track point is matched. You can add an to to instruct the runtime tracking infrastructure to send an to the tracking service when the specified set of activity status events occur. A single may be matched at multiple points in the workflow instance. + + An contains match conditions for a location or locations in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching by the track point. Similarly, you can add objects to to define locations that should be excluded from matching by the track point. + + You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be included in the . + + You can add to to specify additional information associated with the track point. These annotations will be included in the sent when the track point is matched. + ]]> @@ -58,11 +58,11 @@ Initializes a new instance of the class. - to . You may optionally add objects to , , and . - + to . You may optionally add objects to , , and . + ]]> @@ -87,13 +87,13 @@ Gets the collection of annotations associated with the track point. An . The default is an empty collection. - to specify annotations to be returned in the sent to the tracking service when the track point is matched. If is empty, no annotations are associated with the track point. - - Annotations are `strings` that you define that contain information associated with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. - + to specify annotations to be returned in the sent to the tracking service when the track point is matched. If is empty, no annotations are associated with the track point. + + Annotations are `strings` that you define that contain information associated with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. + ]]> @@ -118,13 +118,13 @@ Gets the collection of locations that should be excluded from the track point by the runtime tracking infrastructure. An that specifies locations to be excluded from the track point. The default is an empty collection. - in is matched for a particular activity status event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. - - You can use to specifically exclude locations from being tracked by the runtime tracking infrastructure. For example, if you want to track all activities except the activity with an property of "Code1", you can define an that matches all activities and add it to . Then you can define another that matches activities with an property set to "Code1" and add it to . The track point will then match all activities except the "Code1" activity. - + in is matched for a particular activity status event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. + + You can use to specifically exclude locations from being tracked by the runtime tracking infrastructure. For example, if you want to track all activities except the activity with an property of "Code1", you can define an that matches all activities and add it to . Then you can define another that matches activities with an property set to "Code1" and add it to . The track point will then match all activities except the "Code1" activity. + ]]> @@ -149,13 +149,13 @@ Gets a collection that specifies data to be extracted from the workflow instance and sent to the tracking service. An that specifies the data to be extracted and sent to the tracking service. The default is an empty collection. - objects that it puts in the of the that it sends to the tracking service. If is empty, no data will be extracted. - - You can add objects to to specify member data that should be extracted from the activity associated with this track point, and you can add objects to to specify member data that should be extracted from the activity of the workflow. - + objects that it puts in the of the that it sends to the tracking service. If is empty, no data will be extracted. + + You can add objects to to specify member data that should be extracted from the activity associated with this track point, and you can add objects to to specify member data that should be extracted from the activity of the workflow. + ]]> @@ -180,21 +180,13 @@ Gets the collection of locations that should be included in matching for the track point by the runtime tracking infrastructure. An that specifies the locations to be matched for the track point. The default is an empty collection. - is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. - - The track point will be matched if any in is matched by the runtime tracking infrastructure and no in is matched. - - - -## Examples - The following example demonstrates accessing the property. This example is from the TrackingProfileDesigner SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet120"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet120"::: - + is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. + + The track point will be matched if any in is matched by the runtime tracking infrastructure and no in is matched. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml index 0b004ab3702..f9ffad7112c 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml @@ -27,15 +27,15 @@ Represents a condition that compares the value of an activity member to a specified value by using a specified comparison operator. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - You can use an to constrain a or an . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + You can use an to constrain a or an . + ]]> @@ -65,11 +65,11 @@ Initializes a new instance of the class. - . You must also set . The default value of is `Equals`. - + . You must also set . The default value of is `Equals`. + ]]> @@ -96,11 +96,11 @@ The value to be compared. Initializes a new instance of the class by specifying an activity member and a value for comparison. - is set to `member`, and is set to `value`. The default value of is `Equals`. - + is set to `member`, and is set to `value`. The default value of is `Equals`. + ]]> @@ -127,23 +127,15 @@ Gets or sets the name of the activity member that is to be compared with . The dot delineated name of the activity member. - interface. For example, you can specify a single element of a collection. - - If you use the parameterless constructor for , you must explicitly set . - - The value of the specified activity member is compared with by applying . - - - -## Examples - The following code sample demonstrates accessing the Member property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet120"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet120"::: - + interface. For example, you can specify a single element of a collection. + + If you use the parameterless constructor for , you must explicitly set . + + The value of the specified activity member is compared with by applying . + ]]> The condition was evaluated and is a null reference ( in Visual Basic). @@ -171,11 +163,11 @@ Gets or sets the operator that is used in the comparison. One of the values. The default is . - @@ -200,23 +192,15 @@ The value that is to be compared with . The value used in the comparison. - is compared to the value of - - by applying . - - If you use the parameterless constructor for , you must explicitly set . - - - -## Examples - The following code sample demonstrates accessing the Value property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet120"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet120"::: - + is compared to the value of + + by applying . + + If you use the parameterless constructor for , you must explicitly set . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml index 222e2ff7a70..4769b3f2b69 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml @@ -95,21 +95,10 @@ ## Remarks The property is initialized to `connectionString`. - - -## Examples - The following code example demonstrates how to use the to create an instance of the class. - - This code example is part of the Workflow Monitor SDK Sample from the DatabaseService.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet129"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet129"::: - ]]> is a null reference ( in Visual Basic). - Workflow Monitor @@ -191,22 +180,9 @@ Tries to get query data for a specified workflow instance. if tracking data is available for the requested workflow instance; otherwise, . - - method to retrieve a . - - This code example is part of the Workflow Monitor SDK Sample from the DatabaseService.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet129"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet129"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). - Workflow Monitor diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml index 77c63287dd3..212a3f8bfee 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml @@ -67,13 +67,6 @@ These values specify that a call to should return a object for every workflow instance that has tracking data in the database. - - -## Examples - The following example demonstrates creating an instance of the class. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet128"::: - ]]> @@ -147,13 +140,6 @@ > [!NOTE] > If `WorkflowStatus` is set to null, then `StatusMaxDateTime` and `StatusMinDateTime` are ignored. All workflow instances will be returned when `GetWorkflows` is called. - - -## Examples - The following example demonstrates setting the StatusMaxDateTime property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet128"::: - ]]> @@ -188,13 +174,6 @@ > [!NOTE] > If `WorkflowStatus` is set to null, then `StatusMaxDateTime` and `StatusMinDateTime` are ignored. All workflow instances will be returned when `GetWorkflows` is called. - - -## Examples - The following example demonstrates setting the StatusMinDateTime property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet128"::: - ]]> @@ -279,13 +258,6 @@ If is null (`Nothing`), the set of objects returned will not be constrained by status; in other words, a object will be returned for any workflow instance that matches the parameters specified by the other properties of . - - -## Examples - The following example demonstrates setting the WorkflowStatus property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet128"::: - ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml index 1b42f2ac7ef..c9bff8ed2ae 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml @@ -32,19 +32,8 @@ objects are returned by a call to both and and provide access to the tracking data maintained in a SQL database by the for a specific workflow instance. The class optimizes its access to the database for its properties, which maintain collections. For more information, see . - - -## Examples - The following code example shows how to obtain information about all objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet137"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet137"::: - ]]> - Workflow Monitor @@ -127,20 +116,7 @@ Gets or sets a that indicates the time at which the first for this workflow instance was requested by the workflow run-time engine. A that indicates the time at which the first for this workflow instance was requested by the workflow run-time engine. - - objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - - ]]> - - Workflow Monitor + To be added. @@ -257,19 +233,8 @@ ## Remarks is determined based on the tracking data for the workflow instance, specifically on the workflow tracking records sent by the run-time tracking infrastructure; therefore depends, in part, on the objects in the for the workflow instance. in each maps to one of the values. If no workflow tracking records have been sent by the run-time tracking infrastructure for this workflow instance, is . - - -## Examples - The following code example shows how to obtain information about all objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - ]]> - Workflow Monitor @@ -412,20 +377,7 @@ The of the workflow instance for which this applies. The of the workflow instance for which this applies. - - objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - - ]]> - - Workflow Monitor + To be added. @@ -453,19 +405,8 @@ ## Remarks This is an internal join operation. provides a more efficient way to access data for a workflow instance in a SQL database than by using a workflow instance . Use to find related records for this workflow instance in separate views. - - -## Examples - The following code example shows how to obtain information about all objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - ]]> - Workflow Monitor @@ -487,20 +428,7 @@ Gets or sets the of the workflow instance. The of the workflow instance. - - objects contained in a list of displayed workflows. The code creates a `ListViewItem` for each found in a `displayedWorkflows` variable. Each contains a string representation of the , the and properties. It then adds the item to a `workflowStatusList`. The code uses the previously named property values and a string version of the property to create a new `WorkflowStatusInfo` object that is also added to the `workflowStatusList`. - - This code example is part of the Workflow Monitor SDK Sample from the Mainform.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - - ]]> - - Workflow Monitor + To be added. diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml b/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml index 02e33983cf5..c7826d95de7 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml @@ -23,17 +23,17 @@ The base class that represents a tracking channel. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - If a is present, the runtime tracking infrastructure calls to get a tracking channel for a workflow instance. The runtime tracking infrastructure uses this tracking channel to send tracking records associated with the workflow instance back to the host application whenever the tracking infrastructure matches a track point in the associated with the workflow instance. Your application can treat this tracking information in any way you choose. For example, the writes tracking information to a SQL database. - - To create a tracking channel for your tracking service, derive a class from the base class. You can use the object passed by the runtime tracking infrastructure in its call to your implementation of to associate each instance of your tracking channel with a specific workflow instance. The workflow runtime engine requests a tracking channel from each tracking service that has provided a for a workflow instance. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + If a is present, the runtime tracking infrastructure calls to get a tracking channel for a workflow instance. The runtime tracking infrastructure uses this tracking channel to send tracking records associated with the workflow instance back to the host application whenever the tracking infrastructure matches a track point in the associated with the workflow instance. Your application can treat this tracking information in any way you choose. For example, the writes tracking information to a SQL database. + + To create a tracking channel for your tracking service, derive a class from the base class. You can use the object passed by the runtime tracking infrastructure in its call to your implementation of to associate each instance of your tracking channel with a specific workflow instance. The workflow runtime engine requests a tracking channel from each tracking service that has provided a for a workflow instance. + ]]> @@ -76,11 +76,11 @@ When implemented in a derived class, notifies a receiver of data on the tracking channel that the workflow instance associated with the tracking channel has either completed or terminated. - to notify the receiver of data on the tracking channel that the workflow instance associated with this tracking channel has either terminated or completed. No more data will be sent on the tracking channel. When is called, you may perform whatever actions are required by your implementation of the class. - + to notify the receiver of data on the tracking channel that the workflow instance associated with this tracking channel has either terminated or completed. No more data will be sent on the tracking channel. When is called, you may perform whatever actions are required by your implementation of the class. + ]]> @@ -108,19 +108,11 @@ The to send. When implemented in a derived class, sends a on the . - to deliver a on the when it matches a track point in a . You can treat the tracking information sent on the in whatever manner the requirements of your application dictate. - - - -## Examples - The following example demonstrates an implementation of the Send method. In this implementation, tracking messages are written to the event log when a workflow terminates. This sample is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet117"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet117"::: - + to deliver a on the when it matches a track point in a . You can treat the tracking information sent on the in whatever manner the requirements of your application dictate. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml b/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml index 3f822949b11..1bf5511d95f 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml @@ -23,15 +23,15 @@ Contains filter criteria for data extracted from a workflow instance in a . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A specifies the value of a piece of data extracted from a workflow. It is used to constrain the set of objects returned by in a query of the tracking data base used by a . You can add objects to to specify that the set of objects returned by be constrained to those possessing the specified set of extracted data. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A specifies the value of a piece of data extracted from a workflow. It is used to constrain the set of objects returned by in a query of the tracking data base used by a . You can add objects to to specify that the set of objects returned by be constrained to those possessing the specified set of extracted data. + ]]> @@ -61,11 +61,11 @@ Initializes a new instance of the class. - , , and to a null reference (`Nothing` in Visual Basic). You must set all of these properties in order to configure the . - + , , and to a null reference (`Nothing` in Visual Basic). You must set all of these properties in order to configure the . + ]]> @@ -94,19 +94,11 @@ A representation of the value of the data. Initializes a new instance of the class by using the specified qualified name of an activity, data field name, and representation of a data value. - , , and properties are set according to the values specified by the equivalent parameters to the constructor. - - - -## Examples - The following example demonstrates creating a new instance of a object. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet139"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet139"::: - + , , and properties are set according to the values specified by the equivalent parameters to the constructor. + ]]> @@ -131,19 +123,11 @@ Gets or sets a representation of the value of the extracted data. A representation of the value of the extracted data. The default is a null reference ( in Visual Basic). - can be a null reference (`Nothing`). - - - -## Examples - The following example demonstrates setting the DataValue property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet139"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet139"::: - + can be a null reference (`Nothing`). + ]]> @@ -168,19 +152,11 @@ Gets or sets the name of the activity member from which the data was extracted. The name of the activity member from which the data was extracted. The default is a null reference ( in Visual Basic). - corresponds to the name specified in a . can, therefore, be set to specify an activity field or property; a member of an activity field or property; or a single element of an activity field or property (or a member of either) that implements the interface. For more information see , , or . - - - -## Examples - The following example demonstrates setting the FieldName property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet139"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet139"::: - + corresponds to the name specified in a . can, therefore, be set to specify an activity field or property; a member of an activity field or property; or a single element of an activity field or property (or a member of either) that implements the interface. For more information see , , or . + ]]> @@ -205,19 +181,11 @@ Gets or sets the qualified name of the activity from which the data was extracted. The qualified name of the activity from which the data was extracted. The default is a null reference ( in Visual Basic). - is equivalent to the property of the activity from which the data was extracted. - - - -## Examples - The following example demonstrates setting the QualifiedName property. This example is from the Workflow Monitor SDK sample. For more information, see [Workflow Monitor Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet139"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet139"::: - + is equivalent to the property of the activity from which the data was extracted. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml index a729d7ca031..8e40f557802 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml @@ -42,19 +42,8 @@ A can be serialized to XML by using the , which formats the XML according to the . This provides a convenient format for profile storage and for authoring a profile in a non-programmatic manner. For example, the SQL Tracking Service stores serialized versions of its tracking profiles, as will any tracking service you create based on the class. - - -## Examples - The following code example demonstrates how you can create a using the constructor and use the object's properties to help track the execution of a workflow. The example code uses the , , and properties. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService @@ -78,19 +67,8 @@ ## Remarks The constructor initializes an empty . You can add track points to , , and to configure the . - - -## Examples - The following code example demonstrates how you can create a using the constructor and use the object's properties to help track the execution of a workflow. The example code uses the , , and properties. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService @@ -120,19 +98,8 @@ An does not actually define a physical point in a workflow instance, but instead defines a set of match parameters that can be used by the runtime tracking infrastructure to match an activity status event for which it should send an . Therefore, the same can be matched many times during the lifespan of a workflow instance. An can also specify data to be extracted from the workflow instance and returned in the . - - -## Examples - The following code example demonstrates how you can create a using the constructor and use the object's properties to help track the execution of a workflow. The example code uses the , , and properties. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService @@ -191,19 +158,8 @@ ## Remarks Because of the semantics of profile caching in the workflow runtime engine, if you change the contents of a you must update . If you do not, your updated may not be loaded by the workflow runtime engine, even if it is returned by a call to , or sent in the associated with a event. Therefore, to ensure that the updated is loaded by the workflow runtime engine, you should change the for the . You can then explicitly call on any appropriate workflow instances, or, depending on your implementation, you can rely on the tracking service to inform the workflow runtime engine of the change. For more information, see . - - -## Examples - The following code example demonstrates how you can create a using the constructor and use the object's properties to help track the execution of a workflow. The example code uses the , , and properties. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService @@ -233,19 +189,8 @@ A does not actually define a physical point in a workflow instance, but instead defines one or more values that can be used by the runtime tracking infrastructure to match workflow status events. Therefore, the same can be matched many times during the lifespan of a workflow instance. A can also specify any annotations to be returned in the . - - -## Examples - The following code example demonstrates how you can create a using the constructor and use the object's properties to help track the execution of a workflow. The example code uses the , , and properties. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml index 2bd5bc16edd..a479b0b1ab0 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml @@ -34,19 +34,8 @@ An XML document provides a convenient format in which to store a tracking profile. It also provides a non-programmatic way of authoring tracking profiles. The out-of-box uses a to serialize and deserialize the tracking profiles that are stored in its database. - - -## Examples - The following code example demonstrates how you can create a using the constructor to serialize a . The code also uses the method. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> - Query Using SQLTrackingService @@ -64,20 +53,7 @@ Initializes a new instance of the class. - - using the constructor to serialize a . The code also uses the method. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - - ]]> - - Query Using SQLTrackingService + To be added. @@ -179,16 +155,6 @@ ## Remarks Serialization refers to the process of creating a well-formed XML document from a valid . uses the tracking profile to serialize the tracking profile. `profile` must be a valid that contains at least one valid track point. Validation on the tracking profile is performed during serialization, and, if the tracking profile is not valid, an is thrown. You can catch this exception and examine its message property to determine the cause of the validation error. If there are any unhandled exceptions while serializing the tracking profile, then the workflow instance for which the tracking profile was requested is terminated. - - -## Examples - The following code example demonstrates how you can create a using the constructor to serialize a . The code also uses the method. - - This code example is part of the Query using SQLTrackingService SDK sample from the Program.cs file. For more information, see [Query Using SQLTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742042(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet291"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet291"::: - ]]> @@ -199,7 +165,6 @@ is . is not a valid tracking profile. - Query Using SQLTrackingService diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingService.xml b/xml/System.Workflow.Runtime.Tracking/TrackingService.xml index 019703feee9..d6c4e8e8e2e 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingService.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingService.xml @@ -23,42 +23,42 @@ Provides the basic interface between a tracking service and the run-time tracking infrastructure. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A tracking service is responsible for supplying tracking channels and tracking profiles to the workflow run-time engine. The workflow run-time engine requests one from a tracking service for each workflow instance for which it has a . The workflow run-time engine uses this to send tracking records associated with that workflow instance. A contains track points that specify a set of tracking events for which the run-time tracking infrastructure should send tracking records. A may also specify data to be extracted from the workflow instance when one of these tracking events occurs. - - The run-time tracking infrastructure uses a to filter tracking events emitted by a workflow instance. When a tracking event is emitted that matches a track point in the , the run-time tracking infrastructure extracts any data specified in the from the workflow instance and encapsulates this data and information about the tracking event in a tracking record. This tracking record is then sent over the associated with the workflow instance. A tracking record may be one of the following kinds: - - - - - - - - The host application can use the tracking record in any way that it chooses. For example, the host application may store the tracking information in a database and use it to implement a sophisticated user interface, or it may use the information to inform an administrator of a condition that requires some action. You can register a tracking service with the workflow run-time engine by calling or by including the appropriate entry in the application configuration file. - - All tracking services must inherit from the abstract class. This class defines the basic interface between a tracking service and the run-time tracking infrastructure. The workflow run-time engine requests a for a specific workflow instance or workflow by calling one of the overloaded methods or the method. The workflow run-time engine calls to request a . - - The workflow tracking runtime calls the and methods whenever a workflow instance is created or loaded from the persistence store. The overhead associated with these calls can be costly to the tracking service (many database calls, for example). You can implement the interface in your tracking service to circumvent this call-based mechanism and use events to notify the workflow runtime engine of changes to a . For tracking services that implement the interface, the workflow run-time engine subscribes to the and events. Your tracking service can raise the appropriate event when a change to one of its tracking profiles occurs. The class implements this interface. - - The workflow run-time engine calls the method to test whether a has been updated or removed as a result of an explicit call by a host or a service to on a workflow instance. This process enables a host or service to dynamically change the tracking profile that is being used for a specific workflow instance. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A tracking service is responsible for supplying tracking channels and tracking profiles to the workflow run-time engine. The workflow run-time engine requests one from a tracking service for each workflow instance for which it has a . The workflow run-time engine uses this to send tracking records associated with that workflow instance. A contains track points that specify a set of tracking events for which the run-time tracking infrastructure should send tracking records. A may also specify data to be extracted from the workflow instance when one of these tracking events occurs. + + The run-time tracking infrastructure uses a to filter tracking events emitted by a workflow instance. When a tracking event is emitted that matches a track point in the , the run-time tracking infrastructure extracts any data specified in the from the workflow instance and encapsulates this data and information about the tracking event in a tracking record. This tracking record is then sent over the associated with the workflow instance. A tracking record may be one of the following kinds: + + + + + + + + The host application can use the tracking record in any way that it chooses. For example, the host application may store the tracking information in a database and use it to implement a sophisticated user interface, or it may use the information to inform an administrator of a condition that requires some action. You can register a tracking service with the workflow run-time engine by calling or by including the appropriate entry in the application configuration file. + + All tracking services must inherit from the abstract class. This class defines the basic interface between a tracking service and the run-time tracking infrastructure. The workflow run-time engine requests a for a specific workflow instance or workflow by calling one of the overloaded methods or the method. The workflow run-time engine calls to request a . + + The workflow tracking runtime calls the and methods whenever a workflow instance is created or loaded from the persistence store. The overhead associated with these calls can be costly to the tracking service (many database calls, for example). You can implement the interface in your tracking service to circumvent this call-based mechanism and use events to notify the workflow runtime engine of changes to a . For tracking services that implement the interface, the workflow run-time engine subscribes to the and events. Your tracking service can raise the appropriate event when a change to one of its tracking profiles occurs. The class implements this interface. + + The workflow run-time engine calls the method to test whether a has been updated or removed as a result of an explicit call by a host or a service to on a workflow instance. This process enables a host or service to dynamically change the tracking profile that is being used for a specific workflow instance. + ]]> - - When you inherit from , you must override the following members: - -- - -- - -- - + - When you inherit from , you must override the following members: + +- + +- + +- + - @@ -79,17 +79,7 @@ When implemented in a derived class, initializes a new instance of the class. - - - + To be added. @@ -100,11 +90,11 @@ Must be overridden in the derived class, and when implemented, gets the tracking profile for a specified workflow instance or workflow type. - for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . - + for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . + ]]> @@ -133,19 +123,11 @@ Must be overridden in the derived class, and when implemented, returns the tracking profile for the specified workflow instance. The tracking profile for the specified workflow instance. - for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . - - - -## Examples - The following example shows an implementation of the `GetProfile` method. In this example, several overloads of the `GetProfile` method call a single private `GetProfile` method, which returns a hard-coded, default tracking profile. This example is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet115"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet115"::: - + for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . + ]]> @@ -176,11 +158,11 @@ Must be overridden in the derived class, and when implemented, returns the tracking profile, qualified by version, for the specified workflow . The tracking profile for the specified workflow type. - for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . - + for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . + ]]> @@ -209,19 +191,11 @@ Must be overridden in the derived class, and when implemented, returns the channel that the run-time tracking infrastructure uses to send tracking records to the tracking service. The that is used to send tracking records to the tracking service. - for each tracking service for each workflow instance. The workflow run-time engine calls on each tracking service to get the for that service. You can use the information passed in to associate tracking data sent on the for your tracking service with a particular root workflow instance. - - - -## Examples - The following example shows an implementation of the `GetTrackingChannel` method. This example is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet113"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet113"::: - + for each tracking service for each workflow instance. The workflow run-time engine calls on each tracking service to get the for that service. You can use the information passed in to associate tracking data sent on the for your tracking service with a particular root workflow instance. + ]]> @@ -253,19 +227,11 @@ if a for the specified workflow is available; otherwise, . If , the is returned in . - for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . - - - -## Examples - The following example demonstrates an implementation of the `TryGetProfile` method, which calls a private `GetProfile` method. This example is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet209"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet209"::: - + for every workflow and workflow instance; or you can manage a sophisticated store of tracking profiles referenced by workflow instance, workflow , and . + ]]> @@ -299,19 +265,11 @@ if a new should be loaded; otherwise, . If , the is returned in . - is called by the run-time tracking infrastructure to determine whether a new should be loaded for the specified workflow instance. If a new is required, it is returned in `profile`. If you want the run-time tracking infrastructure to stop tracking a workflow instance, your tracking service should return `true` and set `profile` equal to a null reference (`Nothing` in Visual Basic). Your tracking service can use `workflowType` or `workflowInstanceId` in whatever manner you choose to determine whether a tracking profile should be reloaded. For example, the only uses `workflowInstanceId` to decide whether the tracking profile should be reloaded. is called by the run-time tracking infrastructure according to its own tracking semantics, or in response to the host or a service calling on a workflow instance. - - - -## Examples - The following example shows a basic implementation of the `TryReloadProfile` method. This example is from the Termination Tracking Service SDK sample. For more information, see [Termination Tracking Service Sample](https://msdn.microsoft.com/library/29b7c0d7-cece-4bb9-96d0-c5b6c6e14439). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet116"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet116"::: - + is called by the run-time tracking infrastructure to determine whether a new should be loaded for the specified workflow instance. If a new is required, it is returned in `profile`. If you want the run-time tracking infrastructure to stop tracking a workflow instance, your tracking service should return `true` and set `profile` equal to a null reference (`Nothing` in Visual Basic). Your tracking service can use `workflowType` or `workflowInstanceId` in whatever manner you choose to determine whether a tracking profile should be reloaded. For example, the only uses `workflowInstanceId` to decide whether the tracking profile should be reloaded. is called by the run-time tracking infrastructure according to its own tracking semantics, or in response to the host or a service calling on a workflow instance. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml index 9a8b441e97e..1e848dce60d 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml @@ -39,21 +39,8 @@ > [!NOTE] > is used only by the runtime tracking service to pass information in a . - - -## Examples - The following code example demonstrates a method, named `WriteExceptionEventArgs`, which captures a . The code checks whether the property is `null` (`Nothing` in Visual Basic). - - If it is not, the code writes the message associated with the property to the console. In addition, the code converts the value of the property to a string and writes it to the console. - - This code example is part of the EventArgs Tracking SDK sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet289"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet289"::: - ]]> - EventArgs Tracking Sample @@ -126,20 +113,7 @@ Gets the that is being thrown by the workflow instance. The exception that is being thrown by the workflow instance. - - . The code checks whether the property is `null` (`Nothing` in Visual Basic). If it is not, the code writes the message associated with the property to the console. If Exception is `null` (`Nothing`), the code converts the value of the property to a string and writes it to the console. - - This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet289"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet289"::: - - ]]> - - EventArgs Tracking Sample + To be added. @@ -167,19 +141,8 @@ ## Remarks Exceptions are passed up the chain of exception handler activities. An exception handler may choose to throw an exception again. When an exception handler throws an exception again, a new exception tracking event containing a new is raised to the runtime tracking infrastructure. refers to the activity that originally threw the exception. - - -## Examples - The following code example demonstrates a method, named `WriteExceptionEventArgs`, which captures a . The code checks whether the property is `null` (`Nothing` in Visual Basic). If it is not, the code writes the message associated with the property to the console. If is `null` (`Nothing`), the code converts the value of the property to a string and writes it to the console. - - This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet289"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet289"::: - ]]> - EventArgs Tracking Sample diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml index 9c63eedf6d9..c6b665f6955 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml @@ -39,19 +39,8 @@ > [!NOTE] > is used only by the runtime tracking service to pass information in a . The data for a event is passed in a . - - -## Examples - The following code example demonstrates a method, named `WriteSuspendedEventArgs`, which captures a . The code writes information from the method's arguments to the console, including the value of the property. - - This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet287"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet287"::: - ]]> - EventArgs Tracking Sample diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml index 62456c1660f..2b4d1655734 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml @@ -41,19 +41,8 @@ > [!NOTE] > is used only by the runtime tracking service to pass information in a . The data for a event is passed in a . - - -## Examples - The following code example demonstrates a method, named `WriteTerminatedEventArgs`, which captures a . The code checks whether the property is `null` (`Nothing` in Visual Basic). If it is not, the code writes the message associated with the property to the console. If is `null` (`Nothing`), the code does not write any exception information to the console. - - This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - ]]> - EventArgs Tracking Sample @@ -83,19 +72,8 @@ When the workflow instance is terminated by either a host call to or by a activity, contains a that has its property set to a description of the reason for the termination. If the host terminates the workflow instance, it supplies this description in the `string` parameter to ; if the workflow instance is terminated by a , the description is supplied by . - - -## Examples - The following code example demonstrates a method, named `WriteTerminatedEventArgs`, which captures a . The code checks whether the property is `null` (`Nothing` in Visual Basic). If it is not, the code writes the message associated with the property to the console. If is `null` (`Nothing`), the code does not write any exception information to the console. - - This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see [EventArgs Tracking Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741730(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet288"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet288"::: - ]]> - EventArgs Tracking Sample diff --git a/xml/System.Workflow.Runtime/CorrelationProperty.xml b/xml/System.Workflow.Runtime/CorrelationProperty.xml index 4f9025aa189..1298c5c3a3b 100644 --- a/xml/System.Workflow.Runtime/CorrelationProperty.xml +++ b/xml/System.Workflow.Runtime/CorrelationProperty.xml @@ -27,23 +27,15 @@ Represents a name and value pair used to correlate messages to specific receiving activities. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - classes are defined as properties of Workflow Connection Service activities. By default, these properties are bound to variables declared at the root workflow activity. For dynamic activities such as and each of its children cannot share a universal object. Consider the scenario where each task inside a has to manage its own conversation. The child activities inside the requires a instance unique per execution context, or per task. In order to accomplish this, you have to define a custom activity that has a instance property and the Workflow Connection Services activities have to bind to this property. - - - -## Examples - The following example demonstrates creating a correlation property object, and accessing the Name and Value properties. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet2"::: - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + classes are defined as properties of Workflow Connection Service activities. By default, these properties are bound to variables declared at the root workflow activity. For dynamic activities such as and each of its children cannot share a universal object. Consider the scenario where each task inside a has to manage its own conversation. The child activities inside the requires a instance unique per execution context, or per task. In order to accomplish this, you have to define a custom activity that has a instance property and the Workflow Connection Services activities have to bind to this property. + ]]> diff --git a/xml/System.Workflow.Runtime/CorrelationToken.xml b/xml/System.Workflow.Runtime/CorrelationToken.xml index 957d42247ba..a1f6e4df792 100644 --- a/xml/System.Workflow.Runtime/CorrelationToken.xml +++ b/xml/System.Workflow.Runtime/CorrelationToken.xml @@ -27,13 +27,13 @@ Manages the subscriptions of the to the owner activities. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -147,19 +147,11 @@ if the is initialized; otherwise, . - . - - - -## Examples - The following example demonstrates accessing the Initialized property of a correlation token object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet4"::: - + . + ]]> @@ -189,17 +181,7 @@ Gets or sets the name of the . The name of the . - - - + To be added. @@ -227,17 +209,7 @@ Gets or sets the name of the that owns the correlation token. The name of the that owns the correlation token. - - - + To be added. @@ -269,17 +241,7 @@ Gets the collection of objects in the . A collection of objects. - - - + To be added. diff --git a/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml index 5577be14213..1e67303f19f 100644 --- a/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml @@ -32,19 +32,8 @@ When the workflow completes, the workflow runtime engine raises the event. The workflow runtime engine passes all of the output parameters of the workflow in a . These include the `out` and `ref` parameters of the workflow. - - -## Examples - The following code example demonstrates an event handler method that takes as a parameter. The `OnWorkflowCompleted` method is called when the event is raised. The code uses the property to obtain the value associated with the `Status` key and writes it to the console. - - This code example is part of the Sequential Workflow with Parameters SDK Sample from the Program.cs file. For more information, see [Workflow with Parameters Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741685(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet192"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet192"::: - ]]> - Workflow with Parameters Sample @@ -72,19 +61,8 @@ ## Remarks contains the `out` and `ref` parameters of the workflow. - - -## Examples - The following code example demonstrates how to obtain a value from a key stored in the property. The `OnWorkflowCompleted` method has a parameter that takes a . This method is called when the event is raised. The code uses the property to obtain the value associated with the `Status` key and writes it to the console. - - This code example is part of the Sequential Workflow with Parameters SDK Sample from the Program.cs file. For more information, see [Workflow with Parameters Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741685(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet192"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet192"::: - ]]> - Workflow with Parameters Sample diff --git a/xml/System.Workflow.Runtime/WorkflowEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowEventArgs.xml index 090f0caa913..86b717a3090 100644 --- a/xml/System.Workflow.Runtime/WorkflowEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowEventArgs.xml @@ -32,19 +32,8 @@ Workflow events are associated with a workflow instance. A contains the associated with the workflow event. A or an object that derives from the class provides the data for all of the workflow events in the class. is the base class for , , and . - - -## Examples - The following code example demonstrates how to obtain a object using the property when an event handler method is called. When the event occurs, the `OnWorkflowIdled` method defined in this example is called. It determines which workflow is idled using the property and then gets a collection of queued items for the workflow instance by calling the method. The code iterates over the collection to determine which activity is waiting for the event that idled the workflow. It then sends an exception to the workflow queue using the method along with the name of the event queue item. - - This code example is part of the Canceling a Workflow SDK Sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet261"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet261"::: - ]]> - Canceling a Workflow @@ -66,20 +55,7 @@ Gets the workflow instance associated with the workflow event. The associated with the workflow event. - - object using the property when an event handler method is called. When the event occurs, the `OnWorkflowIdled` method defined in this example is called. It determines which workflow is idled using the property and then gets a collection of queued items for the workflow instance by calling the method. The code iterates over the collection to determine which activity is waiting for the event that idled the workflow. It then sends an exception to the workflow queue using the method along with the name of the event queue item. - - This code example is part of the Canceling a Workflow SDK Sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet261"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet261"::: - - ]]> - - Canceling a Workflow + To be added. diff --git a/xml/System.Workflow.Runtime/WorkflowInstance.xml b/xml/System.Workflow.Runtime/WorkflowInstance.xml index 040ff4a852d..5a0072e0c4c 100644 --- a/xml/System.Workflow.Runtime/WorkflowInstance.xml +++ b/xml/System.Workflow.Runtime/WorkflowInstance.xml @@ -35,20 +35,9 @@ > [!NOTE] > If a workflow instance becomes unresponsive because a call on the host application does not return, the only way to recover the instance is to restart the runtime. However, if the instance has been forcibly unloaded, aborted, or suspended, it can be continued by calling the method. - - -## Examples - The following code example demonstrates how you can create and start a in a workflow host. The code creates an instance of the , adds services to the runtime, and then demonstrates the recommended way to create a object. The code initializes by calling the method and passing the previously created type to it. The is started with the method call. - - This code example is part of the Canceling a Workflow SDK sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet260"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet260"::: - ]]> This type is thread safe. - Canceling a Workflow @@ -78,14 +67,6 @@ `Abort` is different from in that while `Abort` simply clears the in-memory workflow instance and can be restarted from the last persistence point, Terminate clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. For the , this means that all state information for that workflow instance is deleted from the database upon termination. You will not be able to reload the workflow instance from a previously stored persistence point. - - -## Examples - The following example demonstrates calling Abort on a workflow instance of type Workflow1. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet13"::: - ]]> The workflow runtime engine is not running. @@ -119,14 +100,6 @@ ## Remarks If the workflow instance is not already suspended, the workflow runtime engine temporarily suspends the instance before applying the changes. - - -## Examples - The following example demonstrates calling ApplyWorkflowChanges to a object. This example is from the Ordering State Machine SDK sample, from the Mainform.cs file. For more information, see the [Ordering State Machine Sample](https://msdn.microsoft.com/library/59272cf4-bc98-439c-bcfa-b66999ebce5c). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet89"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet89"::: - ]]> The workflow runtime engine is not running. @@ -171,16 +144,6 @@ > [!NOTE] > Messages are not guaranteed to be received by the workflow instance in the order that they were sent. For example, if receiving a message in an existing queue (Queue A) causes a workflow to create another queue (Queue B), which then listens for another message sent after the first message, it is possible that the second message will arrive first, and will not be received due to its queue not being created yet. To prevent this issue, the second message should not be sent until the presence of the second queue is verified (using .) - - -## Examples - The following code example demonstrates how to use . When the event occurs, the `OnWorkflowIdled` method defined in this example is called. It determines which workflow is idled using the property and then gets a collection of queued items for the workflow instance by calling the method. The code iterates over the collection to determine which activity is waiting for the event that idled the workflow. It then sends an exception to the workflow queue using the method along with the name of the event queue item. - - This code example is part of the Canceling a Workflow SDK sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet261"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet261"::: - ]]> @@ -194,7 +157,6 @@ -or- The specified by is not enabled. - Canceling a Workflow @@ -233,14 +195,6 @@ When you are using this method with a state machine workflow, you might get an exception that contains the message "Queue '{0}' is not enabled." This occurs when the current state of the state machine does not know how to handle a specific event. For example, when some state other than the current state contains the that contains the that is represented by the queue '{0}'. - - -## Examples - The following example demonstrates sending information to a workflow instance using the `EnqueueItemOnIdle` method. First, a WorkflowInstance object is created and started; next, an object that implements the interface is created. `EnqueueItemOnIdle` is then called, passing in string values for the queue name, the enqueued item, and the work item to be passed to the methods of the pendingWork object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet12"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet12"::: - ]]> @@ -352,14 +306,6 @@ This method is not thread safe, so the host should synchronize its calls to this method. - - -## Examples - The following example demonstrates retrieving the workflow definition from a workflow instance. This example is from the Ordering State Machine SDK sample, from the Mainform.cs file. For more information, see the [Ordering State Machine Sample](https://msdn.microsoft.com/library/59272cf4-bc98-439c-bcfa-b66999ebce5c). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet86"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet86"::: - ]]> @@ -384,17 +330,7 @@ Returns the next point in time that this is scheduled to be delivered a timer message. A DateTime value that represents the next time this will be delivered a timer message. - - method to determine if more workflow timer messages are enqueued. This example is from the WorkflowThreading SDK sample, from the Program.cs file. For more information, see [Workflow Threading Sample](https://msdn.microsoft.com/library/5b650be7-09fa-47db-a2f6-523dc8ea5ee9). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet284"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet284"::: - - ]]> - + To be added. @@ -424,20 +360,9 @@ ## Remarks returns a collection of objects, each of which contains information about the state of one of the workflow queues associated with this workflow instance. contains the pending items for a and contains a list of the activities that are subscribed for item delivery on a . - - -## Examples - The following code example demonstrates how you can use the method to obtain information about the state of all workflow queues associated with a object. When the event occurs, the `OnWorkflowIdled` method defined in this example is called. It determines which workflow is idled using the property and then gets a collection of queued items for the workflow instance by calling the method. The code iterates over the collection to determine which activity is waiting for the event that idled the workflow. It then sends an exception to the workflow queue using the method along with the name of the event queue item. - - This code example is part of the Canceling a Workflow SDK sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet261"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet261"::: - ]]> The workflow runtime engine is not running. - Canceling a Workflow @@ -465,24 +390,8 @@ ## Remarks You can use to reference the workflow instance. - - -## Examples - The following code example demonstrates how you can use the property to obtain information about a object. The first code snippet creates a variable named `instanceId`. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet210"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet210"::: - - The second snippet uses the property as the first object in an `OrderEventArgs` constructor call when the `CallBackForApproval` method is called. - - This code example is part of the Listen SDK Sample from the OrderServiceImple.cs file. For more information, see [Listen Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741698(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet211"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet211"::: - ]]> - Listen Sample @@ -510,14 +419,6 @@ ## Remarks is synchronous; if the workflow instance can be loaded, will return after the workflow instance has been loaded into memory and scheduled by the workflow runtime engine. The runtime raises the event after the persistence service has restored the workflow instance in memory, but before the workflow runtime engine schedules the instance. - - -## Examples - The following example demonstrates how to load a previously unloaded object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet10"::: - ]]> The workflow runtime engine is not running. @@ -578,14 +479,6 @@ ## Remarks The host can call to resume execution of a workflow instance that has been previously suspended. If the workflow instance is not in the suspended state, no action is taken. The runtime raises the event just before execution of the workflow instance is resumed. - - -## Examples - The following example demonstrates calling Resume on a previously suspended workflow instance. This example is from the Suspend and Terminate SDK sample. For more information, see [Suspend and Terminate Sample](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet172"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet172"::: - ]]> The workflow runtime engine is not running. @@ -616,16 +509,6 @@ ## Remarks calls on the root activity of this workflow instance. If encounters an exception, it terminates the workflow instance by calling with the property of the exception passed as the reason for the termination. - - -## Examples - The following code example demonstrates how you can use the method to start a in a workflow host. The code creates an instance of the , adds services to the runtime, and then demonstrates the recommended way to create a object. It creates a object and casts it to one of the workflow objects with which the host is associated. The code next initializes by calling the method and passing the previously created type to it. The is started with the method call. - - This code example is part of the Canceling a Workflow SDK sample from the Program.cs file. For more information, see [Canceling a Workflow](https://msdn.microsoft.com/library/d5077f56-a78b-48e7-825c-f6c77c8e54fb). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet260"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet260"::: - ]]> The workflow runtime engine is not running. @@ -633,7 +516,6 @@ -or- The workflow instance has already been started. - Canceling a Workflow @@ -667,14 +549,6 @@ > [!NOTE] > does not unload the workflow instance. - - -## Examples - The following code example demonstrates calling Suspend on a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet9"::: - ]]> The workflow runtime engine is not running. @@ -712,14 +586,6 @@ `Terminate` is different from in that while Terminate clears the in-memory workflow instance and informs the persistence service of the termination, `Abort` simply clears the in-memory workflow instance, which can then be restarted from the last persistence point. - - -## Examples - The following code example demonstrates calling Terminate on a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet8"::: - ]]> The workflow runtime engine is not running. @@ -754,14 +620,6 @@ The host can use to reclaim system resources from an idle workflow. - - -## Examples - The following example demonstrates using the TryUnload method to unload a workflow when the event fires. This example is from the Using Persistence Services SDK sample, from the Program.cs file. For more information, see [Using Persistence Services Sample](https://msdn.microsoft.com/library/3176b7e7-ae49-4d5c-802b-85032d6ebde6). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet280"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet280"::: - ]]> There is no persistence service registered with the workflow runtime engine. @@ -794,14 +652,6 @@ The host can use to reclaim system resources from an idle workflow. - - -## Examples - The following example demonstrates calling on a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet11"::: - ]]> There is no persistence service registered with the workflow runtime engine. @@ -826,17 +676,7 @@ Gets the for this workflow instance. A that represents the execution environment in which this workflow instance is running. - - of a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet7"::: - - ]]> - + To be added. diff --git a/xml/System.Workflow.Runtime/WorkflowQueue.xml b/xml/System.Workflow.Runtime/WorkflowQueue.xml index cadbc8aac7e..f24aee2cb3a 100644 --- a/xml/System.Workflow.Runtime/WorkflowQueue.xml +++ b/xml/System.Workflow.Runtime/WorkflowQueue.xml @@ -32,20 +32,8 @@ Workflow queues are used to pass messages between a host or host services and activities in a workflow. Any activity can create a by calling , and a host, a service, or another activity can call to add an item to that . You can subscribe to the event to be notified when an item arrives on the . You can use to examine an item at the beginning of the and to remove an item from the . Each is associated with a that you can use to perform other management operations on the , such as deleting the queue. exposes the associated with this . - - -## Examples - The following code example demonstrates how you can create a by calling the method. It also uses the property to determine whether any messages exist in the current queue. Finally, the code uses the method to remove and return the first object in the queue. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet227"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet227"::: - ]]> - Workflow and Application Communication - File System Watcher Activity @@ -67,20 +55,7 @@ Gets the number of items contained in the . The number of items in the workflow queue. - - by calling the method. It also uses the property to determine whether any messages exist in the current queue. Finally, the code uses the method to remove and return the first object in the queue. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet227"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet227"::: - - ]]> - - File System Watcher Activity + To be added. @@ -109,20 +84,9 @@ ## Remarks You can check to determine whether the is empty before you call , or you can catch the . - - -## Examples - The following code example demonstrates how you can create a by calling the method. It also uses the property to determine whether any messages exist in the current queue. Finally, the code uses the method to remove and return the first object in the queue. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet227"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet227"::: - ]]> The is empty. - File System Watcher Activity @@ -376,22 +340,9 @@ A subscriber for that implements the interface. Registers a subscriber to the event. - - by calling the method. It also uses the to register the specified listener. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet225"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet225"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). - File System Watcher Activity @@ -486,22 +437,9 @@ A subscriber for that implements the interface. Unregisters a subscriber to the event. - - by calling the method. It also uses the to unregister the specified listener. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet226"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet226"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). - File System Watcher Activity diff --git a/xml/System.Workflow.Runtime/WorkflowQueuingService.xml b/xml/System.Workflow.Runtime/WorkflowQueuingService.xml index 799b7549ee8..27c34226f2d 100644 --- a/xml/System.Workflow.Runtime/WorkflowQueuingService.xml +++ b/xml/System.Workflow.Runtime/WorkflowQueuingService.xml @@ -32,19 +32,8 @@ provides methods that you can use to manage the workflow queues associated with a workflow instance. - - -## Examples - The following code example demonstrates a method, named `CreateQueue`, that initializes a object by calling the method. The code then uses the method to determine if a with a specified name exists. If it does not exist, the code calls the method; if it does the code calls the method. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet223"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet223"::: - ]]> - File System Watcher Activity @@ -78,22 +67,11 @@ ## Remarks A is created with the specified `queueName`. If transactional is `true`, the is only visible inside the current transaction. - - -## Examples - The following code example demonstrates a method, named `CreateQueue`, that initializes a object by calling the method. The code then uses the method to determine if a with a specified name exists. If it does not exist, the code calls the method; if it does the code calls the method. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet223"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet223"::: - ]]> is a null reference ( in Visual Basic). A with the name specified by already exists. - File System Watcher Activity @@ -118,22 +96,9 @@ The name of the to delete. Deletes the specified . - - by calling the method. Finally, the code calls the method to delete the queue associated with a `QueueName` property on the current workflow. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet224"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet224"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). - File System Watcher Activity @@ -160,22 +125,9 @@ Tests for the existence of the specified . if the exists; otherwise, . - - object by calling the method. The code then uses the method to determine if a with a specified name exists. If it does not exist, the code calls the method; if it does the code calls the method. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet223"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet223"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). - File System Watcher Activity @@ -201,23 +153,10 @@ The name of the to retrieve. Retrieves the specified . A object. - - object by calling the method. The code then uses the method to determine if a with a specified name exists. If it does not exist, the code calls the method; if it does the code calls the method. - - This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see [File System Watcher Activity](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741707(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet223"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet223"::: - - ]]> - + To be added. is a null reference ( in Visual Basic). The specified was not found. - File System Watcher Activity diff --git a/xml/System.Workflow.Runtime/WorkflowRuntime.xml b/xml/System.Workflow.Runtime/WorkflowRuntime.xml index 014252a1e5d..c59f8489ab9 100644 --- a/xml/System.Workflow.Runtime/WorkflowRuntime.xml +++ b/xml/System.Workflow.Runtime/WorkflowRuntime.xml @@ -39,16 +39,6 @@ exposes functionality required by a host application and services to configure and control the workflow run-time engine and to be notified of changes to both the workflow run-time engine and any of its workflow instances. - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. It provides examples of how to use the constructor and the , , and methods. The code also shows the recommended way to create a object in a workflow host using the method. It also shows how to set event handlers for the , , and events. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> This type is thread safe. @@ -93,16 +83,6 @@ The default core services are and . - - -## Examples - The following code example demonstrates how you can use functionality from a workflow host. It provides an example of how to use the constructor to create an instance of a and access its methods and events. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> @@ -229,16 +209,6 @@ > [!NOTE] > enforces the restriction that no two services of the same can be added to the . However, you can add multiple services that derive from the same base class. There can be only one service derived from each of the following service base classes in the : the class, the class, and the class. If you add multiple services derived from one of these classes, for example two persistence services, throws an . - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. It provides example of how to use the method to add an and to the workflow run-time engine. - - This code example is part of the [Cancelling a Workflow](https://go.microsoft.com/fwlink/?LinkId=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> @@ -300,16 +270,6 @@ For more information about disabling validation, see . - - -## Examples - The following code example demonstrates the recommended way to create a object in a workflow host using the method. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet260"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet260"::: - ]]> @@ -349,43 +309,6 @@ For more information about disabling validation, see . - - -## Examples - The following example demonstrates how to create a workflow given a XAML-based workflow definition. - -``` -static void Main(string[] args) -{ - using (WorkflowRuntime workflowRuntime = new WorkflowRuntime()) - { - AutoResetEvent waitHandle = new AutoResetEvent(false); - workflowRuntime.WorkflowCompleted += delegate(object sender, WorkflowCompletedEventArgs e) - { - waitHandle.Set(); - }; - workflowRuntime.WorkflowTerminated += delegate(object sender, WorkflowTerminatedEventArgs e) - { - Console.WriteLine(e.Exception.Message); - waitHandle.Set(); - }; - - TypeProvider typeProvider = new TypeProvider(null); - // Add referenced assemblies, if needed - // typeProvider.AddAssembly(...); - workflowRuntime.AddService(typeProvider); - - using (XmlReader reader = XmlReader.Create("Workflow1.xoml")) - { - WorkflowInstance instance = workflowRuntime.CreateWorkflow(reader); - instance.Start(); - } - - waitHandle.WaitOne(); - } -} -``` - ]]> @@ -606,14 +529,6 @@ static void Main(string[] args) should be called only when the host application must free the resources used by the before they are automatically freed by the garbage collector. For general information about , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - - -## Examples - The following example demonstrates how to call on a object. In this sample, the method is called from the FormClosing event handler for the main form of the application; this ensures that the objects created by the runtime are properly cleaned up when the application shuts down. This sample is from the [Speech Application Sample](https://go.microsoft.com/fwlink/?LinkId=157405). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet108"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet108"::: - ]]> @@ -647,14 +562,6 @@ static void Main(string[] args) ## Remarks An empty indicates that no services that implement or derive from the specified have been added to the workflow run-time engine. - - -## Examples - The following example demonstrates how to retrieve all services of a given type from a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet19"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet19"::: - ]]> @@ -692,14 +599,6 @@ static void Main(string[] args) ## Remarks An empty indicates that no services have been added to the workflow run-time engine that implement or derive from the specified generic type. - - -## Examples - The following example demonstrates how to retrieve all services of a given type from a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet6"::: - ]]> The is disposed. @@ -731,14 +630,6 @@ static void Main(string[] args) ## Remarks Note that, unlike , this method does not throw a if the runtime is not started. - - -## Examples - The following example demonstrates how to retrieve a collection of loaded workflows from a object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet18"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet18"::: - ]]> The is disposed. @@ -814,14 +705,6 @@ static void Main(string[] args) ## Remarks throws an if more than one service exists for the specified generic type. Therefore, you should use one of the overloaded methods of if it is possible that multiple services of the generic type are present in the . For example, the workflow run-time engine may have multiple tracking services. If you request a tracking service by specifying the base class, it is possible that an exception will be thrown. - - -## Examples - The following example demonstrates how to retrieve a single service from a object; in this case, a service of type . This example is from the [Workflow Threading Sample](https://go.microsoft.com/fwlink/?LinkId=157350). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet28"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet28"::: - ]]> The has already been disposed of. @@ -857,19 +740,6 @@ static void Main(string[] args) ## Remarks If `instanceId` specifies a workflow instance that is not currently in memory, the workflow instance is loaded into memory and scheduled for execution. For example, after a workflow instance is aborted, you can call to load the workflow instance back into memory. In this case, the last persisted state of the workflow instance is loaded into memory by the persistence service. - - -## Examples - The following code example demonstrates a `ReloadWorkflow` method that calls the method. The `ReloadWorkflow` method is part of a larger class that has a `Runtime` property to access all of the methods, properties, and events of the class. - - This code example is part of the [Custom Persistence Service Sample](https://go.microsoft.com/fwlink/?LinkId=157351) sample. - -> [!NOTE] -> In the example, the call to is redundant because both the and methods use the same internal helper method to load the workflow instance into memory. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet265"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet265"::: - ]]> The workflow runtime is not started. @@ -904,14 +774,6 @@ static void Main(string[] args) > [!NOTE] > You cannot add core services to the workflow run-time engine while it is running. Core services are services that derive from the class, the class, the class, and the class. - - -## Examples - The following example demonstrates how to access the property of a object. In this example, if the runtime is started, a message is printed to the console. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet21"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet21"::: - ]]> @@ -941,14 +803,6 @@ static void Main(string[] args) ## Remarks You cannot set while the workflow run-time engine is running ( is `true`). - - -## Examples - The following example demonstrates how to access the property of a object. In this example, the name of the runtime is set to "Main Runtime". - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet20"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet20"::: - ]]> An attempt to set on a that is disposed occurs. @@ -983,14 +837,6 @@ static void Main(string[] args) ## Remarks You cannot remove a core service while the workflow run-time engine is running ( is `true`). Core services are services that derive from the class, the class, the class, or the class. If `service` derives from the class, calls the method implemented by `service`. - - -## Examples - In the following example, a is added and removed from the . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet16"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet16"::: - ]]> @@ -1034,16 +880,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates with an event handler, a method named `OnExceptionNotHandled`. - - This code example is part of the [Custom Persistence Service Sample](https://go.microsoft.com/fwlink/?LinkID=157351). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet271"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet271"::: - ]]> @@ -1075,14 +911,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - In the following example, an event handler is added to the event of the . In this example, the handler is an anonymous method that prints a simple message to the console. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet15"::: - ]]> @@ -1114,16 +942,6 @@ static void Main(string[] args) You cannot add or remove core services after the workflow run-time engine is started. Core services are services that derive from the class, the class, the class, or the class. If you call while the workflow run-time engine is running, no action is performed. - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code calls the after the creates a instance and after it calls to add services to the runtime. It also calls before any other processing occurs. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkId=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> The is disposed. @@ -1165,14 +983,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - In the following example, an event handler is added to the event of the . In this example, the handler is an anonymous method that prints a simple message to the console. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet14"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet14"::: - ]]> @@ -1206,16 +1016,6 @@ static void Main(string[] args) For more information, see the method. - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. is called after the host has completed all other processing associated with the runtime. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkId=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet259"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet259"::: - ]]> The is already disposed of. @@ -1250,16 +1050,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowAborted`. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet141"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet141"::: - ]]> @@ -1293,16 +1083,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowCompleted`. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkId=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> @@ -1334,16 +1114,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowCreated`. - - This code example is part of the [Custom Persistence Service Sample](https://go.microsoft.com/fwlink/?LinkID=15735). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet271"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet271"::: - ]]> @@ -1377,16 +1147,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowIdled`. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet258"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet258"::: - ]]> @@ -1420,16 +1180,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowLoad`. - - This code example is part of the [Custom Persistence Service](https://go.microsoft.com/fwlink/?LinkID=157351) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet271"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet271"::: - ]]> @@ -1463,16 +1213,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how you can use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowPersisted`. - - This code example is part of the [Custom Persistence Service Sample](https://go.microsoft.com/fwlink/?LinkID=15735). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet279"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet279"::: - ]]> @@ -1506,16 +1246,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how you can use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowResume`. - - This code example is part of the [Suspend and Terminate Sample](https://go.microsoft.com/fwlink/?LinkId=157402). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet171"::: - ]]> @@ -1547,15 +1277,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowStarted`. - - This code example is part of the [Host Communication Sample](https://go.microsoft.com/fwlink/?LinkId=157406). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets38.cs" id="Snippet297"::: - ]]> @@ -1589,16 +1310,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowSuspended`. - - This code example is part of the [Suspend and Terminate Sample](https://go.microsoft.com/fwlink/?LinkID=157402). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet170"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet170"::: - ]]> @@ -1632,16 +1343,6 @@ static void Main(string[] args) For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). - - -## Examples - The following code example demonstrates how to use functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowCompleted`. - - This code example is part of the [Canceling a Workflow](https://go.microsoft.com/fwlink/?LinkID=157346) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet260"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet260"::: - ]]> @@ -1678,15 +1379,6 @@ For the `WorkflowUnloaded` event, the sender contains the functionality from a workflow host. The code associates the with an event handler, a method named `OnWorkflowUnload`. - - This code example is part of the [Custom Persistence Service Sample](https://go.microsoft.com/fwlink/?LinkID=157351). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet271"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet271"::: - ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowStatus.xml b/xml/System.Workflow.Runtime/WorkflowStatus.xml index 371a37c5ea4..c6ae1491101 100644 --- a/xml/System.Workflow.Runtime/WorkflowStatus.xml +++ b/xml/System.Workflow.Runtime/WorkflowStatus.xml @@ -29,19 +29,8 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - -## Examples - The following code example demonstrates how you can use the values to set the property. Each value constrains the in a different way. - - This code example is part of the Workflow Monitor SDK Sample from the DatabaseService.cs file. For more information, see [Workflow Monitor](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet127"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet127"::: - ]]> - Workflow Monitor diff --git a/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml index 85032fbf688..a85d59b4df8 100644 --- a/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml @@ -32,19 +32,8 @@ A workflow instance may be terminated in one of three ways: the host may call , a activity may be invoked from inside the workflow instance, or the workflow runtime engine may terminate the instance because of an unhandled exception. When the workflow instance is terminated, the workflow runtime engine raises the event. The host may subscribe to this event by adding an event handler to . - - -## Examples - The following code example demonstrates an event handler method that takes as a parameter. The `OnWorkflowTerminated` method is called when the event is raised. The code uses the property get the message associated with the exception that caused the workflow to terminate. - - This code example is part of the Sequential Workflow with Parameters SDK Sample from the Program.cs file. For more information, see [Workflow with Parameters Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741685(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet193"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet193"::: - ]]> - Workflow with Parameters Sample @@ -77,19 +66,8 @@ > [!NOTE] > Although in the case of a event that is not due to an unhandled exception, the workflow runtime engine encapsulates a description of the reason for the termination in the property of a , it does not necessarily throw this exception. - - -## Examples - The following code example demonstrates how you can use the property to obtain information about an exception that caused a workflow to terminate. The `OnWorkflowTerminated` method takes a as a parameter. This method is called when the event is raised. The code uses the property get the message associated with the exception that caused the workflow to terminate. - - This code example is part of the Sequential Workflow with Parameters SDK Sample from the Program.cs file. For more information, see [Workflow with Parameters Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741685(v=vs.90)). - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet193"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet193"::: - ]]> - Workflow with Parameters Sample