Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
344 lines (330 sloc) 21.5 KB
<Type Name="Activity" FullName="System.Activities.Activity">
<TypeSignature Language="C#" Value="public abstract class Activity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Activity extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Activities.Activity" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Activity" />
<TypeSignature Language="C++ CLI" Value="public ref class Activity abstract" />
<TypeSignature Language="F#" Value="type Activity = class" />
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Windows.Markup.ContentProperty("Implementation")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An abstract base class used to create composite activities from pre-existing <see cref="T:System.Activities.Activity" /> objects.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Activities.Activity> is the base class in the activity type hierarchy. All other activity types such as <xref:System.Activities.CodeActivity>, <xref:System.Activities.NativeActivity>, <xref:System.Activities.AsyncCodeActivity>, <xref:System.Activities.DynamicActivity>, and <xref:System.Activities.ActivityWithResult> derive from this class.
## Examples
The following example shows a simple implementation of an <xref:System.Activities.Activity> derived class.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Activity ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Activity.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; Activity();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Activities.Activity" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CacheId">
<MemberSignature Language="C#" Value="protected internal int CacheId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CacheId" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.CacheId" />
<MemberSignature Language="VB.NET" Value="Protected Friend ReadOnly Property CacheId As Integer" />
<MemberSignature Language="C++ CLI" Value="protected public:&#xA; property int CacheId { int get(); };" />
<MemberSignature Language="F#" Value="member this.CacheId : int" Usage="System.Activities.Activity.CacheId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the identifier of the cache that is unique within the scope of the workflow definition.</summary>
<value>The identifier of the cache that is unique within the scope of the workflow definition.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CacheMetadata">
<MemberSignature Language="C#" Value="protected virtual void CacheMetadata (System.Activities.ActivityMetadata metadata);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void CacheMetadata(valuetype System.Activities.ActivityMetadata metadata) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Activity.CacheMetadata(System.Activities.ActivityMetadata)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub CacheMetadata (metadata As ActivityMetadata)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual void CacheMetadata(System::Activities::ActivityMetadata metadata);" />
<MemberSignature Language="F#" Value="abstract member CacheMetadata : System.Activities.ActivityMetadata -&gt; unit&#xA;override this.CacheMetadata : System.Activities.ActivityMetadata -&gt; unit" Usage="activity.CacheMetadata metadata" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.ActivityMetadata" />
</Parameters>
<Docs>
<param name="metadata">The activity's metadata that encapsulates the activity's arguments, variables, child activities, and activity delegates.</param>
<summary>Creates and validates a description of the activity's arguments, variables, child activities, and activity delegates.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The workflow runtime uses the default implementation of <xref:System.Activities.Activity.CacheMetadata%2A> to ensure correct construction of a workflow as well as to manage runtime relationships and lifetime rules. The default implementation of <xref:System.Activities.Activity.CacheMetadata%2A> examines the public properties of the activity type using the type's <xref:System.ComponentModel.TypeDescriptor>. These public members are of type <xref:System.Activities.Argument>, <xref:System.Activities.Variable>, `IEnumerable<System.Activities.Variable>`, <xref:System.Activities.Activity>, `IEnumerable<System.Activities.Activity>`, or <xref:System.Activities.ActivityDelegate>. You can override this method to customize the building of the activity's run-time description and to provide custom validation logic.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Constraints">
<MemberSignature Language="C#" Value="protected System.Collections.ObjectModel.Collection&lt;System.Activities.Validation.Constraint&gt; Constraints { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1&lt;class System.Activities.Validation.Constraint&gt; Constraints" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.Constraints" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property Constraints As Collection(Of Constraint)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; property System::Collections::ObjectModel::Collection&lt;System::Activities::Validation::Constraint ^&gt; ^ Constraints { System::Collections::ObjectModel::Collection&lt;System::Activities::Validation::Constraint ^&gt; ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Constraints : System.Collections.ObjectModel.Collection&lt;System.Activities.Validation.Constraint&gt;" Usage="System.Activities.Activity.Constraints" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection&lt;System.Activities.Validation.Constraint&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of <see cref="T:System.Activities.Validation.Constraint" /> activities that can be configured to provide validation for the <see cref="T:System.Activities.Activity" />.</summary>
<value>The collection of constraints.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ DisplayName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="System.Activities.Activity.DisplayName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking.</summary>
<value>A friendly name that is used for debugging, validation, exception handling, and tracking.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is read-only at runtime.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Id { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="System.Activities.Activity.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an identifier that is unique in the scope of the workflow definition.</summary>
<value>An identifier that is unique in the scope of the workflow definition.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Activities.Activity.Id%2A> is used in tracking and validation.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Implementation">
<MemberSignature Language="C#" Value="protected virtual Func&lt;System.Activities.Activity&gt; Implementation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`1&lt;class System.Activities.Activity&gt; Implementation" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.Implementation" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Property Implementation As Func(Of Activity)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual property Func&lt;System::Activities::Activity ^&gt; ^ Implementation { Func&lt;System::Activities::Activity ^&gt; ^ get(); void set(Func&lt;System::Activities::Activity ^&gt; ^ value); };" />
<MemberSignature Language="F#" Value="member this.Implementation : Func&lt;System.Activities.Activity&gt; with get, set" Usage="System.Activities.Activity.Implementation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Windows.Markup.Ambient</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Windows.Markup.XamlDeferLoad(typeof(System.Activities.XamlIntegration.FuncDeferringLoader), typeof(System.Activities.Activity))</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Func&lt;System.Activities.Activity&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the delegate that returns an <see cref="T:System.Activities.Activity" /> that contains the execution logic.</summary>
<value>The delegate that contains the execution logic.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The execution logic can be implemented as several Activity objects by containing them in a Sequence activity or other composite activity.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ImplementationVersion">
<MemberSignature Language="C#" Value="protected internal virtual Version ImplementationVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Version ImplementationVersion" />
<MemberSignature Language="DocId" Value="P:System.Activities.Activity.ImplementationVersion" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable Property ImplementationVersion As Version" />
<MemberSignature Language="C++ CLI" Value="protected public:&#xA; virtual property Version ^ ImplementationVersion { Version ^ get(); void set(Version ^ value); };" />
<MemberSignature Language="F#" Value="member this.ImplementationVersion : Version with get, set" Usage="System.Activities.Activity.ImplementationVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Activities.XamlIntegration.ImplementationVersionConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Version</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the version of the implementation used.</summary>
<value>The version of the implementation</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCreateDynamicUpdateMap">
<MemberSignature Language="C#" Value="protected virtual void OnCreateDynamicUpdateMap (System.Activities.DynamicUpdate.UpdateMapMetadata metadata, System.Activities.Activity originalActivity);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnCreateDynamicUpdateMap(class System.Activities.DynamicUpdate.UpdateMapMetadata metadata, class System.Activities.Activity originalActivity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Activity.OnCreateDynamicUpdateMap(System.Activities.DynamicUpdate.UpdateMapMetadata,System.Activities.Activity)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub OnCreateDynamicUpdateMap (metadata As UpdateMapMetadata, originalActivity As Activity)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual void OnCreateDynamicUpdateMap(System::Activities::DynamicUpdate::UpdateMapMetadata ^ metadata, System::Activities::Activity ^ originalActivity);" />
<MemberSignature Language="F#" Value="abstract member OnCreateDynamicUpdateMap : System.Activities.DynamicUpdate.UpdateMapMetadata * System.Activities.Activity -&gt; unit&#xA;override this.OnCreateDynamicUpdateMap : System.Activities.DynamicUpdate.UpdateMapMetadata * System.Activities.Activity -&gt; unit" Usage="activity.OnCreateDynamicUpdateMap (metadata, originalActivity)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.DynamicUpdate.UpdateMapMetadata" Index="0" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
<Parameter Name="originalActivity" Type="System.Activities.Activity" Index="1" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="metadata">The metadata used.</param>
<param name="originalActivity">The original activity.</param>
<summary>Raises an event when creating dynamic update map.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldSerializeDisplayName">
<MemberSignature Language="C#" Value="public bool ShouldSerializeDisplayName ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ShouldSerializeDisplayName() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Activity.ShouldSerializeDisplayName" />
<MemberSignature Language="VB.NET" Value="Public Function ShouldSerializeDisplayName () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool ShouldSerializeDisplayName();" />
<MemberSignature Language="F#" Value="member this.ShouldSerializeDisplayName : unit -&gt; bool" Usage="activity.ShouldSerializeDisplayName " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the <see cref="P:System.Activities.Activity.DisplayName" /> property should be serialized.</summary>
<returns>
<see langword="true" /> if the <see cref="P:System.Activities.Activity.DisplayName" /> property value should be serialized; otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Activity.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="activity.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a <see cref="T:System.String" /> that contains the <see cref="P:System.Activities.Activity.Id" /> and <see cref="P:System.Activities.Activity.DisplayName" /> of the <see cref="T:System.Activities.Activity" />.</summary>
<returns>The ID and the display name of the activity.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.