.NET 帮助

C# String.Format（开发人员如何使用）

发布 2024年八月11日

在 C# 编程的多样性中，有效的字符串操作是显示清晰和动态输出的基石。 String.Format方法是一个功能强大的工具，为开发人员提供了格式化字符串的多功能和表现力。要正确使用 String.Format 方法并在 C# 中创建自定义格式字符串，请参阅 Microsoft 官方 .NET 文档网站上的文档：String.Format 方法.

在本综合指南中，我们将探讨字符串格式的复杂性、语法、用法以及提升 C# 中字符串格式化的有效方法。

理解基础知识:

什么是 String.Format？

String.Format的核心是一种通过用相应的值替换占位符来格式化字符串的方法。该方法是 C# 中System.String类的一部分，在创建结构良好、可定制的字符串方面发挥着举足轻重的作用。

String.Format 的语法

String Format 方法的语法包括使用带有占位符的格式项，然后是要替换的值。这是一个基本的例子：

string formattedString = string.Format("Hello, {0}! Today is {1}.", "John", DateTime.Now.DayOfWeek);

string formattedString = string.Format("Hello, {0}! Today is {1}.", "John", DateTime.Now.DayOfWeek);

Dim formattedString As String = String.Format("Hello, {0}! Today is {1}.", "John", DateTime.Now.DayOfWeek)

VB C#

在本例中，{0}和{1} 是占位符，后续的参数(“John”和DateTime.Now.DayOfWeek)替换格式化字符串中的这些占位符。

数字和日期/时间格式化

String.Format的强大功能之一是能够根据特定模式格式化数值和日期/时间值。例如

decimal price = 19.95m; 
DateTime currentDate = DateTime.Now;

string formattedNumeric = string.Format("Price: {0:C}", price);
string formattedDate = string.Format("Today's date: {0:yyyy-MM-dd}", currentDate);

decimal price = 19.95m; 
DateTime currentDate = DateTime.Now;

string formattedNumeric = string.Format("Price: {0:C}", price);
string formattedDate = string.Format("Today's date: {0:yyyy-MM-dd}", currentDate);

Dim price As Decimal = 19.95D
Dim currentDate As DateTime = DateTime.Now

Dim formattedNumeric As String = String.Format("Price: {0:C}", price)
Dim formattedDate As String = String.Format("Today's date: {0:yyyy-MM-dd}", currentDate)

VB C#

在这个片段中，{0:C}将数值格式化为货币，并且{0:yyyy-MM-dd} 按照指定的模式格式化日期。

带数字索引的多种格式项目

在 C# 中，string.Format 方法允许开发人员在格式字符串中使用数字索引作为占位符。这有助于按照特定顺序插入相应的值。

string formattedNamed = string.Format("Hello, {0}! Your age is {1}.", "Alice", 30);

string formattedNamed = string.Format("Hello, {0}! Your age is {1}.", "Alice", 30);

Dim formattedNamed As String = String.Format("Hello, {0}! Your age is {1}.", "Alice", 30)

VB C#

这里，{0}和{1} 是数字占位符，其值按传递给 string.Format 方法的参数顺序提供。

C# 不支持字符串.Format 方法中的命名占位符，如上图所示的数字索引。如果需要命名占位符，应使用字符串插值法或外部库提供的其他方法。下面是一个字符串插值表达式的示例：

字符串插值表达式

字符串插值在 C# 6.0 中引入，允许开发人员直接在字符串字面中使用表达式，使代码更具可读性，并降低了参数重新排序时出错的风险。

var name = "Alice";
var age = 30;
string formattedNamed = $"Hello, {name}! Your age is {age}.";

var name = "Alice";
var age = 30;
string formattedNamed = $"Hello, {name}! Your age is {age}.";

Dim name = "Alice"
Dim age = 30
Dim formattedNamed As String = $"Hello, {name}! Your age is {age}."

VB C#

在本例中，{名字}和{年龄} 在字符串内直接进行评估，值由相应的变量提供。

对齐和间距

String.Format可对格式化值的对齐和间距进行精确控制。通过为格式项添加对齐方式和宽度规范，开发人员可以创建对齐整齐的输出。在 C# 中使用String.Format来控制间距，包括指定插入字符串的宽度，从而精确控制前导空格或尾部空格。例如，考虑对齐销售报告中的产品名称和价格：

string[] products = { "Laptop", "Printer", "Headphones" };
decimal[] prices = { 1200.50m, 349.99m, 99.95m };

Console.WriteLine(String.Format("{0,-15} {1,-10}\n", "Product", "Price"));

for (int index = 0; index < products.Length; index++)
{
    string formattedProduct = String.Format("{0,-15} {1,-10:C}", products[index], prices[index]);
    Console.WriteLine(formattedProduct);
}

string[] products = { "Laptop", "Printer", "Headphones" };
decimal[] prices = { 1200.50m, 349.99m, 99.95m };

Console.WriteLine(String.Format("{0,-15} {1,-10}\n", "Product", "Price"));

for (int index = 0; index < products.Length; index++)
{
    string formattedProduct = String.Format("{0,-15} {1,-10:C}", products[index], prices[index]);
    Console.WriteLine(formattedProduct);
}

Imports Microsoft.VisualBasic

Dim products() As String = { "Laptop", "Printer", "Headphones" }
Dim prices() As Decimal = { 1200.50D, 349.99D, 99.95D }

Console.WriteLine(String.Format("{0,-15} {1,-10}" & vbLf, "Product", "Price"))

For index As Integer = 0 To products.Length - 1
	Dim formattedProduct As String = String.Format("{0,-15} {1,-10:C}", products(index), prices(index))
	Console.WriteLine(formattedProduct)
Next index

VB C#

在这个例子中，{0,-15}和{1,-10} 格式控制 "产品 "和 "价格 "标签的宽度，确保左对齐，并允许前导空格或尾部空格。然后，循环将产品名称和价格填充到表格中，创建出格式整齐、间距控制精确的销售报告。调整这些宽度参数可以有效管理显示数据的对齐方式和间距。

使用三元操作符进行条件格式化

利用String.Format中的三元运算符，可以根据特定条件进行有条件格式化。例如：

int temperature = 25;
string weatherForecast = string.Format("The weather is {0}.", temperature > 20 ? "warm" : "cool");

int temperature = 25;
string weatherForecast = string.Format("The weather is {0}.", temperature > 20 ? "warm" : "cool");

Dim temperature As Integer = 25
Dim weatherForecast As String = String.Format("The weather is {0}.",If(temperature > 20, "warm", "cool"))

VB C#

在这里，天气描述会根据气温的变化而变化。

复合格式

要完善 C# 中对象的显示，可加入格式字符串（也称为 "复合格式字符串"）来控制字符串的表示。例如，使用{0:d}符号将 "d "格式规范应用于列表中的第一个对象。在格式化字符串或复合格式化功能的上下文中，这些格式指定符将指导如何显示各种类型，包括数字、小数点、日期和时间以及自定义类型。

下面是一个包含单个对象和两个格式项的示例，结合了复合格式字符串和字符串插值法：

string formattedDateTime = $"It is now {DateTime.Now:d} at {DateTime.Now:t}"; Console.WriteLine(formattedDateTime); // Output similar to: 'It is now 4/10/2015 at 10:04 AM'

string formattedDateTime = $"It is now {DateTime.Now:d} at {DateTime.Now:t}"; Console.WriteLine(formattedDateTime); // Output similar to: 'It is now 4/10/2015 at 10:04 AM'

Dim formattedDateTime As String = $"It is now {DateTime.Now:d} at {DateTime.Now:t}"
Console.WriteLine(formattedDateTime) ' Output similar to: 'It is now 4/10/2015 at 10:04 AM'

VB C#

在这种方法中，对象的字符串表示可以根据特定格式进行定制，从而使输出更加可控、更具视觉吸引力。插值字符串直接包含变量，提供了更简洁的语法。

介绍IronPDF

IronPDF 网页

IronPDF是一个C#库，可方便地使用 HTML 创建 PDF 文档, 从 PDF 文件中提取文本和在 PDF 文件中进行修订和历史管理. 它为开发人员提供了一套全面的工具，用于在其 C# 应用程序中生成、修改和渲染 PDF 文件。有了 IronPdf，开发人员就可以根据自己的具体要求创建精致且具有视觉吸引力的 PDF 文档。

安装 IronPDF：快速入门

要开始在您的 C# 项目中利用 IronPDF 库，您可以轻松安装 IronPdf NuGet 软件包。在软件包管理器控制台中使用以下命令：

Install-Package IronPdf

Install-Package IronPdf

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Install-Package IronPdf

VB C#

或者，您也可以在 NuGet 软件包管理器中搜索 "IronPDF"，然后安装。

C# String.Format 的多功能性

C# 的 String.Format方法因其在制作格式化字符串方面的多功能性而闻名。它允许开发人员在格式字符串中定义占位符，并用相应的值进行替换，从而提供对字符串输出的精确控制。 String.Format能够格式化数值、日期/时间信息并对齐文本，是创建清晰、结构化文本内容不可或缺的工具。

String.Format 与 IronPDF 的集成

说到将String.Format与 IronPdf 集成，答案是肯定的。可以利用String.Format提供的格式化功能动态生成内容，然后使用 IronPDF 的功能将这些内容合并到 PDF 文档中。

让我们举一个简单的例子：

using IronPdf;

class PdfGenerator
{
    public static void GeneratePdf(string customerName, decimal totalAmount)
    {
        // Format the content dynamically using String.Format
        string formattedContent = string.Format("Thank you, {0}, for your purchase! Your total amount is: {1:C}.", customerName, totalAmount);

        // Create a new PDF document using IronPDF
        var pdfDocument = new ChromePdfRenderer();

        // Add the dynamically formatted content to the PDF
        pdfDocument.RenderHtmlAsPdf(formattedContent).SaveAs("Invoice.pdf");
    }
}

public class Program{
    public static void main(string[] args)
    {
        PdfGenerator obj = new PdfGenerator();
    obj.GeneratePdf("John Doe", "1204.23");
    }
}

using IronPdf;

class PdfGenerator
{
    public static void GeneratePdf(string customerName, decimal totalAmount)
    {
        // Format the content dynamically using String.Format
        string formattedContent = string.Format("Thank you, {0}, for your purchase! Your total amount is: {1:C}.", customerName, totalAmount);

        // Create a new PDF document using IronPDF
        var pdfDocument = new ChromePdfRenderer();

        // Add the dynamically formatted content to the PDF
        pdfDocument.RenderHtmlAsPdf(formattedContent).SaveAs("Invoice.pdf");
    }
}

public class Program{
    public static void main(string[] args)
    {
        PdfGenerator obj = new PdfGenerator();
    obj.GeneratePdf("John Doe", "1204.23");
    }
}

Imports IronPdf

Friend Class PdfGenerator
	Public Shared Sub GeneratePdf(ByVal customerName As String, ByVal totalAmount As Decimal)
		' Format the content dynamically using String.Format
		Dim formattedContent As String = String.Format("Thank you, {0}, for your purchase! Your total amount is: {1:C}.", customerName, totalAmount)

		' Create a new PDF document using IronPDF
		Dim pdfDocument = New ChromePdfRenderer()

		' Add the dynamically formatted content to the PDF
		pdfDocument.RenderHtmlAsPdf(formattedContent).SaveAs("Invoice.pdf")
	End Sub
End Class

Public Class Program
	Public Shared Sub main(ByVal args() As String)
		Dim obj As New PdfGenerator()
	obj.GeneratePdf("John Doe", "1204.23")
	End Sub
End Class

VB C#

在本例中，String.Format 方法用于动态生成客户发票的个性化信息。然后使用 IronPDF 的ChromePdfRenderer功能将格式化后的内容合并到 PDF 文档中。

上一个代码示例输出的 PDF

有关使用 HTML 字符串表示法创建 PDF 的更多详细信息，请参阅IronPDF 文档page.

结论

总之，String.Format 是 C# 编程中的中坚力量，为开发人员提供了一个强大的机制来制作格式化字符串。无论是处理数值、日期/时间信息，还是处理自定义模式，String.Format 都能提供多功能、高效的解决方案。当您在 C# 开发的广阔天地中遨游时，掌握使用String.Format进行字符串格式化的艺术无疑将提高您在应用程序中创建清晰、动态和具有视觉吸引力的输出的能力。

开发人员可以利用String.Format强大的格式化功能动态制作内容，然后使用 IronPDF 将其无缝集成到 PDF 文档中。这种合作方式使开发人员能够制作高度定制且具有视觉吸引力的 PDF，为他们的文档生成能力增添了一层复杂性。

IronPDF 提供一个免费试用 IronPDF 的全部功能您可以像在商业模式下一样测试其完整功能。但是，您需要IronPDF使用许可一旦超过试用期。

< 前一页
C# LINQ 连接查询语法（开发人员如何使用）

下一步 >
C# 特性（开发人员如何使用）