StringBuilder.Append Method (Int16) (System.Text)

Switch View :
ScriptFree
.NET Framework Class Library
StringBuilder.Append Method (Int16)

Updated: January 2012

Appends the string representation of a specified 16-bit signed integer to this instance.

Namespace:  System.Text
Assembly:  mscorlib (in mscorlib.dll)
Syntax

Visual Basic
Public Function Append ( _
	value As Short _
) As StringBuilder
C#
public StringBuilder Append(
	short value
)
Visual C++
public:
StringBuilder^ Append(
	short value
)
F#
member Append : 
        value:int16 -> StringBuilder 

Parameters

value
Type: System.Int16
The value to append.

Return Value

Type: System.Text.StringBuilder
A reference to this instance after the append operation has completed.
Exceptions

Exception Condition
ArgumentOutOfRangeException

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append method modifies the existing instance of this class; it does not return a new class instance. Because of this, you can call a method or property on the existing reference and you do not have to assign the return value to a StringBuilder object, as the following example illustrates.

Visual Basic

Dim sb As New System.Text.StringBuilder("The range of a 16-bit integer: ")
sb.Append(Int16.MinValue).Append(" to ").Append(Int16.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 16-bit integer: -32768 to 32767


C#

System.Text.StringBuilder sb = new 
       System.Text.StringBuilder("The range of a 16-bit integer: ");
sb.Append(Int16.MinValue).Append(" to ").Append(Int16.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 16-bit integer: -32768 to 32767


The Append method calls the Int16.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

The capacity of this instance is adjusted as needed.

Notes to Callers

In the .NET Framework 4, when you instantiate the StringBuilder object by calling the StringBuilder constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. This can occur particularly when you call the Append and AppendFormat methods to append small strings.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

Change History

Date

History

Reason

January 2012

Added the Notes to Callers section.

Content bug fix.

December 2010

Expanded the Remarks section and removed the example.

Customer feedback.