ExtractionRule クラス

[アーティクル]
08/09/2011

Web パフォーマンステストで生成された Web 応答からデータ取得する規則を定義するために使用される基本クラスです。

継承階層

名前空間: Microsoft.VisualStudio.TestTools.WebTesting
アセンブリ: Microsoft.VisualStudio.QualityTools.WebTestFramework (Microsoft.VisualStudio.QualityTools.WebTestFramework.dll 内)

構文

'宣言
Public MustInherit Class ExtractionRule

public abstract class ExtractionRule

public ref class ExtractionRule abstract

[<AbstractClass>]
type ExtractionRule =  class end

public abstract class ExtractionRule

ExtractionRule 型で公開されるメンバーは以下のとおりです。

コンストラクター

	名前	説明
	ExtractionRule	ExtractionRule クラスの新しいインスタンスを初期化します。

このページのトップへ

プロパティ

	名前	説明
	ContextParameterName	抽出されたプロパティのコンテキスト名を取得または設定します。
	RuleDescription	互換性のために残されています。このメソッドは現在は使用されていません。この規則の説明を設定するには、クラスの DisplayNameAttribute を使用します。
	RuleName	互換性のために残されています。このメソッドは現在は使用されていません。この規則の表示名を設定するには、クラスの DisplayNameAttribute を使用します。

このページのトップへ

メソッド

	名前	説明
	Equals	指定した Object が、現在の Object と等しいかどうかを判断します。 (Object から継承されます。)
	Extract	派生クラスでオーバーライドされている場合、このメソッドは HtmlDocument から情報を抽出し、WebTestContext に配置します。
	Finalize	オブジェクトがガベージコレクションにより収集される前に、そのオブジェクトがリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	ToString	現在のオブジェクトを表す文字列を返します。 (Object から継承されます。)

このページのトップへ

解説

ExtractionRule クラスは、ユーザーによる記述であるか、組み込みであるかの抽出規則によって継承される必要があります。要求定義に関連付けられている抽出規則は、応答が受信された後に実行され、抽出の結果は WebTestContext に追加されます。

継承時の注意

ExtractionRule から継承する場合は、Extract、RuleDescription、RuleName の各メンバーをオーバーライドする必要があります。

例

次のカスタム抽出規則では、HtmlDocument からチェックボックスを抽出し、見つかったチェックボックスのステータスをコンテキストに配置します。

using System;
using Microsoft.VisualStudio.TestTools.WebTesting;

namespace ClassLibrary2
{
    public class ExtractCheckBoxes : ExtractionRule
    {
        private string myContextParameter = "ExtractCBoxParam";
        private bool isChecked = true;

        public override string ContextParameterName
        {
            get { return myContextParameter; }
            set
            {
                if (value != string.Empty)
                    myContextParameter = value;
            }
        }

        public bool FindCheckedBoxes
        {
            get { return isChecked; }
            set { isChecked = value; }
        }

        public override string RuleName
        {
            get { return "Extract Check Boxes"; }
        }

        public override string RuleDescription
        {
            get { return "Extract check boxes based on whether they are" +
                    " checked or not."; }
        }

        public override void Extract(object sender, ExtractionEventArgs e)
        {   
            e.Success = false;
            
            if (e.Response.HtmlDocument != null)
            {   // Gets all input tags
                foreach (HtmlTag tag in e.Response.HtmlDocument
                    .GetFilteredHtmlTags(new string[] { "input" }))
                {   // Verify that current tag is a checkbox
                    if (tag.GetAttributeValueAsString("type") == "checkbox")
                    {   // Is the checkbox checked
                        if (tag.GetAttributeValueAsString("checked") == "CHECKED")
                        {   // Add checked check boxes to context
                            if (isChecked)
                            {
                                e.WebTest.Context.Add(myContextParameter + "_" +
                                    tag.GetAttributeValueAsString("id"),
                                    "Is Checked");
                                e.Success = true;
                            }
                        }
                        else // The checkbox is not checked
                        {   // Add non-checked boxes to context
                            if (!isChecked)
                            {
                                e.WebTest.Context.Add(myContextParameter + "_" +
                                    tag.GetAttributeValueAsString("id"),
                                    "Is Not Checked");
                                e.Success = true;
                            }
                        }
                    }
                }
            }
            if (e.Success)
                e.Message = "Extracted check boxes.";
            else
                e.Message = "No check boxes extracted.";
        }
    }
}

Imports System
Imports Microsoft.VisualStudio.TestTools.WebTesting

Namespace ClassLibrary2
    Public Class ExtractCheckBoxes
        Inherits ExtractionRule

        Private myContextParameter As String = "ExtractCBoxParam"
        Private isChecked As Boolean = True

        Public Overrides Property ContextParameterName() As String
            Get
                Return myContextParameter
            End Get
            Set(ByVal value As String)
                If (value <> String.Empty) Then
                    myContextParameter = value
                End If
            End Set
        End Property

        Public Property FindCheckedBoxes() As Boolean
            Get
                Return isChecked
            End Get
            Set(ByVal value As Boolean)
                isChecked = value
            End Set
        End Property

        Public Overrides ReadOnly Property RuleName() As String
            Get
                Return "Extract Check Boxes"
            End Get
        End Property

        Public Overrides ReadOnly Property RuleDescription() As String
            Get
                Return "Extract check boxes based on whether they are" + _
                    " checked or not."
            End Get
        End Property

        Public Overrides Sub Extract(ByVal sender As Object, ByVal e As ExtractionEventArgs)
            e.Success = False
            If Not e.Response.HtmlDocument Is Nothing Then
                ' Gets all input tags
                Dim tag As HtmlTag
                For Each tag In e.Response.HtmlDocument.GetFilteredHtmlTags(New String() {"input"})
                    ' Verify if current tag is a checkbox
                    If tag.GetAttributeValueAsString("type") = "checkbox" Then
                        ' Is the check box checked
                        If tag.GetAttributeValueAsString("checked") = "CHECKED" Then
                            ' Add checked checkbox to context
                            If isChecked = True Then
                                e.WebTest.Context.Add(myContextParameter + "_" + _
                                tag.GetAttributeValueAsString("id"), "Is Checked")
                                e.Success = True
                            End If
                        Else ' The check box is not checked
                            If isChecked = False Then
                                ' Add non-checked boxes to context
                                e.WebTest.Context.Add(myContextParameter + "_" + _
                                tag.GetAttributeValueAsString("id"), "Is Not Checked")
                                e.Success = True
                            End If
                        End If
                    End If
                Next
            End If
            If e.Success = True Then
                e.Message = "Extracted check boxes."
            Else
                e.Message = "No check boxes extracted."
            End If
        End Sub
    End Class
End Namespace

スレッドセーフ

この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

参照

Microsoft.VisualStudio.TestTools.WebTesting 名前空間

その他の技術情報

方法: Web パフォーマンステストのカスタム抽出規則を作成する

方法: Web パフォーマンステストに抽出規則を追加する

次の方法で共有

ExtractionRule クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

解説

例

スレッドセーフ

参照

参照

その他の技術情報

その他のリソース

次の方法で共有

ExtractionRule クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

解説

例

スレッド セーフ

参照

参照

その他の技術情報

その他のリソース

スレッドセーフ