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
	ParameterizedString()	Initializes a new instance of the ParameterizedString class.
	ParameterizedString(String)	Initializes a new instance of the ParameterizedString class by using the given string.
	ParameterizedString(XmlReader)	Initializes a new instance of the ParameterizedString class by using the provided XML reader.
	ParameterizedString(IEnumerable<ParameterizedStringPart>)	Initializes a new instance of the ParameterizedString class by using the provided list of parameter parts.

Top

Properties

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

Top

Methods

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

Top

Operators

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

Top

Fields

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

Top

Explicit Interface Implementations

	Name	Description
	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