Share via


ParameterizedString Class

Represents a string that has embedded parameters.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.TestManagement.Client.ParameterizedString

Namespace:  Microsoft.TeamFoundation.TestManagement.Client
Assembly:  Microsoft.TeamFoundation.TestManagement.Client (in Microsoft.TeamFoundation.TestManagement.Client.dll)

Syntax

'Declaration
Public Class ParameterizedString _
    Implements IEnumerable(Of ParameterizedStringPart), IEnumerable
public class ParameterizedString : IEnumerable<ParameterizedStringPart>, 
    IEnumerable
public ref class ParameterizedString : IEnumerable<ParameterizedStringPart>, 
    IEnumerable
type ParameterizedString =  
    class
        interface IEnumerable<ParameterizedStringPart>
        interface IEnumerable
    end
public class ParameterizedString implements IEnumerable<ParameterizedStringPart>, IEnumerable

The ParameterizedString type exposes the following members.

Constructors

  Name Description
Public method ParameterizedString() Initializes a new instance of the ParameterizedString class.
Public method ParameterizedString(String) Initializes a new instance of the ParameterizedString class by using the given string.
Public method ParameterizedString(XmlReader) Initializes a new instance of the ParameterizedString class by using the provided XML reader.
Public method ParameterizedString(IEnumerable<ParameterizedStringPart>) Initializes a new instance of the ParameterizedString class by using the provided list of parameter parts.

Top

Properties

  Name Description
Public property Count Gets the number of parts in the string.
Public propertyStatic member Empty Gets an empty parameterized string.
Public property Item Gets the parameter part at the given index of the list of parts.
Public property ParameterNames Gets a read-only collection of parameter names from the list of parameter parts.

Top

Methods

  Name Description
Public method Copy Returns a copy of this parameterized string.
Public method Equals(Object) Returns a value that indicates whether two objects are equal. (Overrides Object.Equals(Object).)
Public method Equals(ParameterizedString) Returns a value that indicates whether the provided parameterized string is equal to this parameterized string.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FromXml Loads the parameters by using the provided XML reader.
Public method GetEnumerator Returns an enumerator that iterates through the parameter parts collection of this parameterized string.
Public method GetHashCode Returns the hash code for this instance. (Overrides Object.GetHashCode().)
Public methodStatic member GetParameterNamingErrorMessage Returns the localized message to be returned for an attempt to add a parameter part by using an invalid parameter name.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member IsValidParameterName Returns a value that indicates whether the provided name is a valid parameter name.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RenameParameter Renames the specified parameter by using the given new name and returns the changed parameterized string.
Public method ReplaceParameter Replaces the specified parameter value by using the given replacement text.
Public method ToString Returns this parameterized string object as a string. (Overrides Object.ToString().)
Public method ToXml Creates an XML representation of this parameterized string and saves it to the provided XML writer.

Top

Operators

  Name Description
Public operatorStatic member Equality Returns the operator to use in code for equality (==).
Public operatorStatic member Implicit(String to ParameterizedString) Converts a string to a parameterized string.
Public operatorStatic member Implicit(ParameterizedString to String) Returns an operator that can be used for implicit comparison of parameterized strings.
Public operatorStatic member Inequality Returns a value that indicates whether two objects are not equal.

Top

Fields

  Name Description
Public fieldStatic member ElementName Contains the name of the element to use when this parameterized string object is saved to XML.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection.

Top

Thread Safety

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

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace

ParameterizedStringPart