Activity クラス

定義

警告

この API は現在使われていません。

ワークフローに不可欠な構成要素を表します。Represents the fundamental building block of workflows. Activity はあらゆるアクティビティの基本クラスです。Activity is the base class for all activities.

public ref class Activity : System::Workflow::ComponentModel::DependencyObject
[System.Drawing.ToolboxBitmap(typeof(System.Workflow.ComponentModel.Activity), "Design.Resources.Activity.png")]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
[System.Workflow.ComponentModel.Compiler.ActivityCodeGenerator(typeof(System.Workflow.ComponentModel.Compiler.ActivityCodeGenerator))]
[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.ComponentModel.Compiler.ActivityValidator))]
[System.Workflow.ComponentModel.Serialization.RuntimeNameProperty("Name")]
public class Activity : System.Workflow.ComponentModel.DependencyObject
type Activity = class
    inherit DependencyObject
Public Class Activity
Inherits DependencyObject
継承
派生
属性

電子メールを送信するというアクティビティを定義した例を以下に示します。This example defines an activity whose purpose is to send an email. Subject というプロパティを定義していますが、これは依存関係プロパティです。The activity defines one property, Subject, that uses a dependency property in its implementation. 他のプロパティも同様にして定義できます。Other properties can be defined in a similar way. Execute メソッドをオーバーライドして、実際に電子メールを送信する処理を組み込んでいます。The Execute method is overridden to provide the logic for sending the email. 完全な例については、電子メールの送信活動のサンプルを参照してください。For a complete example, see the Send Email Activity Sample.

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;  
    }  
}  

注釈

注意

ここでは、廃止された型と名前空間について説明します。This material discusses types and namespaces that are obsolete. 詳細については、「.NET 4.5 での Windows Workflow Foundation の新機能」を参照してください。For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

Activity はワークフロー構築の基礎となるブロックです。An Activity is the fundamental building block of workflows. Activity には、クラスなど一連のプロパティやイベント、およびアクティビティの動作を規定する実行ロジックが定義されています。An Activity defines a set of properties and events, such as any class, along with execution logic that defines the activity's run-time behavior. 各種の追加コンポーネントを Activity に関連付けることができます。A set of additional components can be associated with an Activity. 具体的には、バリデーター、コード ジェネレーター、独自のシリアライザー、デザイナー、その他があります。These include, but are not limited to a validator, a code generator, custom serializers, and a designer.

基本クラスである Activity で定義されたプロパティは、どのアクティビティでも使用できます。All activities share a common set of properties defined on the Activity base class. Activity から派生した各クラスでは、必要に応じて独自のプロパティを追加できます。Each Activity can declare its own additional properties according to its requirements by extending this class. Activity 自身は DependencyObject の派生クラスなので、各プロパティは、標準 CLR プロパティとしても、依存関係プロパティとしても定義可能です。Because Activity derives from DependencyObject, properties can be defined as standard CLR properties and as dependency properties.

Activity の実行ロジックは、当該 Activity とワークフロー ランタイムが連携して動作するようになっています。The execution logic of an Activity fulfills a contract that exists between any Activity and the workflow runtime. Activity の派生クラスでは、ワークフロー開発者がこの Activity の動作を理解できるよう、外部から見た機能としての観点から実行ロジックを文書化する必要があります。You must document the execution logic of any Activity in a functional sense, so that a workflow developer who uses the Activity knows how it behaves. 実行ロジックそのものを、このアクティビティをワークフローに組み込んで使う開発者に公開する必要はありません。これは、ワークフロー ランタイムと Activity がどのように連携して機能を実現しているか、という実装詳細にすぎないからです。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 Activity.

コンストラクター

Activity()

Activity クラスの新しいインスタンスを初期化します。Initializes a new instance of the Activity class.

Activity(String)

Activity クラスの新しいインスタンスを初期化します。その際、Name も初期化します。Initializes a new instance of the Activity class, while initializing the Name.

フィールド

ActivityContextGuidProperty

DependencyProperty に関連付けられた GuidActivityExecutionContext を表す ActivityThe DependencyProperty that represents the Guid of the ActivityExecutionContext that is associated with the Activity.

CancelingEvent

DependencyProperty イベントをターゲットとする Canceling を表します。Represents the DependencyProperty that targets the Canceling event.

ClosedEvent

DependencyProperty イベントをターゲットとする Closed を表します。Represents the DependencyProperty that targets the Closed event.

CompensatingEvent

DependencyProperty イベントをターゲットとする Compensating を表します。Represents the DependencyProperty that targets the Compensating event.

ExecutingEvent

アクティビティの実行時に発生する、DependencyProperty イベントを対象とする Executing を表します。Represents the DependencyProperty that targets the Executing event, which occurs when the activity is executed.

FaultingEvent

DependencyProperty イベントを表す FaultingThe DependencyProperty that represents the Faulting event.

StatusChangedEvent

DependencyProperty イベントをターゲットとする StatusChanged を表します。Represents the DependencyProperty that targets the StatusChanged event.

プロパティ

Description

Activity の、ユーザーが定義した説明を取得または設定します。Gets or sets the user-defined description of the Activity.

DesignMode

このインスタンスがデザイン モードとランタイム モードのどちらであるかを示す値を取得します。Gets the value that indicates whether this instance is in design or run-time mode.

(継承元 DependencyObject)
Enabled

このインスタンスの実行と検証が可能かどうかを示す値を取得または設定します。Gets or sets a value that indicates whether this instance is enabled for execution and validation.

ExecutionResult

このインスタンスを最後に実行した際の ActivityExecutionResult を取得します。Gets the ActivityExecutionResult of the last attempt to run this instance.

ExecutionStatus

このインスタンスの、現在の ActivityExecutionStatus を取得します。Gets the current ActivityExecutionStatus of this instance.

IsDynamicActivity

アクティビティがワークフロー インスタンスの既定の ActivityExecutionContext で実行されているかどうかに関する情報を取得します。Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.

Name

このインスタンスの名前を取得または設定します。Gets or sets the name of this instance. この名前は、ワークフロー プロジェクトの作成に使用されたプログラミング言語の変数の名前付け規則に準拠している必要があります。This name must conform to the variable naming convention of the programming language that is being used in the Workflow project.

Parent

この CompositeActivity を格納している Activity を取得します。Gets the CompositeActivity that contains this Activity.

ParentDependencyObject

DependencyObject グラフにおける親 DependencyObject を取得します。Gets the parent DependencyObject in the DependencyObject graph.

(継承元 DependencyObject)
QualifiedName

アクティビティの限定名を取得します。Gets the qualified name of the activity. 限定アクティビティ名は、ワークフロー インスタンス内で一意です。Qualified activity names are always unique in a workflow instance.

Site

SiteDependencyObject コンポーネントの参照を取得または設定します。Gets or sets a reference to the Site component of the DependencyObject.

(継承元 DependencyObject)
UserData

このクラス インスタンスにカスタム データを関連付ける IDictionary を取得します。Gets an IDictionary that associates custom data with this class instance.

(継承元 DependencyObject)
WorkflowInstanceId

インスタンスに関連付けられた Guid を取得します。Gets the Guid associated with the instance.

メソッド

AddHandler(DependencyProperty, Object)

DependencyObject のイベントを処理するハンドラーを追加します。Adds a handler for an event of a DependencyObject.

(継承元 DependencyObject)
Cancel(ActivityExecutionContext)

実行中のアクティビティを取り消すために、ワークフロー ランタイムから呼び出されます。Called by the workflow runtime to cancel execution of an activity that is currently executing.

Clone()

Activity の詳細コピーを作成します。Creates a deep copy of the Activity.

Dispose()

DependencyObject によって使用されているすべてのリソースを解放します。Releases all the resources used by the DependencyObject.

(継承元 DependencyObject)
Dispose(Boolean)

DependencyObject で使用されているアンマネージド リソースを解放します。オプションでマネージド リソースを解放します。Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject.

(継承元 DependencyObject)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
Execute(ActivityExecutionContext)

アクティビティを実行するために、ワークフロー ランタイムが呼び出します。Called by the workflow runtime to execute an activity.

GetActivityByName(String)

指定された名前の Activity インスタンスを検索して返します。検索範囲は、このインスタンスのルート アクティビティ内、つまりワークフロー内で、現在動作中のアクティビティ全体です。Returns the instance of the Activity whose name is requested from the set of all activities running under the root activity of this instance, which is within the workflow.

GetActivityByName(String, Boolean)

指定された名前の Activity インスタンスを検索して返します。検索範囲は、第 2 パラメーターが false ならばこのインスタンスの Activity のルートの以下のアクティビティ、true ならばこの Activity 内で、現在動作中のアクティビティです。Returns the instance of the Activity whose name is requested from the set of all activities under the root the Activity of this instance if the second parameter is false and under the current Activity if the second parameter is true.

GetBinding(DependencyProperty)

特定の ActivityBind に関連付けられている DependencyProperty にアクセスできるようにします。Provides access to the ActivityBind associated with the specific DependencyProperty.

(継承元 DependencyObject)
GetBoundValue(ActivityBind, Type)

Object のサブジェクトである ActivityBind を取得します。Retrieves the Object that is the subject of an ActivityBind.

(継承元 DependencyObject)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetInvocationList<T>(DependencyProperty)

指定された DependencyProperty のデリゲートを格納する配列を取得します。Gets an array that contains the delegates for the specified DependencyProperty.

(継承元 DependencyObject)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
GetValue(DependencyProperty)

指定した DependencyProperty の値にアクセスできるようにします。Provides access to the value of the designated DependencyProperty.

(継承元 DependencyObject)
GetValueBase(DependencyProperty)

DependencyProperty のバインドされたオブジェクトにアクセスできるようにし、GetValue(DependencyProperty) オーバーライドを省略します。Provides access to the bound object of a DependencyProperty and bypasses the GetValue(DependencyProperty) override.

(継承元 DependencyObject)
HandleFault(ActivityExecutionContext, Exception)

このインスタンスの実行のコンテキスト内で例外が発生したときに呼び出されます。Called when an exception is raised within the context of the execution of this instance.

Initialize(IServiceProvider)

新しいワークフロー インスタンスを構築する際、アクティビティを初期化するために、ワークフロー ランタイムが呼び出します。Called by the workflow runtime to initialize an activity during the construction of a new workflow instance. このメソッドは、動的に ActivityExecutionContext を構築する際に呼び出されます。This method is called during the construction of a dynamic ActivityExecutionContext.

InitializeProperties()

依存関係プロパティを初期化するメソッドとして、派生クラスでオーバーライドします。Performs initialization on dependency properties when overridden in a derived class.

(継承元 DependencyObject)
Invoke<T>(EventHandler<T>, T)

EventHandler を定期受信し、そのデリゲートを呼び出します。Subscribes an EventHandler and invokes that delegate.

Invoke<T>(IActivityEventListener<T>, T)

IActivityEventListener<T> を定期受信し、そのデリゲートを呼び出します。Subscribes an IActivityEventListener<T> and invokes that delegate.

IsBindingSet(DependencyProperty)

DependencyProperty の値がバインディングとして設定されているかどうかを表します。Indicates whether the value of a DependencyProperty is set as a binding. SetBinding(DependencyProperty, ActivityBind)」を参照してください。See SetBinding(DependencyProperty, ActivityBind).

(継承元 DependencyObject)
Load(Stream, Activity)

Activity から Stream のインスタンスを読み込みます。Loads an instance of an Activity from a Stream.

Load(Stream, Activity, IFormatter)

Activity のインスタンスを Stream から読み込みます。逆シリアル化の機能を提供する独自の IFormatter を使います。Loads an instance of an Activity from a Stream using the custom IFormatter for deserialization.

MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MetaEquals(DependencyObject)

この metapropertiesDependencyObject が、パラメーター化された metapropertiesDependencyObject と等しいかどうかを調べます。Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject.

(継承元 DependencyObject)
OnActivityExecutionContextLoad(IServiceProvider)

ActivityExecutionContext を読み込む都度、ワークフロー ランタイムが呼び出します。Called by the workflow runtime whenever an ActivityExecutionContext is loaded. ActivityExecutionContext の作成時ばかりでなく、永続ストレージからワークフロー インスタンスを読み込んで ActivityExecutionContext を復元したときにも呼び出されます。For example, this method is called during the creation of an ActivityExecutionContext as well as every time the ActivityExecutionContext is reincarnated when a workflow instance is loaded from persistent storage.

OnActivityExecutionContextUnload(IServiceProvider)

ActivityExecutionContext をアンロードする都度、ワークフロー ランタイムが呼び出します。Called by the workflow runtime whenever an ActivityExecutionContext is unloaded. ActivityExecutionContext の終了時ばかりでなく、ワークフロー インスタンスを永続ストレージに保存して ActivityExecutionContext をアンロードしたときにも呼び出されます。For example, this method is called during completion of an ActivityExecutionContext as well as every time the ActivityExecutionContext is unloaded when a workflow instance is persisted.

OnClosed(IServiceProvider)

アクティビティをクローズド状態に遷移する過程で、ワークフロー ランタイムが呼び出します。Called by the workflow runtime as part of the activity's transition to the closed state.

RaiseEvent(DependencyProperty, Object, EventArgs)

指定された依存関係プロパティに関連付けられた Event を発生させます。Raises an Event associated with the specified dependency property.

RaiseGenericEvent<T>(DependencyProperty, Object, T)

指定された DependencyProperty に関連付けられたイベントを発生させます。Raises the event associated with the referenced DependencyProperty.

RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

指定された DependencyProperty を状態変更イベントに登録します。Registers the specified DependencyProperty for the status change event.

RemoveHandler(DependencyProperty, Object)

関連付けられた EventHandler から DependencyProperty を削除します。Removes an EventHandler from an associated DependencyProperty.

(継承元 DependencyObject)
RemoveProperty(DependencyProperty)

DependencyProperty から DependencyObject を削除します。Removes a DependencyProperty from the DependencyObject.

(継承元 DependencyObject)
Save(Stream)

ActivityStream に書き込んで永続化します。Writes the Activity to a Stream for persistence.

Save(Stream, IFormatter)

ActivityStream に書き込んで永続化します。シリアル化の機能を提供する独自の IFormatter を使います。Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.

SetBinding(DependencyProperty, ActivityBind)

指定された ActivityBindDependencyProperty を設定します。Sets the ActivityBind for the specified DependencyProperty.

(継承元 DependencyObject)
SetBoundValue(ActivityBind, Object)

ターゲット ActivityBind の値を設定します。Sets the value of the target ActivityBind.

(継承元 DependencyObject)
SetReadOnlyPropertyValue(DependencyProperty, Object)

読み取り専用である DependencyProperty の値を設定します。Sets the value of a DependencyProperty, which is read-only.

(継承元 DependencyObject)
SetValue(DependencyProperty, Object)

DependencyProperty の値をオブジェクトに設定します。Sets the value of the DependencyProperty to the object.

(継承元 DependencyObject)
SetValueBase(DependencyProperty, Object)

DependencyProperty を省略して、Object の値を指定した SetValue(DependencyProperty, Object) に設定します。Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue(DependencyProperty, Object).

(継承元 DependencyObject)
ToString()

このインスタンスを表す文字列を返します。Provides a string that represents this instance.

TrackData(Object)

ランタイム追跡インフラストラクチャに保留の追跡情報を通知します。Informs the run-time tracking infrastructure of pending tracking information.

TrackData(String, Object)

ランタイム追跡インフラストラクチャに保留の追跡情報を通知します。Informs the run-time tracking infrastructure of pending tracking information.

Uninitialize(IServiceProvider)

サービス プロバイダーがアクティビティの初期化を解除するメソッドとして、派生クラスでオーバーライドします。When overridden in a derived class, provides un-initialization by a service provider for the activity.

UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

状態変更イベントから指定された DependencyProperty の登録を解除します。Un-registers the specified DependencyProperty for the status change event.

イベント

Canceling

アクティビティ実行が取り消された場合に発生します。Occurs when the activity execution is canceled.

Closed

Activity の実行終了時に発生します。Occurs when an Activity has completed execution.

Compensating

Activity 上で補正メソッドが起動されたときに発生します。Occurs when running a compensation method on the Activity.

Executing

Activity の実行時に発生します。Occurs when the Activity is run.

Faulting

インスタンスの実行中、例外が発生したときに発生します。Occurs when an exception is raised during the running of the instance.

StatusChanged

実行中の ActivityExecutionStatusActivity が変更された場合に発生します。Occurs when the ActivityExecutionStatus of a running Activity changes.

明示的なインターフェイスの実装

IComponent.Disposed

コンポーネントの Disposed イベントを処理するメソッドを表します。Represents the method that handles the Disposed event of a component.

(継承元 DependencyObject)

適用対象