Multiline String Literal in C#

Handling multiline strings in C# can simplify the way developers manage lengthy or formatted text in their applications. This guide explores various methods for creating and working with multiline strings in C#, including the use of verbatim strings, string interpolation, and practical examples.

What is a Multiline String in C#?

A multiline string in C# refers to a string that spans multiple lines. It is commonly used for scenarios like defining SQL queries, storing JSON data, or handling formatted content like HTML or XML.

Using Verbatim Strings to Create Multiline Strings

The most straightforward way to create multiline strings in C# is by using a verbatim string, denoted by the @ symbol before the string.

Example of Verbatim String

string multiline = @"
This is a multiline string in C#.
It spans multiple lines
without requiring escape characters.";

Key Features of Verbatim Strings

• Preserve line breaks and white spaces.
• Avoid the need for escape characters like
  📄
  \n or
  📄
  \\.
• Useful for defining large blocks of text like SQL queries or XML data.

Multiline String with String Interpolation

C# supports string interpolation, which allows embedding variables or expressions directly into a string. You can combine this with verbatim strings to handle multiline strings dynamically.

Example of Multiline String with String Interpolation

string name = "John";
string message = $@"
Hello {name},
Welcome to our platform.
We hope you have a great experience!";

Here, the variable {name} is seamlessly integrated into the multiline string.

Creating Multiline Strings with StringBuilder

For scenarios where performance is critical or strings are constructed dynamically, using StringBuilder can be a more efficient option.

Example Using StringBuilder

using System.Text;

StringBuilder sb = new StringBuilder();
sb.AppendLine("This is the first line.");
sb.AppendLine("This is the second line.");
sb.AppendLine("This is the third line.");

string multiline = sb.ToString();

This approach avoids creating multiple string instances and is ideal for handling large or complex strings.

Practical Examples of Multiline Text in C#

Example 1: Defining a Multiline SQL Query

string sqlQuery = @"
SELECT Name, Age
FROM Users
WHERE IsActive = 1
ORDER BY Name;";

Example 2: Creating Multiline JSON Data

string jsonData = @"
{
    ""Name"": ""John"",
    ""Age"": 30,
    ""IsActive"": true
}";

Example 3: Handling Multiline Error Messages

string errorMessage = @"
An error occurred while processing your request.
Please try again later or contact support.";

Multiline String in C# FAQs

What is a verbatim string in C#?

A verbatim string is a string literal prefixed with @. It allows the string to span multiple lines and includes white spaces and escape sequences as-is.

Can I use string interpolation with multiline strings?

Yes, you can use string interpolation with multiline strings by combining the $ symbol with the @ symbol, like $@"your string".

What are the advantages of using StringBuilder for multiline strings?

StringBuilder is efficient for dynamically constructing large strings because it reduces memory overhead by avoiding the creation of multiple string instances.

How do I format multiline text in C#?

Use verbatim strings to preserve formatting or StringBuilder.AppendLine for dynamically building and formatting multiline text.

Conclusion

Understanding how to create and manage multiline strings in C# is essential for writing clear and efficient code. Whether you use verbatim strings, string interpolation, or StringBuilder, these techniques provide the flexibility to handle various scenarios with ease. Experiment with these methods to find the best approach for your specific needs.