ExtractionRule 類別

發行項
05/07/2013

基底類別，用以定義規則以便從 Web 效能測試所產生的 Web 回應中取得資料。

繼承階層架構

System.Object
Microsoft.VisualStudio.TestTools.WebTesting.ExtractionRule
其他...

命名空間： 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)。
	Extract	在衍生類別中發生覆寫時，這個方法會從 HtmlDocument 擷取資訊，並將它放置到 WebTestContext。
	Finalize	允許物件在記憶體回收進行回收之前，嘗試釋放資源並執行其他清除作業。 (繼承自 Object)。
	GetHashCode	做為特定型別的雜湊函式。 (繼承自 Object)。
	GetType	取得目前執行個體的 Type。 (繼承自 Object)。
	MemberwiseClone	建立目前 Object 的淺層複本 (Shallow Copy)。 (繼承自 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

執行緒安全

這個型別的任何 Public static (在 Visual Basic 中為 Shared) 成員都具備執行緒安全。不保證任何執行個體成員是安全執行緒。

請參閱

參考

Microsoft.VisualStudio.TestTools.WebTesting 命名空間

其他資源

HOW TO：建立 Web 效能測試的自訂擷取規則

HOW TO：將擷取規則加入至 Web 效能測試

繼承階層架構

共用方式為

ExtractionRule 類別

繼承階層架構

語法

建構函式

屬性

方法

備註

範例

執行緒安全

請參閱

參考

其他資源

繼承階層架構

其他資源