Export (0) Print
Expand All

ExtractText Class

Extracts text from the HtmlDocument that is based on delimiting start/end strings, matching regular expressions, and the occurrence of the text. The extracted text is added to the WebTestContext.

Object
  Microsoft.VisualStudio.TestTools.WebTesting.ExtractionRule
    Microsoft.VisualStudio.TestTools.WebTesting.Rules.ExtractText

Namespace:  Microsoft.VisualStudio.TestTools.WebTesting.Rules
Assembly:  Microsoft.VisualStudio.QualityTools.WebTestFramework (in Microsoft.VisualStudio.QualityTools.WebTestFramework.dll)

public class ExtractText : ExtractionRule

The ExtractText type exposes the following members.

  NameDescription
Public methodExtractTextInitializes a new instance of the ExtractText class.
Top

  NameDescription
Public propertyContextParameterNameGets or sets the context name of the extracted property. (Inherited from ExtractionRule.)
Public propertyEndsWithGets or sets a value that represents the string that delimits the end of the string to extract.
Public propertyExtractRandomMatchIndicates whether the extracted value is chosen randomly from all matches in the HtmlDocument.
Public propertyHtmlDecodeGets or sets a value that indicates whether the extracted value should be HTML decoded before the value is put into the Web performance test context.
Public propertyIgnoreCaseGets or sets a value that indicates whether matching is case-sensitive.
Public propertyIndexGets or sets the zero-based index of the string to match.
Public propertyRequiredGets or sets a value that indicates whether the request fails if the search text is not found.
Public propertyRuleDescription Obsolete. This method is no longer used. Use the DisplayNameAttribute on the class to set a description for this rule. (Inherited from ExtractionRule.)
Public propertyRuleName Obsolete. This method is no longer used. Use the DisplayNameAttribute on the class to set a display name for this rule. (Inherited from ExtractionRule.)
Public propertyStartsWithGets or sets a value that represents the string that delimits the start of the string to extract.
Public propertyUseRegularExpressionGets or sets a value that indicates whether the search strings are regular expressions.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExtractFinds the text that is delimited by the StartsWith and EndsWith properties and adds the text to the WebTestContext. (Overrides ExtractionRule.Extract(Object, ExtractionEventArgs).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

By default, the first occurrence is returned. This will extract any string that is contained in the response body, including any HTML tags.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft