Type: System.String

startIndex or length is less than zero.

-or-

value is a null pointer and length is not zero.

Remarks

If length is zero, an String.Empty instance is initialized.

This constructor copies Unicode characters from value, starting at startIndex and ending at (startIndex + length - 1).

If the specified range is outside of the memory allocated for the sequence of characters, the behavior of this constructor is system dependent. For example, such a situation might cause an access violation.

In C#, this constructor is defined only in the context of unmanaged code.

See also:
Char | Int32

Return to top

Overloaded ctor #6

Summary: Initializes a new instance of the String class to the value indicated by an array of Unicode characters, a starting character position within that array, and a length.

C# Syntax:


            public String(
   char[] value,
   int startIndex,
   int length
);

Parameters:

value

An array of Unicode characters.

startIndex

The starting position within value.

length

The number of characters within value to use.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null, and startIndex and length are not zero.
ArgumentOutOfRangeException	startIndex or length is less than zero. -or- The sum of startIndex and length is greater than the number of elements in value.

Exception Type

Condition

value is null, and startIndex and length are not zero.

startIndex or length is less than zero.

-or-

The sum of startIndex and length is greater than the number of elements in value.

Remarks

If length is zero, an String.Empty instance is initialized.

This constructor copies Unicode characters from value, starting at startIndex and ending at (startIndex + length - 1).

See also:
Char | Int32

Return to top

Overloaded ctor #7

Summary: Initializes a new instance of the String class to the value indicated by a specified pointer to an array of 8-bit signed integers, a starting character position within that array, and a length.

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)]
unsafe public String(
   sbyte* value,
   int startIndex,
   int length
);

Parameters:

value

A pointer to an array of 8-bit signed integers.

startIndex

The starting position within value.

length

The number of characters within value to use.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	startIndex or length is less than zero. -or- value is a null pointer and length is not zero.

Exception Type

Condition

startIndex or length is less than zero.

-or-

value is a null pointer and length is not zero.

Remarks

If length is zero, an String.Empty instance is initialized.

This constructor copies Unicode characters from value, starting at startIndex and ending at (startIndex + length - 1).

In C#, this constructor is defined only in the context of unmanaged code.

See also:
SByte | Int32

Return to top

Overloaded ctor #8

Summary: Initializes a new instance of the String class to the value indicated by a specified pointer to an array of 8-bit signed integers, a starting character position within that array, a length, and an Encoding object.

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)]
unsafe public String(
   sbyte* value,
   int startIndex,
   int length,
   Encoding enc
);

Parameters:

value

A pointer to an array of 8-bit signed integers.

startIndex

The starting position within value.

length

The number of characters within value to use.

enc

An Encoding object that specifies how the array referenced by value is encoded.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	startIndex or length is less than zero.

Remarks

If value is a null pointer, an String.Empty instance is initialized.

See also:
SByte | Int32

Return to top

Field: Empty

Summary: Represents the empty string. This field is read-only.

C# Syntax:


            public static readonly string Empty;

Remarks

The value of this field is the zero-length string, "".

Return to top

Property: Chars (read-only)

Summary: Gets the character at a specified character position in this instance.

C# Syntax:


					No member name
				
            public char this[int index] {get;}

Parameters:

index

A character position in this instance.

Exceptions

Exception Type	Condition
IndexOutOfRangeException	index is greater than or equal to the length of this object or less than zero.

Remarks

index is zero-based.

See also:
Char | String.GetEnumerator | Int32

Return to top

Property: Length (read-only)

Summary: Gets the number of characters in this instance.

C# Syntax:


            public int Length {get;}

See also:
Int32

Return to top

Method: Clone()

Summary: Returns a reference to this instance of String.

C# Syntax:


            public object Clone();

Return Value:: This instance of String.

Implements:: ICloneable.Clone

Remarks

The return value is not an independent copy of this instance; it is simply another view of the same data. Use the String.Copy or String.CopyTo method to create a separate String object with the same value as this instance.

See also:
Object | String.Copy | String.CopyTo

Return to top

Overloaded Method: Compare(
string strA,
string strB
)

Summary: Compares two specified String objects.

C# Syntax:


            public static int Compare(
   string strA,
   string strB
);

Parameters:

strA

The first String.

strB

The second String.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Meaning
Less than zero	is less than .
Zero	equals .
Greater than zero	is greater than .

Remarks

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

This method performs a case-sensitive operation. The method uses the current culture to determine the ordering of individual characters. Uppercase letters evaluate greater than their lowercase equivalents. The two strings are compared on a character-by-character basis.

See also:
Int32 | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: Compare(
   string strA,
   string strB,
   bool ignoreCase
)

Summary: Compares two specified String objects, ignoring or honoring their case.

C# Syntax:


            public static int Compare(
   string strA,
   string strB,
   bool ignoreCase
);

Parameters:

strA

The first String.

strB

The second String.

ignoreCase

A Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Meaning
Less than zero	is less than .
Zero	equals .
Greater than zero	is greater than .

Remarks

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

This method uses the current culture to determine the ordering of individual characters. The two strings are compared on a character-by-character basis.

See also:
Int32 | String.CompareOrdinal | String.CompareTo | CompareInfo.IsPrefix

Return to top

Overloaded Method: Compare(
   string strA,
   string strB,
   bool ignoreCase,
   CultureInfo culture
)

Summary: Compares two specified String objects, ignoring or honoring their case, and honoring culture-specific information about their formatting.

C# Syntax:


            public static int Compare(
   string strA,
   string strB,
   bool ignoreCase,
   CultureInfo culture
);

Parameters:

strA

The first String.

strB

The second String.

ignoreCase

A Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)

culture

A CultureInfo object that supplies culture-specific formatting information.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Meaning
Less than zero	is less than .
Zero	equals .
Greater than zero	is greater than .

Exceptions

Exception Type	Condition
ArgumentNullException	culture is null.

Remarks

culture specifies a CultureInfo object, which provides culture-specific information that can affect the comparison.

By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other.

See also:
Int32 | String.CompareOrdinal | String.CompareTo | CompareInfo.IsPrefix | Boolean

Return to top

Overloaded Method: Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length
)

Summary: Compares substrings of two specified String objects.

C# Syntax:


            public static int Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length
);

Parameters:

strA

The first String.

indexA

The position of the substring within strA.

strB

The second String.

indexB

The position of the substring within strB.

length

The maximum number of characters in the substrings to compare.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Meaning
Less than zero	The substring in is less than the substring in .
Zero	The substrings are equal, or is zero.
Greater than zero	The substring in is greater than the substring in .

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	The sum of indexA and length is greater than strA.Length. -or- The sum of indexB and length is greater than strB.Length. -or- indexA, indexB, or length is negative.

Exception Type

Condition

The sum of indexA and length is greater than strA.Length.

-or-

The sum of indexB and length is greater than strB.Length.

-or-

indexA, indexB, or length is negative.

Remarks

indexA and indexB are zero-based.

length cannot be negative. If length is zero, then zero is returned.

The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

See also:
Int32 | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length,
   bool ignoreCase
)

Summary: Compares substrings of two specified String objects, ignoring or honoring their case.

C# Syntax:


            public static int Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length,
   bool ignoreCase
);

Parameters:

strA

The first String.

indexA

The position of the substring within strA.

strB

The second String.

indexB

The position of the substring within strB.

length

The maximum number of characters in the substrings to compare.

ignoreCase

A Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value Type	Condition
Less than zero	The substring in is less than the substring in .
Zero	The substrings are equal, or is zero.
Greater than zero	The substring in is greater than the substring in .

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	Either index is outside the series of characters to be compared. -or- length is negative.

Exception Type

Condition

Either index is outside the series of characters to be compared.

-or-

length is negative.

Remarks

indexA and indexB are zero-based.length cannot be negative.

The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

This method uses the current culture to determine the ordering of individual characters. The two strings are compared on a character-by-character basis.

See also:
Int32 | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length,
   bool ignoreCase,
   CultureInfo culture
)

Summary: Compares substrings of two specified String objects, ignoring or honoring their case, and honoring culture-specific information about their formatting.

C# Syntax:


            public static int Compare(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length,
   bool ignoreCase,
   CultureInfo culture
);

Parameters:

strA

The first String.

indexA

The position of the substring within strA.

strB

The second String.

indexB

The position of the substring within the strB.

length

The maximum number of characters in the substrings to compare.

ignoreCase

A Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)

culture

A CultureInfo object that supplies culture-specific formatting information.

Return Value:

An integer indicating the lexical relationship between the two comparands.

Value Type	Condition
Less than zero	The substring in is less than the substring in .
Zero	The substrings are equal, or is zero.
Greater than zero	The substring in is greater than the substring in .

Exceptions

Exception Type

Condition

culture is null.

Either index is outside the series of characters to be compared.

-or-

length is negative.

Remarks

culture specifies a CultureInfo object, which provides culture-specific information that can affect the comparison.length cannot be negative.

The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.

By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other.

See also:
Int32 | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: CompareOrdinal(
string strA,
string strB
)

Summary: Compares two specified String objects, without considering the local national language or culture.

C# Syntax:


            public static int CompareOrdinal(
   string strA,
   string strB
);

Parameters:

strA

The first String.

strB

The second String.

Return Value:

An integer indicating the lexical relationship between the two comparands.

Permission	Description
Less than zero	is less than .
Zero	and are equal.
Greater than zero	is greater than .

Remarks

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

See also:
Int32 | String.Compare | String.CompareTo

Return to top

Overloaded Method: CompareOrdinal(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length
)

Summary: Compares substrings of two specified String objects, without considering the local national language or culture. Parameters specify the length and starting positions of the substrings.

C# Syntax:


            public static int CompareOrdinal(
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length
);

Parameters:

strA

The first String.

indexA

The starting index of the substring in strA.

strB

The second String.

indexB

The starting index of the substring in strB.

length

The maximum number of characters in the substrings to compare.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value Type	Condition
Less than zero	The substring in is less than the substring in .
Zero	The substrings are equal, or is zero.
Greater than zero	The substring in is greater than the substring in .

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	indexA, indexB, or length is negative. -or- The sum of indexA and length is greater than strA.Length. -or- The sum of indexB and length is greater than strB.Length.

Exception Type

Condition

indexA, indexB, or length is negative.

-or-

The sum of indexA and length is greater than strA.Length.

-or-

The sum of indexB and length is greater than strB.Length.

Remarks

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

indexA, indexB, and length must be positive.

The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.

See also:
String.Compare | String.CompareTo | Int32

Return to top

Overloaded Method: CompareTo(
object value
)

Summary: Compares this instance with a specified Object.

C# Syntax:


            public int CompareTo(
   object value
);

Parameters:

value

An Object that evaluates to a String.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Condition
Less than zero	This instance is less than .
Zero	This instance is equal to .
Greater than zero	This instance is greater than value. -or- value is null.

Exceptions

Exception Type	Condition
ArgumentException	value is not a String.

Implements:: IComparable.CompareTo

Remarks

value must be a String object.

By definition, any String, including the empty string, compares greater than null; and two null references compare equal to each other.

See also:
String.Compare | String.CompareOrdinal

Return to top

Overloaded Method: CompareTo(
string strB
)

Summary: Compares this instance with a specified String object.

C# Syntax:


            public int CompareTo(
   string strB
);

Parameters:

strB

A String.

Return Value:

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Condition
Less than zero	This instance is less than .
Zero	This instance is equal to .
Greater than zero	This instance is greater than value. -or- value is null.

Remarks

By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other.

See also:
String.Compare | String.CompareOrdinal

Return to top

Overloaded Method: Concat(
object arg0
)

Summary: Creates the String representation of a specified object.

C# Syntax:


            public static string Concat(
   object arg0
);

Parameters:

arg0

An Object or null.

Return Value:: The String representation of the value of arg0.

Remarks

An String.Empty string is used in place of any null argument.

Return to top

Overloaded Method: Concat(
params object[] args
)

Summary: Concatenates the String representations of the elements in a specified Object array.

C# Syntax:


            public static string Concat(
   params object[] args
);

Parameters:

args

An Object array.

Return Value:: The concatenated String representations of the values of the elements in args.

Exceptions

Exception Type	Condition
ArgumentNullException	args is null.

Remarks

An String.Empty string is used in place of any null object in the array.

Return to top

Overloaded Method: Concat(
params string[] values
)

Summary: Concatenates the elements of a specified String array.

C# Syntax:


            public static string Concat(
   params string[] values
);

Parameters:

values

An array of String instances.

Return Value:: The concatenated elements of values.

Exceptions

Exception Type	Condition
ArgumentNullException	values is null.

Remarks

An String.Empty string is used in place of any null object in the array.

Return to top

Overloaded Method: Concat(
object arg0,
object arg1
)

Summary: Concatenates the String representations of two specified objects.

C# Syntax:


            public static string Concat(
   object arg0,
   object arg1
);

Parameters:

arg0

The first Object.

arg1

The second Object.

Return Value:: The concatenated String representations of the values of arg0 and arg1.

Remarks

An String.Empty string is used in place of any null argument.

If either of the arguments is an array reference, the method concatenates a string representing that array, instead of its members (for example, "System.String[]").

Return to top

Overloaded Method: Concat(
string str0,
string str1
)

Summary: Concatenates two specified instances of String.

C# Syntax:


            public static string Concat(
   string str0,
   string str1
);

Parameters:

str0

The first String.

str1

The second String.

Return Value:: The concatenation of str0 and str1.

Remarks

An String.Empty string is used in place of any null argument.

Return to top

Overloaded Method: Concat(
   object arg0,
   object arg1,
   object arg2
)

Summary: Concatenates the String representations of three specified objects.

C# Syntax:


            public static string Concat(
   object arg0,
   object arg1,
   object arg2
);

Parameters:

arg0

The first Object.

arg1

The second Object.

arg2

The third Object.

Return Value:: The concatenated String representations of the values of arg0, arg1, and arg2.

Remarks

An String.Empty string is used in place of any null argument.

Return to top

Overloaded Method: Concat(
   string str0,
   string str1,
   string str2
)

Summary: Concatenates three specified instances of String.

C# Syntax:


            public static string Concat(
   string str0,
   string str1,
   string str2
);

Parameters:

str0

The first String.

str1

The second String.

str2

The third String.

Return Value:: The concatenation of str0, str1, and str2.

Remarks

An String.Empty string is used in place of any null argument.

Return to top

Overloaded Method: Concat

Summary: Concatenates the String representations of three specified objects and a variable-length parameter list.

Parameters:

arg0

The first Object.

arg1

The second Object.

arg2

The third Object.

arg3

The fourth Object.

Return Value:: The concatenated String representations of the values of arg0, arg1, arg2, arg3, and zero or more objects specified in a variable-length parameter list.

Remarks

Additional arguments can be included in a variable-length parameter list.

An String.Empty string is used in place of any null argument.

Return to top

Overloaded Method: Concat(
   string str0,
   string str1,
   string str2,
   string str3
)

Summary: Concatenates four specified instances of String.

C# Syntax:


            public static string Concat(
   string str0,
   string str1,
   string str2,
   string str3
);

Parameters:

str0

The first String.

str1

The second String.

str2

The third String.

str3

The fourth String.

Return Value:: The concatenation of str0, str1, str2, and str3.

Remarks

An String.Empty string is used in place of any null object in the array.

Return to top

Method: Copy(
string str
)

Summary: Creates a new instance of String with the same value as a specified String.

C# Syntax:


            public static string Copy(
   string str
);

Parameters:

str

The String to copy.

Return Value:: A new String with the same value as str.

Exceptions

Exception Type	Condition
ArgumentNullException	str is null.

See also:
String.Empty | DBNull

Return to top

Method: CopyTo(
   int sourceIndex,
   char[] destination,
   int destinationIndex,
   int count
)

Summary: Copies a specified number of characters from a specified position in this instance to a specified position in an array of Unicode characters.

C# Syntax:


            public void CopyTo(
   int sourceIndex,
   char[] destination,
   int destinationIndex,
   int count
);

Parameters:

sourceIndex

A character position in this instance.

destination

An array of Unicode characters.

destinationIndex

An array element in destination.

count

The number of characters in this instance to copy to destination.

Exceptions

Exception Type

Condition

destination is null.

sourceIndex, destinationIndex, or count is negative

-or-

count is greater than the length of the substring from startIndex to the end of this instance

-or-

count is greater than the length of the subarray from destinationIndex to the end of destination

Remarks

count characters are copied from the sourceIndex position of this instance to the destinationIndex position of destination.

sourceIndex and destinationIndex are zero-based.

See also:
Char | Int32 | String.Insert | String.Substring

Return to top

Method: EndsWith(
string value
)

Summary: Determines whether the end of this instance matches the specified String.

C# Syntax:


            public bool EndsWith(
   string value
);

Parameters:

value

A String.

Return Value:: true if the end of this instance matches value; otherwise, false.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

This method compares value with the substring at the end of the current instance that has a length of value.Length.

The comparison is case-sensitive.

See also:
String.StartsWith

Return to top

Overloaded Method: Equals(
object obj
)

Summary: Determines whether this instance of String and a specified object, which must be a String, have the same value.

C# Syntax:


            public override bool Equals(
   object obj
);

Parameters:

obj

An Object.

Return Value:: true if obj is a String and its value is the same as this instance; otherwise, false.

Exceptions

Exception Type	Condition
NullReferenceException	This instance is null.

Remarks

This method checks for value equality.

This comparison is case-sensitive.

See also:
Object | String.Compare | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: Equals(
string value
)

Summary: Determines whether this instance and a specified String have the same value.

C# Syntax:


            public bool Equals(
   string value
);

Parameters:

value

A String.

Return Value:: true if the value of value is the same as this instance; otherwise, false.

Exceptions

Exception Type	Condition
NullReferenceException	This instance is null.

Remarks

This comparison is case-sensitive.

See also:
Object | String.Compare | String.CompareOrdinal | String.CompareTo

Return to top

Overloaded Method: Equals(
string a,
string b
)

Summary: Determines whether two specified String objects have the same value.

C# Syntax:


            public static bool Equals(
   string a,
   string b
);

Parameters:

A String or null.

Return Value:: true if the value of a is the same as the value of b; otherwise, false.

Remarks

The comparison is case-sensitive.

See also:
Object | String.Compare | String.CompareOrdinal | String.CompareTo

Return to top

Method: Finalize()

Inherited
See base class member description: System.Object.Finalize

C# Syntax:


            ~String();

For more information on members inherited from System.Object click on the link above.

Return to top

Overloaded Method: Format(
string format,
object arg0
)

Summary: Replaces the format specification in a specified String with the textual equivalent of the value of a specified Object instance.

C# Syntax:


            public static string Format(
   string format,
   object arg0
);

Parameters:

format

A String containing zero or more format specifications.

arg0

An Object to be formatted.

Return Value:: A copy of format in which the first format specification has been replaced by the String equivalent of arg0.

Exceptions

Exception Type

Condition

format or arg0 is null.

The format specification in format is invalid.

-or-

The number indicating an argument to be formatted (N) is less than zero, or larger than or equal to the length of the args array.

Remarks

The format parameter is embedded with zero or more format specifications of the form, { N [, M ][: formatString ]}, where:

N is a zero-based integer indicating the argument to be formatted.
M is an optional integer indicating the width of the region to contain the formatted value, padded with spaces. If the sign of M is negative, the formatted value is left-justified in the region; if the sign of M is positive, the value is right-justified.
formatString is an optional string of formatting codes.

If argN implements IFormattable, then argN.Format(formatString, null) provides formatting; otherwise argN.ToString() provides formatting. If argN is null, then an empty string is used in its place.

If formatString is omitted, the ToString() method of the argument specified by N provides formatting.

If the value of format is, "Thank you for your purchase of {0:####} copies of Microsoft® .NET (Core Reference).", and arg0 is an Int16 with the value 123, then the return value will be:

"Thank you for your purchase of 123 copies of Microsoft® .NET (Core Reference)."

If the value of format is, "Brad's dog has {0,-8:G} fleas.", arg0 is an Int16 with the value 42, (and in this example, underscores represent padding spaces) then the return value will be:

"Brad's dog has 42______ fleas."

See also:
Object | IFormattable | MSDN: formattingoverview

Return to top

Overloaded Method: Format(
string format,
params object[] args
)

Summary: Replaces the format specification in a specified String with the textual equivalent of the value of a corresponding Object instance in a specified array.

C# Syntax:


            public static string Format(
   string format,
   params object[] args
);

Parameters:

format

A String containing zero or more format specifications.

args

An Object array containing zero or more objects to be formatted.

Return Value:: A copy of format in which the format specifications have been replaced by the String equivalent of the corresponding instances of Object in args.

Exceptions

Exception Type

Condition

format or args is null.

format is invalid.

-or-

The number indicating an argument to be formatted (N) is less than zero, or larger than or equal to the length of the args array.

Remarks

The format parameter is embedded with zero or more format specifications of the form, { N [, M ][: formatString ]}, where:

N is a zero-based integer indicating the argument to be formatted.
M is an optional integer indicating the width of the region to contain the formatted value, padded with spaces. If the sign of M is negative, the formatted value is left-justified in the region; if the sign of M is positive, the value is right-justified.
formatString is an optional string of formatting codes.

If formatString is omitted, the ToString() method of the argument specified by N provides formatting.

If the value of format is, "Thank you for your purchase of {0:####} copies of Microsoft® .NET (Core Reference).", and arg[0] is an Int16 with the value 123, then the return value will be:

"Thank you for your purchase of 123 copies of Microsoft® .NET (Core Reference)."

If the value of format is, "Brad's dog has {0,-8:G} fleas.", arg[0] is an Int16 with the value 42, (and in this example, underscores represent padding spaces) then the return value will be:

"Brad's dog has 42______ fleas."

See also:
Object | IFormattable | MSDN: formattingoverview

Return to top

Overloaded Method: Format(
   IFormatProvider provider,
   string format,
   params object[] args
)

Summary: Replaces the format specification in a specified String with the textual equivalent of the value of a corresponding Object instance in a specified array. A specified parameter supplies culture-specific formatting information.

C# Syntax:


            public static string Format(I Format(
   IFormatProvider provider,
   string format,
   params object[] args
);

Parameters:

provider

An IFormatProvider that supplies culture-specific formatting information.

format

A String containing zero or more format specifications.

args

An Object array containing zero or more objects to be formatted.

Return Value:: A copy of format in which the format specifications have been replaced by the String equivalent of the corresponding instances of Object in args.

Exceptions

Exception Type

Condition

format or args is null.

format is invalid.

-or-

The number indicating an argument to be formatted (N) is less than zero, or larger than or equal to the length of the args array.

Remarks

The format parameter is embedded with zero or more format specifications of the form, { N [, M ][: formatString ]}, where:

N is a zero-based integer indicating the argument to be formatted.
M is an optional integer indicating the width of the region to contain the formatted value, padded with spaces. If the sign of M is negative, the formatted value is left-justified in the region; if the sign of M is positive, the value is right-justified.
formatString is an optional string of formatting codes.

If formatString is omitted, the ToString() method of the argument specified by N provides formatting.

If the value of format is, "Thank you for your purchase of {0:####} copies of Microsoft® .NET (Core Reference).", and arg[0] is an Int16 with the value 123, then the return value will be:

"Thank you for your purchase of 123 copies of Microsoft® .NET (Core Reference)."

If the value of format is, "Brad's dog has {0,-8:G} fleas.", arg[0] is an Int16 with the value 42, (and in this example, underscores represent padding spaces) then the return value will be:

"Brad's dog has 42______ fleas."

See also:
Object | IFormattable | IFormatProvider | MSDN: formattingoverview

Return to top

Overloaded Method: Format(
   string format,
   object arg0,
   object arg1
)

Summary: Replaces the format specification in a specified String with the textual equivalent of the value of two specified Object instances.

C# Syntax:


            public static string Format(
   string format,
   object arg0,
   object arg1
);

Parameters:

format

A String containing zero or more format specifications.

arg0

The first Object to be formatted.

arg1

The second Object to be formatted.

Return Value:: A copy of format in which the first and second format specifications have been replaced by the String equivalent of the arg0 and arg1.

Exceptions

Exception Type

Condition

format is null.

format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted.

Remarks

The format parameter is embedded with zero or more format specifications of the form, { N [, M ][: formatString ]}, where:

N is a zero-based integer indicating the argument to be formatted.
M is an optional integer indicating the width of the region to contain the formatted value, padded with spaces. If the sign of M is negative, the formatted value is left-justified in the region; if the sign of M is positive, the value is right-justified.
formatString is an optional string of formatting codes.

If formatString is omitted, the ToString() method of the argument specified by N provides formatting.

If the value of format is, "Thank you for your purchase of {0:####} copies of Microsoft® .NET (Core Reference).", and arg0 is an Int16 with the value 123, then the return value will be:

"Thank you for your purchase of 123 copies of Better Basket Weaving."

If the value of format is, "Brad's dog has {0,-8:G} fleas.", arg0 is an Int16 with the value 42, (and in this example, underscores represent padding spaces) then the return value will be:

"Brad's dog has 42______ fleas."

See also:
Object | IFormattable | MSDN: formattingoverview

Return to top

Overloaded Method: Format(
   string format,
   object arg0,
   object arg1,
   object arg2
)

Summary: Replaces the format specification in a specified String with the textual equivalent of the value of three specified Object instances.

C# Syntax:


            public static string Format(
   string format,
   object arg0,
   object arg1,
   object arg2
);

Parameters:

format

A String containing zero or more format specifications.

arg0

The first Object to be formatted.

arg1

The second Object to be formatted.

arg2

The third Object to be formatted.

Return Value:: A copy of format in which the first, second, and third format specifications have been replaced by the String equivalent of the arg0,arg1, and arg2.

Exceptions

Exception Type

Condition

format is null.

format is invalid.

-or-

The number indicating an argument to be formatted is less than zero, or larger than or equal to the number of provided objects to be formatted.

Remarks

The format parameter is embedded with zero or more format specifications of the form, { N [, M ][: formatString ]}, where:

N is a zero-based integer indicating the argument to be formatted.
M is an optional integer indicating the width of the region to contain the formatted value, padded with spaces. If the sign of M is negative, the formatted value is left-justified in the region; if the sign of M is positive, the value is right-justified.
formatString is an optional string of formatting codes.

If formatString is omitted, the ToString() method of the argument specified by N provides formatting.

If the value of format is, "Thank you for your purchase of {0:####} copies of Microsoft® .NET (Core Reference).", and arg0 is an Int16 with the value 123, then the return value will be:

"Thank you for your purchase of 123 copies of Microsoft® .NET (Core Reference)."

If the value of format is, "Brad's dog has {0,-8:G} fleas.", arg0 is an Int16 with the value 42, (and in this example, underscores represent padding spaces) then the return value will be:

"Brad's dog has 42______ fleas."

See also:
Object | IFormattable | MSDN: formattingoverview

Return to top

Method: GetEnumerator()

Summary: Retrieves an object that can iterate through the individual characters in this instance.

C# Syntax:


            public CharEnumerator GetEnumerator();

Return Value:: A CharEnumerator object.

Remarks

This method is required by programming languages that support the IEnumerator interface to iterate through members of a collection. For example, the Microsoft Visual Basic and C# programming languages' foreach statement invokes this method to return a CharEnumerator object that can provide read-only access to the characters in this instance of String.

See also:
IEnumerator | IEnumerable | String.Chars

Return to top

Overridden Method: GetHashCode()

Summary: Returns the hash code for this instance.

C# Syntax:


            public override int GetHashCode();

Return Value:: A 32-bit signed integer hash code.

See also:
Int32

Return to top

Method: GetType()

Inherited
See base class member description: System.Object.GetType

C# Syntax:


            public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: GetTypeCode()

Summary: Returns the TypeCode for class String.

C# Syntax:


            public TypeCode GetTypeCode();

Return Value:: The enumerated constant, TypeCode.String.

Implements:: IConvertible.GetTypeCode

Return to top

Overloaded Method: IndexOf(
char value
)

Summary: Reports the index of the first occurrence of the specified Unicode character in this instance.

C# Syntax:


            public int IndexOf(
   char value
);

Parameters:

value

A Unicode character to seek.

Return Value:: A positive 32-bit signed integer, the index, that is the character position in this instance where value was found; otherwise, -1 if value was not found.

Remarks

Index numbering starts from zero.

The search for value is case-sensitive.

This method performs an ordinal (culture-insensitive) search, where a character is considered equivalent to another character only if the Unicode values are the same. To perform a culture-sensitive search, use the CompareInfo.IndexOf method, where a Unicode value representing a precomposed character, such as the ligature 'Æ' (U+00C6), might be considered equivalent to any occurrence of the character's components in the correct sequence, such as "AE" (U+0041, U+0045), depending on the culture.

See also:
Char | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOf(
string value
)

Summary: Reports the index of the first occurrence of the specified String in this instance.

C# Syntax:


            public int IndexOf(
   string value
);

Parameters:

value

The String to seek.

Return Value:

Value	Meaning
A positive index position.	was found.
0	is String.Empty .
-1	was not found.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

The search begins at the first character position of this instance and continues until the last character position. The search is case-sensitive and uses the current culture.

See also:
Int32 | CultureInfo | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOf(
char value,
int startIndex
)

Summary: Reports the index of the first occurrence of the specified Unicode character in this instance. The search starts at a specified character position.

C# Syntax:


            public int IndexOf(
   char value,
   int startIndex
);

Parameters:

value

A Unicode character to seek.

startIndex

The search starting position.

Return Value:: A positive 32-bit signed integer, the index, indicating the character position in this instance where value was found; otherwise, -1 if value was not found.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	startIndex is less than zero or specifies a position beyond the end of this instance.

Remarks

Index numbering starts from zero.

The search ranges from startIndex to the end of the string.

The search for value is case-sensitive.

See also:
Int32 | Char | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOf(
string value,
int startIndex
)

Summary: Reports the index of the first occurrence of the specified String in this instance. The search starts at a specified character position.

C# Syntax:


            public int IndexOf(
   string value,
   int startIndex
);

Parameters:

value

The String to seek.

startIndex

The search starting position.

Return Value:

Value	Meaning
A positive index position.	was found.
	is String.Empty .
-1	was not found.

Exceptions

Exception Type

Condition

anyOf is null.

startIndex is negative.

-or-

startIndex specifies a position not within this instance.

Remarks

The search begins at the startIndex character position of this instance and continues until the last character position. The search is case-sensitive and uses the current culture.

See also:
Int32 | CultureInfo | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOf(
   char value,
   int startIndex,
   int count
)

Summary: Reports the index of the first occurrence of the specified character in this instance. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int IndexOf(
   char value,
   int startIndex,
   int count
);

Parameters:

value

A Unicode character to seek.

startIndex

The search starting position.

count

The number of character positions to examine.

Return Value:: A positive 32-bit signed integer, the index, that is the character position in this instance where value was found; otherwise, -1 if value was not found.

Exceptions

Exception Type

Condition

count or startIndex is negative.

-or-

count + startIndex specifies a position beyond the end of this instance.

Remarks

The search begins at startIndex and continues to startIndex + count -1. The character at startIndex + count is not included in the search.

Index numbering starts from zero.

The search for value is case-sensitive.

See also:
Char | Int32 | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOf(
   string value,
   int startIndex,
   int count
)

Summary: Reports the index of the first occurrence of the specified String in this instance. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int IndexOf(
   string value,
   int startIndex,
   int count
);

Parameters:

value

The String to seek.

startIndex

The search starting position.

count

The number of character positions to examine.

Return Value:

Value	Meaning
A positive index position.	was found.
	is String.Empty .
-1	was not found.

Exceptions

Exception Type

Condition

value is null.

count or startIndex is negative.

-or-

count plus startIndex specify a position not within this instance.

Remarks

The search begins at startIndex and continues to startIndex + count -1. The character at startIndex + count is not included in the search.

The search is case-sensitive and uses the current culture.

See also:
Int32 | CultureInfo | String.IndexOfAny | String.LastIndexOf | String.LastIndexOfAny

Return to top

Overloaded Method: IndexOfAny(
char[] anyOf
)

Summary: Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters.

C# Syntax:


            public int IndexOfAny(
   char[] anyOf
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

Return Value:: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type	Condition
ArgumentNullException	anyOf is null.

Remarks

Index numbering starts from zero.

The search for anyOf is case-sensitive.

Return to top

Overloaded Method: IndexOfAny(
char[] anyOf,
int startIndex
)

Summary: Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters. The search starts at a specified character position.

C# Syntax:


            public int IndexOfAny(
   char[] anyOf,
   int startIndex
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

startIndex

The search starting position.

Return Value:: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type

Condition

anyOf is null.

startIndex is negative.

-or-

startIndex is greater than the number of characters in this instance.

Remarks

Index numbering starts from zero.

The search ranges from startIndex to the end of the string.

The search for anyOf is case-sensitive.

Return to top

Overloaded Method: IndexOfAny(
   char[] anyOf,
   int startIndex,
   int count
)

Summary: Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int IndexOfAny(
   char[] anyOf,
   int startIndex,
   int count
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

startIndex

The search starting position.

count

The number of character positions to examine.

Return Value:: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type

Condition

anyOf is null.

count or startIndex is negative.

-or-

count + startIndex is greater than the number of characters in this instance.

Remarks

The search begins at startIndex and continues to startIndex + count -1. The character at startIndex + count is not included in the search.

Index numbering starts from zero.

The search for anyOf is case-sensitive.

Return to top

Method: Insert(
int startIndex,
string value
)

Summary: Inserts a specified instance of String at a specified index position in this instance.

C# Syntax:


            public string Insert(
   int startIndex,
   string value
);

Parameters:

startIndex

The index position of the insertion.

value

The String to insert.

Return Value:: A new String equivalent to this instance but with value inserted at position startIndex.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.
ArgumentOutOfRangeException	startIndex is negative or greater than the length of this instance.

Remarks

If startIndex is equal to the length of this instance, value is appended to the end of this instance.

For example, the return value of "abc".Insert(2, "XYZ") is "abXYZc".

Return to top

Method: Intern(
string str
)

Summary: Retrieves the system's reference to the specified String.

C# Syntax:


            public static string Intern(
   string str
);

Parameters:

str

A String, or null.

Return Value:: The String reference to str.

Exceptions

Exception Type	Condition
ArgumentNullException	str is null.

Remarks

The common language runtime automatically maintains a table, called the "intern pool", which contains a single instance of each unique literal string constant declared in a program, as well as any unique instance of String you add programmatically.

The intern pool conserves string storage. If you assign a literal string constant to several variables, each variable is set to reference the same constant in the intern pool instead of referencing several different instances of String that have identical values.

This method looks up str in the intern pool. If str exists, a reference to it is returned. If str does not exist, an instance equal to str is added to the intern pool and a reference that instance is returned.

The code below generates a new String, "MyTest", using the StringBuilder class, and puts it into the intern pool. The string, s1, has already been interned because it is a literal in our program. The string, s2, has the same value, but is a different object than the one referenced by s3.

String s1 = "MyTest";

String s2 = new StringBuilder().Append("My").Append("Test").ToString();

String s3 = String.Intern(s2);

Console.WriteLine((Object)s2==(Object)s1); // Different references.

Console.WriteLine((Object)s3==(Object)s2); // The same reference.

Compare this method to the String.IsInterned method.

See also:
String.IsInterned

Return to top

Method: IsInterned(
string str
)

Summary: Retrieves a reference to a specified String.

C# Syntax:


            public static string IsInterned(
   string str
);

Parameters:

str

A String.

Return Value:: A String reference to str if it is in the common language runtime "intern pool"; otherwise null.

Exceptions

Exception Type	Condition
ArgumentNullException	str is null.

Remarks

This method looks up str in the intern pool. If str has already been interned, a reference to that instance is returned; otherwise, null is returned.

Compare this method to the String.Intern method.

This method does not return a Boolean value, but can still be used where a Boolean is needed.

See also:
String.Intern

Return to top

Overloaded Method: Join(
string separator,
string[] value
)

Summary: Concatenates a specified separator String between each element of a specified String array, yielding a single concatenated string.

C# Syntax:


            public static string Join(
   string separator,
   string[] value
);

Parameters:

separator

A String.

value

An array of String s.

Return Value:: A String consisting of the elements of value interspersed with the separator string.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

For example if separator is ", " and the elements of value are "apple", "orange", "grape", and "pear",


                Join(separator, value)

returns "apple, orange, grape, pear".

Return to top

Overloaded Method: Join(
   string separator,
   string[] value,
   int startIndex,
   int count
)

Summary: Concatenates a specified separator String between each element of a specified String array, yielding a single concatenated string. Parameters specify the first array element and number of elements to use.

C# Syntax:


            public static string Join(
   string separator,
   string[] value,
   int startIndex,
   int count
);

Parameters:

separator

A String.

value

An array of String.

startIndex

The first array element in value to use.

count

The number of elements of value to use.

Return Value:

A String consisting of the strings in value joined by separator.

-or-

String.Empty if count is zero, value has no elements, or separator and all the elements of value are String.Empty.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	startIndex plus count is greater than the number of elements in value.

Remarks

For example if separator is ", " and the elements of value are "apple", "orange", "grape", and "pear",


                Join(separator, value, 1, 2)

returns "orange, grape".

Return to top

Overloaded Method: LastIndexOf(
char value
)

Summary: Reports the index position of the last occurrence of a specified Unicode character within this instance.

C# Syntax:


            public int LastIndexOf(
   char value
);

Parameters:

value

A Unicode character to seek.

Return Value:: The index position of value if that character is found, or -1 if it is not.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

This method begins searching at the last character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive.

See also:
Char | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOf(
string value
)

Summary: Reports the index position of the last occurrence of a specified String within this instance.

C# Syntax:


            public int LastIndexOf(
   string value
);

Parameters:

value

A String to seek.

Return Value:

Value	Meaning
A positive index position.	was found.
0	is String.Empty .
-1	was not found.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

See also:
Int32 | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOf(
char value,
int startIndex
)

Summary: Reports the index position of the last occurrence of a specified Unicode character within this instance. The search starts at a specified character position.

C# Syntax:


            public int LastIndexOf(
   char value,
   int startIndex
);

Parameters:

value

A Unicode character to seek.

startIndex

The starting position of a substring within this instance.

Return Value:: The index position of value if that character is found, or -1 if it is not.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.
ArgumentOutOfRangeException	startIndex is less than zero or greater than the length of this instance.

Remarks

This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive.

See also:
Char | Int32 | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOf(
string value,
int startIndex
)

Summary: Reports the index position of the last occurrence of a specified String within this instance. The search starts at a specified character position.

C# Syntax:


            public int LastIndexOf(
   string value,
   int startIndex
);

Parameters:

value

The String to seek.

startIndex

The search starting position.

Return Value:

Value	Meaning
A positive index position.	was found.
	is String.Empty .
-1	was not found.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.
ArgumentOutOfRangeException	startIndex is less than zero or specifies a position not within this instance.

Remarks

See also:
Int32 | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOf(
   char value,
   int startIndex,
   int count
)

Summary: Reports the index position of the last occurrence of the specified Unicode character in a substring within this instance. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int LastIndexOf(
   char value,
   int startIndex,
   int count
);

Parameters:

value

A Unicode character to seek.

startIndex

The starting position of a substring within this instance.

count

The number of character positions to examine.

Return Value:: The index position of value if that character is found, or -1 if it is not.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.
ArgumentOutOfRangeException	startIndex or count is less than zero or greater than the length of this instance.

Remarks

This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or count character positions have been examined. The search is case-sensitive.

See also:
Char | Int32 | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOf(
   string value,
   int startIndex,
   int count
)

Summary: Reports the index position of the last occurrence of a specified String within this instance. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int LastIndexOf(
   string value,
   int startIndex,
   int count
);

Parameters:

value

The String to seek.

startIndex

The search starting position.

count

The number of character positions to examine.

Return Value:

Value	Meaning
A positive index position.	was found.
	is String.Empty .
-1	was not found.

Exceptions

Exception Type

Condition

value is null.

count or startIndex is negative.

-or-

count plus startIndex specify a position not within this instance.

Remarks

See also:
Int32 | String.IndexOf | String.IndexOfAny | String.LastIndexOfAny

Return to top

Overloaded Method: LastIndexOfAny(
char[] anyOf
)

Summary: Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array.

C# Syntax:


            public int LastIndexOfAny(
   char[] anyOf
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

Return Value:: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type	Condition
ArgumentNullException	anyOf is null.

Remarks

This method begins searching at the last character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or the first character position has been examined. The search is case-sensitive.

Return to top

Overloaded Method: LastIndexOfAny(
char[] anyOf,
int startIndex
)

Summary: Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array. The search starts at a specified character position.

C# Syntax:


            public int LastIndexOfAny(
   char[] anyOf,
   int startIndex
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

startIndex

The search starting position.

Return Value:: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type	Condition
ArgumentNullException	anyOf is null.
ArgumentOutOfRangeException	startIndex specifies a position not within this instance.

Remarks

This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or the first character position has been examined. The search is case-sensitive.

Return to top

Overloaded Method: LastIndexOfAny(
   char[] anyOf,
   int startIndex,
   int count
)

Summary: Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array. The search starts at a specified character position and examines a specified number of character positions.

C# Syntax:


            public int LastIndexOfAny(
   char[] anyOf,
   int startIndex,
   int count
);

Parameters:

anyOf

A Unicode character array containing one or more characters to seek.

startIndex

The search starting position.

count

The number of character positions to examine.

Return Value:: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, -1 if no character in anyOf was found.

Exceptions

Exception Type

Condition

anyOf is null.

count or startIndex is negative.

-or-

count plus startIndex specify a position not within this instance.

Remarks

This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or count character positions have been examined. The search is case-sensitive.

Return to top

Method: MemberwiseClone()

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:


            protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Method: op_Equality(
string a,
string b
)

Summary: Determines whether two specified String objects have the same value.

C# Syntax:


            public static bool operator ==(
   string a,
   string b
);

Parameters:

A String or null.

Return Value:: true if the value of a is the same as the value of b; otherwise, false.

Remarks

This operator is implemented using the String.Equals method, which means the comparands are tested for a combination of reference and value equality. The comparison is case-sensitive.

Return to top

Method: op_Inequality(
string a,
string b
)

Summary: Determines whether two specified String objects have different values.

C# Syntax:


            public static bool operator !=(
   string a,
   string b
);

Parameters:

A String or null.

Return Value:: true if the value of a is different from the value of b; otherwise, false.

Remarks

This operator is implemented using the String.Equals method, which means the comparands are tested for a combination of reference and value equality. The comparison is case-sensitive.

Return to top

Overloaded Method: PadLeft(
int totalWidth
)

Summary: Right-aligns the characters in this instance, padding with spaces on the left for a specified total length.

C# Syntax:


            public string PadLeft(
   int totalWidth
);

Parameters:

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

Return Value:: A new String that is equivalent to this instance, but right-aligned and padded on the left with as many spaces as needed to create a length of totalWidth.
-or-
If totalWidth is less than the length of this instance, a new String that is identical to this instance.

Exceptions

Exception Type	Condition
ArgumentException	totalWidth is less than zero.

Remarks

A Unicode space is defined as hexadecimal 0x20.

Example

See also:
Int32 | String.PadRight | String.Trim

Return to top

Overloaded Method: PadLeft(
int totalWidth,
char paddingChar
)

Summary: Right-aligns the characters in this instance, padding on the left with a specified Unicode character for a specified total length.

C# Syntax:


            public string PadLeft(
   int totalWidth,
   char paddingChar
);

Parameters:

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

paddingChar

A Unicode padding character.

Return Value:: A new String that is equivalent to this instance, but right-aligned and padded on the left with as many paddingChar characters as needed to create a length of totalWidth.
-or-
If totalWidth is less than the length of this instance, a new String that is identical to this instance.

Exceptions

Exception Type	Condition
ArgumentException	totalWidth is less than zero.

Example

See also:
Char | Int32 | String.PadRight | String.Trim

Return to top

Overloaded Method: PadRight(
int totalWidth
)

Summary: Left-aligns the characters in this string, padding with spaces on the right, for a specified total length.

C# Syntax:


            public string PadRight(
   int totalWidth
);

Parameters:

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

Return Value:

A new String that is equivalent to this instance, but left-aligned and padded on the right with as many spaces as needed to create a length of totalWidth.

-or-

If totalWidth is less than the length of this instance, a new String that is identical to this instance.

Exceptions

Exception Type	Condition
ArgumentException	totalWidth is less than zero.

Remarks

A Unicode space is defined as hexadecimal 0x20.

Example

See also:
Int32 | String.PadLeft | String.Trim

Return to top

Overloaded Method: PadRight(
int totalWidth,
char paddingChar
)

Summary: Left-aligns the characters in this string, padding on the right with a specified Unicode character, for a specified total length.

C# Syntax:


            public string PadRight(
   int totalWidth,
   char paddingChar
);

Parameters:

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

paddingChar

A Unicode padding character.

Return Value:

A new String that is equivalent to this instance, but left-aligned and padded on the right with as many paddingChar characters as needed to create a length of totalWidth.

-or-

If totalWidth is less than the length of this instance, a new String that is identical to this instance.

Exceptions

Exception Type	Condition
ArgumentException	totalWidth is less than zero.

Example

See also:
Char | Int32 | String.PadLeft | String.Trim

Return to top

Method: Remove(
int startIndex,
int count
)

Summary: Deletes a specified number of characters from this instance beginning at a specified position.

C# Syntax:


            public string Remove(
   int startIndex,
   int count
);

Parameters:

startIndex

The position in this instance to begin deleting characters.

count

The number of characters to delete.

Return Value:: A new String that is equivalent to this instance less count number of characters.

Exceptions

Exception Type

Condition

Either startIndex or count is less than zero.

-or-

startIndex plus count is greater than the length of this instance.

Remarks

For example, the following C# code prints "123456".

String s = "123abc456";

Console.WriteLine(s.Remove(3, 3));

Return to top

Overloaded Method: Replace(
char oldChar,
char newChar
)

Summary: Replaces all occurrences of a specified Unicode character in this instance with another specified Unicode character.

C# Syntax:


            public string Replace(
   char oldChar,
   char newChar
);

Parameters:

oldChar

A Unicode character to be replaced.

newChar

A Unicode character to replace all occurrences of oldChar.

Return Value:: A String equivalent to this instance but with all instances of oldChar replaced with newChar.

Return to top

Overloaded Method: Replace(
string oldValue,
string newValue
)

Summary: Replaces all occurrences of a specified String in this instance, with another specified String.

C# Syntax:


            public string Replace(
   string oldValue,
   string newValue
);

Parameters:

oldValue

A String to be replaced.

newValue

A String to replace all occurrences of oldValue.

Return Value:: A String equivalent to this instance but with all instances of oldValue replaced with newValue.

Remarks

If newValue is null, oldValue is removed.

Return to top

Overloaded Method: Split(
params char[] separator
)

Summary: Identifies the substrings in this instance that are delimited by one or more characters specified in an array, then places the substrings into a String array.

C# Syntax:


            public string[] Split(
   params char[] separator
);

Parameters:

separator

An array of Unicode characters that delimit the substrings in this instance, an empty array containing no delimiters, or null.

Return Value:

An array consisting of a single element containing this instance, if this instance contains none of the characters in separator.

-or-

An array of substrings if this instance is delimited by one or more of the characters in separator.

-or-

An array of the substrings in this instance delimited by white space characters if those characters occur and separator is null or contains no delimiter characters.

String.Empty is returned for any substring where two delimiters are adjacent, or a delimiter is found at the beginning or end of this instance.

Delimiter characters are not included in the substrings.

Remarks

For example:

Input	separator	Output
"42, 12, 19"	new Char[] {',', ' '}	{"42", "", "12", "", "19"}
"42..12..19"	new Char[] {'.'}	{"42", "", "12", "", "19"}
"Banana"	new Char[] {'.'}	{"Banana"}
"Darb\nSmarba"	new Char[] {}	{"Darb", "Smarba"}
"Darb\nSmarba"	null	{"Darb", "Smarba"}

Return to top

Overloaded Method: Split(
char[] separator,
int count
)

Summary: Identifies the substrings in this instance that are delimited by one or more characters specified in an array, then places the substrings into a String array. A parameter specifies the maximum number of array elements to return.

C# Syntax:


            public string[] Split(
   char[] separator,
   int count
);

Parameters:

separator

An array of Unicode characters that delimit the substrings in this instance, an empty array containing no delimiters, or null.

count

The maximum number of array elements to return.

Return Value:

An array consisting of a single element containing this instance, if this instance contains none of the characters in separator.

-or-

An array of substrings if this instance is delimited by one or more of the characters in separator.

-or-

An array of the substrings in this instance delimited by white space characters if those characters occur and separator is null or contains no delimiter characters.

String.Empty is returned for any substring where two delimiters are adjacent, or a delimiter is found at the beginning or end of this instance.

Delimiter characters are not included in the substrings.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	count is negative.

Remarks

If there are more than count substrings in this instance, the first count minus 1 substrings are returned in the first count minus 1 elements of the return value, and the remaining characters in this instance are returned in the last element of the return value.

For example:

Input	separator, count	Output
"42, 12, 19"	new Char[] {',', ' '}, 2	{"42", " 12, 19"}
"42..12..19"	new Char[] {'.'},4	{"42", "", "12", ".19"}
"Banana"	new Char[] {'.'},2	{"Banana"}
"Darb\nSmarba"	new Char[] {}, 1	{"Darb\nSmarba"}
"Darb\nSmarba"	new Char[] null,2	{"Darb", "Smarba"}
"Darb\nSmarba"	new Char[] null,100	{"Darb", "Smarba"}

Return to top

Method: StartsWith(
string value
)

Summary: Determines whether the beginning of this instance matches the specified String.

C# Syntax:


            public bool StartsWith(
   string value
);

Parameters:

value

The String to seek.

Return Value:: true if value matches the beginning of this string or is String.Empty; otherwise false.

Exceptions

Exception Type	Condition
ArgumentNullException	value is null.

Remarks

This method makes a comparison at the beginning of the string, determines whether it matches this current instance, and returns a Boolean represetation of their relationship. The specified string must match the prefix or be an empty string (that is, equals String.Empty). The comparison is case-sensitive.

See also:
String.EndsWith

Return to top

Overloaded Method: Substring(
int startIndex
)

Summary: Retrieves a substring from this instance. The substring starts at a specified character position.

C# Syntax:


            public string Substring(
   int startIndex
);

Parameters:

startIndex

The starting character position of a substring in this instance.

Return Value:

A String equivalent to the substring that begins at startIndex in this instance.

-or-

String.Empty if startIndex is equal to the length of this instance.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	startIndex is less than zero or greater than the length of this instance.

Remarks

The index is zero-based.

Return to top

Overloaded Method: Substring(
int startIndex,
int length
)

Summary: Retrieves a substring from this instance. The substring starts at a specified character position and has a specified length.

C# Syntax:


            public string Substring(
   int startIndex,
   int length
);

Parameters:

startIndex

The index of the start of the substring.

length

The number of characters in the substring.

Return Value:

A String equivalent to the substring of length length that begins at startIndex in this instance.

-or-

String.Empty if startIndex is equal to the length of this instance and length is zero.

Exceptions

Exception Type

Condition

startIndex plus length indicates a position not within this instance.

-or-

startIndex or length is less than zero.

Remarks

startIndex is zero-based.

Example

        String myString = "abc";
        bool test1 = String.Compare(myString.Substring(2, 1), "c") == 0; // This is true.
        myString.Substring(3, 1); // This throws ArgumentOutOfRangeException.
        bool test2 = String.Compare(myString.Substring(3, 0), String.Empty) == 0; // This is true.

Return to top

Overloaded Method: ToCharArray()

Summary: Copies the characters in this instance to a Unicode character array.

C# Syntax:


            public char[] ToCharArray();

Return Value:: A Unicode character array whose elements are the individual characters of this instance. If this instance is an empty string, the returned array is empty and has a zero length.

See also:
Char | Array

Return to top

Overloaded Method: ToCharArray(
int startIndex,
int length
)

Summary: Copies the characters in a specified substring in this instance to a Unicode character array.

C# Syntax:


            public char[] ToCharArray(
   int startIndex,
   int length
);

Parameters:

startIndex

The starting position of a substring in this instance.

length

The length of the substring in this instance.

Return Value:: A Unicode character array whose elements are the length number of characters in this instance starting from character position startIndex.

Exceptions

Exception Type

Condition