StringBuilder.Chars Property
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Gets or sets the character at the specified character position in this instance.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- index
- Type: System.Int32
The position of the character.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | index is outside the bounds of this instance while setting a character. |
| IndexOutOfRangeException | index is outside the bounds of this instance while getting a character. |
The index parameter is the position of a character within the StringBuilder. The first character in the string is at index 0. The length of a string is the number of characters it contains. The last accessible character of a StringBuilder instance is at index Length - 1.
Chars is the default property of the StringBuilder class. In C#, it is an indexer. This means that individual characters can be retrieved from the Chars property as shown in the following example, which counts the number of alphabetic, white-space, and punctuation characters in a string.
Imports System.Text Module Example Public Sub Demo(outputBlock As System.Windows.Controls.TextBlock) Dim nAlphabeticChars As Integer = 0 Dim nWhitespace As Integer = 0 Dim nPunctuation As Integer = 0 Dim sb As New StringBuilder("This is a simple sentence.") For ctr As Integer = 0 To sb.Length - 1 Dim ch As Char = sb(ctr) If Char.IsLetter(ch) Then nAlphabeticChars += 1 : Continue For If Char.IsWhiteSpace(ch) Then nWhitespace += 1 : Continue For If Char.IsPunctuation(ch) Then nPunctuation += 1 Next outputBlock.Text += String.Format("The sentence '{0}' has:", sb) + vbCrLf outputBlock.Text += String.Format(" Alphabetic characters: {0}", nAlphabeticChars) + vbCrLf outputBlock.Text += String.Format(" Whitespace characters: {0}", nWhitespace) + vbCrLf outputBlock.Text += String.Format(" Punctuation characters: {0}", nPunctuation) + vbCrLf End Sub End Module ' The example displays the following output: ' The sentence 'This is a simple sentence.' has: ' Alphabetic characters: 21 ' Whitespace characters: 4 ' Punctuation characters: 1