方法: カスタムアクティビティデザイナーを作成する

2011-02-24

このトピックの内容は、Windows Workflow Foundation 4 に該当します。

カスタムアクティビティデザイナーは、通常、関連付けられたアクティビティを他のアクティビティと組み合わせることができるように実装されます。他のアクティビティのデザイナーは、アクティビティと一緒にデザインサーフェイスにドロップできます。この機能を実現するには、任意のアクティビティを配置できる "ドロップゾーン" と、結果となるデザインサーフェイス上の要素のコレクションを管理するための手段を、カスタムアクティビティデザイナーで提供する必要があります。ここでは、そのようなドロップゾーンを含むカスタムアクティビティデザイナーを作成する方法と、デザイナー要素のコレクションを管理するために必要な編集機能を提供するカスタムアクティビティデザイナーを作成する方法を説明します。

カスタムアクティビティデザイナーは、通常、ActivityDesigner を継承します。これは、特定のデザイナーを持たないアクティビティの既定の基本アクティビティデザイナー型です。この型には、プロパティグリッドと対話し、色やアイコンの管理などの基本的な側面を構成するデザイン時の機能があります。

ActivityDesigner では、カスタムアクティビティデザイナーを開発しやすくする 2 つのヘルパーコントロール WorkflowItemPresenter と WorkflowItemsPresenter を使用します。これらは、子要素のドラッグアンドドロップ、その子要素の削除、選択、追加などの一般的な機能を処理します。WorkflowItemPresenter には、"ドロップゾーン" を提供する 1 つの子 UI 要素を含めることができます。一方、WorkflowItemsPresenter では複数の UI 要素がサポートされており、子要素の順序変更、移動、削除、追加などの機能を使用できます。

カスタムアクティビティデザイナーの実装におけるもう 1 つの重要なポイントは、ビジュアル編集が、デザイナーで編集している対象のメモリ内インスタンスに、WPF データバインディングを使用してバインドされるしくみに関係しています。これは、モデルアイテムツリーによって実現されます。モデルアイテムツリーは、変更通知やイベント (状態の変化など) の追跡を実現するためにも使用されます。

ここでは、次の 2 つの手順の概要を説明します。

1 つ目の手順では、他のアクティビティを受け取るドロップゾーンを提供する WorkflowItemPresenter を使用してカスタムアクティビティデザイナーを作成する方法を説明します。この手順は、「カスタム複合デザイナー - Workflow Item Presenter」に基づいています。
2 つ目の手順では、含まれている要素のコレクションを編集するために必要な機能を提供する WorkflowItemsPresenter を使用してカスタムアクティビティデザイナーを作成する方法を説明します。この手順は、「カスタム複合デザイナー - Workflow Items Presenter」に基づいています。

WorkflowItemPresenter を使用してドロップゾーンを含むカスタムアクティビティデザイナーを作成するには

Visual Studio 2010 を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト…] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストールされているテンプレート] ペインで任意の言語を選択し、[Windows] を選択します。
[テンプレート] ペインで、[WPF アプリケーション] を選択します。
[名前] ボックスに、「UsingWorkflowItemPresenter」と入力します。
[場所] ボックスにプロジェクトを保存するディレクトリを入力するか、[参照] をクリックしてディレクトリを選択します。
[ソリューション] ボックスは既定値のままにしておきます。
[OK] をクリックします。
ソリューションエクスプローラーで MainWindows.xaml ファイルを右クリックし、[削除] をクリックします。Microsoft Visual Studio のダイアログボックスで [OK] をクリックして削除を確定します。
ソリューションエクスプローラーで UsingWorkflowItemPresenter プロジェクトを右クリックし、[追加]、[新しい項目…] の順にクリックして、[新しい項目の追加] ダイアログを表示します。ダイアログの左側にある [インストールされているテンプレート] セクションで、[WPF] カテゴリを選択します。
[ウィンドウ (WPF)] テンプレートを選択し、"RehostingWFDesigner" という名前を付けて、[追加] をクリックします。

RehostingWfDesigner.xaml ファイルを開き、次のコードを貼り付けてアプリケーションの UI を定義します。

<Window x:Class="Microsoft.Samples.UsingWorkflowItemPresenter.RehostingWfDesigner"
        xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:sapt="clr-namespace:System.Activities.Presentation.Toolbox;assembly=System.Activities.Presentation"
        xmlns:sys="clr-namespace:System;assembly=mscorlib"
        Title="Window1" Height="600" Width="900">
    <Window.Resources>
        <sys:String x:Key="AssemblyName">System.Activities, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35</sys:String>
    </Window.Resources>
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="2*"/>
            <ColumnDefinition Width="7*"/>
            <ColumnDefinition Width="3*"/>
        </Grid.ColumnDefinitions>
        <Border Grid.Column="0">
            <sapt:ToolboxControl Name="Toolbox">
                <sapt:ToolboxCategory CategoryName="Basic">
                    <sapt:ToolboxItemWrapper AssemblyName="{StaticResource AssemblyName}" >
                        <sapt:ToolboxItemWrapper.ToolName>
                            System.Activities.Statements.Sequence
                        </sapt:ToolboxItemWrapper.ToolName>
                       </sapt:ToolboxItemWrapper>
                    <sapt:ToolboxItemWrapper  AssemblyName="{StaticResource AssemblyName}">
                        <sapt:ToolboxItemWrapper.ToolName>
                            System.Activities.Statements.WriteLine
                        </sapt:ToolboxItemWrapper.ToolName>

                    </sapt:ToolboxItemWrapper>
                    <sapt:ToolboxItemWrapper  AssemblyName="{StaticResource AssemblyName}">
                        <sapt:ToolboxItemWrapper.ToolName>
                            System.Activities.Statements.If
                        </sapt:ToolboxItemWrapper.ToolName>

                    </sapt:ToolboxItemWrapper>
                    <sapt:ToolboxItemWrapper  AssemblyName="{StaticResource AssemblyName}">
                        <sapt:ToolboxItemWrapper.ToolName>
                            System.Activities.Statements.While
                        </sapt:ToolboxItemWrapper.ToolName>

                    </sapt:ToolboxItemWrapper>
                </sapt:ToolboxCategory>
            </sapt:ToolboxControl>
        </Border>
        <Border Grid.Column="1" Name="DesignerBorder"/>
        <Border Grid.Column="2" Name="PropertyBorder"/>
    </Grid>
</Window>

アクティビティデザイナーをアクティビティタイプと関連付けるには、そのアクティビティデザイナーをメタデータストアを使用して登録する必要があります。この操作を行うには、RegisterMetadata メソッドを RehostingWFDesigner クラスに追加します。RegisterMetadata メソッドのスコープで AttributeTableBuilder オブジェクトを作成し、AddCustomAttributes メソッドを呼び出して属性を追加します。AddAttributeTable メソッドを呼び出して AttributeTable をメタデータストアに追加します。次のコードには、デザイナーの再ホストロジックが含まれています (メタデータの登録、SimpleNativeActivity のツールボックスへの追加、およびワークフローの作成)。このコードを RehostingWFDesigner.xaml.cs ファイルに追加します。

using System;
using System.Activities.Core.Presentation;
using System.Activities.Presentation;
using System.Activities.Presentation.Metadata;
using System.Activities.Presentation.Toolbox;
using System.Activities.Statements;
using System.ComponentModel;
using System.Windows;

namespace UsingWorkflowItemPresenter
{
    // Interaction logic for RehostingWFDesigner.xaml
    public partial class RehostingWFDesigner
    {
        public RehostingWFDesigner()
        {
            InitializeComponent();
        }

        protected override void OnInitialized(EventArgs e)
        {
            base.OnInitialized(e);
            // register metadata
            (new DesignerMetadata()).Register();
            RegisterCustomMetadata();
            // add custom activity to toolbox
            Toolbox.Categories.Add(new ToolboxCategory("Custom activities"));
            Toolbox.Categories[1].Add(new ToolboxItemWrapper(typeof(SimpleNativeActivity)));

            // create the workflow designer
            WorkflowDesigner wd = new WorkflowDesigner();
            wd.Load(new Sequence());
            DesignerBorder.Child = wd.View;
            PropertyBorder.Child = wd.PropertyInspectorView;

        }

        void RegisterCustomMetadata()
        {
            AttributeTableBuilder builder = new AttributeTableBuilder();
            builder.AddCustomAttributes(typeof(SimpleNativeActivity), new DesignerAttribute(typeof(SimpleNativeDesigner)));
            MetadataStore.AddAttributeTable(builder.CreateTable());
        }
    }
}

ソリューションエクスプローラーで [参照設定] ディレクトリを右クリックし、[参照の追加…] をクリックして、[参照の追加] ダイアログを表示します。
[.NET] タブをクリックし、System.Activities.Core.Presentation という名前のアセンブリを見つけて選択し、[OK] をクリックします。
同じ手順で次のアセンブリへの参照を追加します。
1. System.Data.DataSetExtensions.dll
2. System.Activities.Presentation.dll
3. System.ServiceModel.Activities.dll
App.xaml ファイルを開き、StartUpUri の値を "RehostingWFDesigner.xaml" に変更します。
ソリューションエクスプローラーで UsingWorkflowItemPresenter プロジェクトを右クリックし、[追加]、[新しい項目…] の順にクリックして、[新しい項目の追加] ダイアログを表示します。ダイアログの左側にある [インストールされているテンプレート] セクションで、[ワークフロー] カテゴリを選択します。
[アクティビティデザイナー] テンプレートを選択し、"SimpleNativeDesigner" という名前を付けて、[追加] をクリックします。

SimpleNativeDesigner.xaml ファイルを開いて次のコードを貼り付けます。このコードは、ActivityDesigner をルート要素として使用し、子の型を複合アクティビティデザイナーに表示できるように、バインディングを使用してデザイナーに WorkflowItemPresenter を統合する方法を示しています。

注 :
ActivityDesigner のスキーマでは、カスタムアクティビティデザイナー定義に 1 つの子要素のみを追加できます。ただし、この要素は、StackPanel、Grid などの複合 UI 要素の可能性があります。

<sap:ActivityDesigner x:Class="Microsoft.Samples.UsingWorkflowItemPresenter.SimpleNativeDesigner"
    xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:sap="clr-namespace:System.Activities.Presentation;assembly=System.Activities.Presentation"
    xmlns:sapv="clr-namespace:System.Activities.Presentation.View;assembly=System.Activities.Presentation">
    <sap:ActivityDesigner.Resources>
        <DataTemplate x:Key="Collapsed">
            <StackPanel>
                <TextBlock>This is the collapsed view</TextBlock>
            </StackPanel>
        </DataTemplate>
        <DataTemplate x:Key="Expanded">
            <StackPanel>
                <TextBlock>Custom Text</TextBlock>
                <sap:WorkflowItemPresenter Item="{Binding Path=ModelItem.Body, Mode=TwoWay}"
                                        HintText="Please drop an activity here" />
            </StackPanel>
        </DataTemplate>
        <Style x:Key="ExpandOrCollapsedStyle" TargetType="{x:Type ContentPresenter}">
            <Setter Property="ContentTemplate" Value="{DynamicResource Collapsed}"/>
            <Style.Triggers>
                <DataTrigger Binding="{Binding Path=ShowExpanded}" Value="true">
                    <Setter Property="ContentTemplate" Value="{DynamicResource Expanded}"/>
                </DataTrigger>
            </Style.Triggers>
        </Style>
    </sap:ActivityDesigner.Resources>
    <Grid>
        <ContentPresenter Style="{DynamicResource ExpandOrCollapsedStyle}" Content="{Binding}" />
    </Grid>
</sap:ActivityDesigner>

ソリューションエクスプローラーで UsingWorkflowItemPresenter プロジェクトを右クリックし、[追加]、[新しい項目…] の順にクリックして、[新しい項目の追加] ダイアログを表示します。ダイアログの左側にある [インストールされているテンプレート] セクションで、[ワークフロー] カテゴリを選択します。
[コードアクティビティ] テンプレートを選択し、"SimpleNativeActivity" という名前を付けて、[追加] をクリックします。

SimpleNativeActivity.cs ファイルに次のコードを入力して、SimpleNativeActivity クラスを実装します。

using System.Activities;

namespace Microsoft.Samples.UsingWorkflowItemPresenter
{
    public sealed class SimpleNativeActivity : NativeActivity
    {
        // this property contains an activity that will be scheduled in the execute method
// the WorkflowItemPresenter in the designer is bound to this to enable editing
// of the value
        public Activity Body { get; set; }

        protected override void CacheMetadata(NativeActivityMetadata metadata)
        {
           metadata.AddChild(Body);
           base.CacheMetadata(metadata);

        }

        protected override void Execute(NativeActivityContext context)
        {
            context.ScheduleActivity(Body);
        }
    }
}

[ビルド] メニューの [ソリューションのビルド] をクリックします。
[デバッグ] メニューの [デバッグなしで開始] をクリックして、再ホストされたカスタムデザインウィンドウを開きます。

WorkflowItemsPresenter を使用してカスタムアクティビティデザイナーを作成するには

2 つ目のカスタムアクティビティデザイナーの手順は、1 つ目の手順とほとんど同じですが、いくつかの変更点があります。まず、2 つ目のアプリケーションには "UsingWorkflowItemsPresenter" という名前を付けます。また、このアプリケーションでは新しいカスタムアクティビティを定義しません。

主な相違点は、CustomParallelDesigner.xaml ファイルと RehostingWFDesigner.xaml.cs ファイルに含まれています。次のコードは、UI を定義する CustomParallelDesigne.xaml ファイルのコードです。

<sap:ActivityDesigner x:Class="Microsoft.Samples.UsingWorkflowItemsPresenter.CustomParallelDesigner"
    xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:sap="clr-namespace:System.Activities.Presentation;assembly=System.Activities.Presentation"
    xmlns:sapv="clr-namespace:System.Activities.Presentation.View;assembly=System.Activities.Presentation">
    <sap:ActivityDesigner.Resources>
        <DataTemplate x:Key="Collapsed">
            <TextBlock>This is the Collapsed View</TextBlock>
        </DataTemplate>
        <DataTemplate x:Key="Expanded">
            <StackPanel>
                <TextBlock HorizontalAlignment="Center">This is the</TextBlock>
                <TextBlock HorizontalAlignment="Center">extended view</TextBlock>
                <sap:WorkflowItemsPresenter HintText="Drop Activities Here"
                                    Items="{Binding Path=ModelItem.Branches}">
                    <sap:WorkflowItemsPresenter.SpacerTemplate>
                        <DataTemplate>
                            <Ellipse Width="10" Height="10" Fill="Black"/>
                        </DataTemplate>
                    </sap:WorkflowItemsPresenter.SpacerTemplate>
                    <sap:WorkflowItemsPresenter.ItemsPanel>
                        <ItemsPanelTemplate>
                            <StackPanel Orientation="Horizontal"/>
                        </ItemsPanelTemplate>
                    </sap:WorkflowItemsPresenter.ItemsPanel>
                </sap:WorkflowItemsPresenter>
            </StackPanel>
        </DataTemplate>
        <Style x:Key="ExpandOrCollapsedStyle" TargetType="{x:Type ContentPresenter}">
            <Setter Property="ContentTemplate" Value="{DynamicResource Collapsed}"/>
            <Style.Triggers>
                <DataTrigger Binding="{Binding Path=ShowExpanded}" Value="true">
                    <Setter Property="ContentTemplate" Value="{DynamicResource Expanded}"/>
                </DataTrigger>
            </Style.Triggers>
        </Style>
    </sap:ActivityDesigner.Resources>
    <Grid>
        <ContentPresenter Style="{DynamicResource ExpandOrCollapsedStyle}" Content="{Binding}"/>
    </Grid>
</sap:ActivityDesigner>

次のコードは、再ホストロジックを提供する RehostingWFDesigner.xaml.cs ファイルのコードです。

using System;
using System.Activities.Core.Presentation;
using System.Activities.Presentation;
using System.Activities.Presentation.Metadata;
using System.Activities.Statements;
using System.ComponentModel;
using System.Windows;

namespace Microsoft.Samples.UsingWorkflowItemsPresenter
{
    public partial class RehostingWfDesigner : Window
    {
        public RehostingWfDesigner()
        {
            InitializeComponent();
        }

        protected override void OnInitialized(EventArgs e)
        {
            base.OnInitialized(e);
            // register metadata
            (new DesignerMetadata()).Register();
            RegisterCustomMetadata();


            // create the workflow designer
            WorkflowDesigner wd = new WorkflowDesigner();
            wd.Load(new Sequence());
            DesignerBorder.Child = wd.View;
            PropertyBorder.Child = wd.PropertyInspectorView;

        }

        void RegisterCustomMetadata()
        {
            AttributeTableBuilder builder = new AttributeTableBuilder();
            builder.AddCustomAttributes(typeof(Parallel), new DesignerAttribute(typeof(CustomParallelDesigner)));
            MetadataStore.AddAttributeTable(builder.CreateTable());
        }
    }
}

参照

リファレンス

ActivityDesigner
WorkflowItemPresenter
WorkflowItemsPresenter
WorkflowViewElement
ModelItem

その他のリソース

ワークフローデザイン操作のカスタマイズ

次の方法で共有

方法: カスタム アクティビティ デザイナーを作成する

WorkflowItemPresenter を使用してドロップ ゾーンを含むカスタム アクティビティ デザイナーを作成するには

WorkflowItemsPresenter を使用してカスタム アクティビティ デザイナーを作成するには

参照

リファレンス

その他のリソース

その他のリソース

方法: カスタムアクティビティデザイナーを作成する

WorkflowItemPresenter を使用してドロップゾーンを含むカスタムアクティビティデザイナーを作成するには

WorkflowItemsPresenter を使用してカスタムアクティビティデザイナーを作成するには