.NET 幫助

C# 列舉 (開發人員如何使用)

發佈 2024年3月26日

枚舉（Enums），是列舉的縮寫，是一種強大的功能，使開發人員能夠建立一組具名常數。這些常數透過為值提供有意義的名稱，使程式碼更具可讀性和可維護性。在本文中，我們將通過各種示例和解釋來探討 C# 中枚舉的基礎和高級概念。我們的目標是提供對枚舉的全面理解，以及如何在 C# 應用程式中有效使用它們。IronPDF 程式庫用於在 .NET 中生成 PDF.

在C#中引入Enum

枚舉是 C# 中的一種值類型，它允許變量成為一組預定義常數的集合，每個常數稱為枚舉成員。 enum 關鍵字用於聲明列舉類型，提供了一種將常量值集中在一個名稱下的方法。枚舉可以提高代碼的可讀性，並減少由於傳遞錯誤值而導致的錯誤。

enum Season { Spring, Summer, Autumn, Winter }

enum Season { Spring, Summer, Autumn, Winter }

Friend Enum Season
	Spring
	Summer
	Autumn
	Winter
End Enum

VB C#

在上述程式碼中，Season 是一個列舉型別，具有四個成員：Spring、Summer、Autumn 和 Winter。透過定義此枚舉，我們現在可以創建類型為 Season 的變數，這些變數只能持有這四個值之一。

枚舉的底層類型

瞭解列舉成員的整數值

在預設情況下，C# 中枚舉的底層類型是 int，即稱為底層整數類型，枚舉成員的整數值從 0 開始。除非明確指定，否則每個成員的整數值會從前一成員增加 1。您也可以將列舉的基礎類型定義為其他整數類型。

enum Season : byte { Spring = 1, Summer, Autumn = 4, Winter }

enum Season : byte { Spring = 1, Summer, Autumn = 4, Winter }

Friend Enum Season As Byte
	Spring = 1
	Summer
	Autumn = 4
	Winter
End Enum

VB C#

在此範例中，Season 是枚舉，在這裡被稱為枚舉名稱，其底層類型為 byte。 Spring 被明確指定為值 1，作為預設值，而 Summer、Autumn 和 Winter 根據它們的順序被指定相應的值。

在程式碼中使用列舉型別

要使用枚舉，只需宣告指定枚舉類型的變數，並使用點語法將其賦值為枚舉中的一個值，如在枚舉宣告中定義的不同值之一。

Season currentSeason = Season.Autumn;

Season currentSeason = Season.Autumn;

Dim currentSeason As Season = Season.Autumn

VB C#

此行建立一個類型為 Season 的變數 currentSeason，並將其賦值為 Autumn。這清楚地表明，currentSeason 只能持有有效的 Season 值。

在 Enum 值和整數之間轉換

您可以使用給定的整數值將枚舉值轉換為其對應的整數值，反之亦然。當您需要以數字形式儲存或傳輸資料時，這非常有用。

int autumnInt = (int)Season.Autumn;
Season season = (Season)4;

int autumnInt = (int)Season.Autumn;
Season season = (Season)4;

Imports System

Dim autumnInt As Integer = CInt(Math.Truncate(Season.Autumn))
Dim season As Season = CType(4, Season)

VB C#

在這裡，autumnInt 會有值 4，這與 Season 列舉中的 Autumn 相對應。相反地，當整數 4 被轉換回 Season 時，season 將被設置為秋季。

使用列舉方法

C# 提供了幾種用於處理枚舉的方法，例如 Enum.GetName(), Enum.GetNames(), Enum.GetValue()，和 Enum.GetValues()**，這些對於存取與每個枚舉成員相關的整數常數非常有用。

string[] names = Enum.GetNames(typeof(Season));
foreach (string name in names)
{
    Console.WriteLine(name);
}

string[] names = Enum.GetNames(typeof(Season));
foreach (string name in names)
{
    Console.WriteLine(name);
}

Dim names() As String = System.Enum.GetNames(GetType(Season))
For Each name As String In names
	Console.WriteLine(name)
Next name

VB C#

C# 列舉 (開發者如何使用)：圖 1 - 每個與 Season 列舉關聯的值的控制台輸出

這段程式碼片段列印出 Season 列舉所有成員的名稱。這些方法對於遍歷枚舉的所有可能值或在字串表示和枚舉值之間進行轉換非常有用。

將特定值賦予枚舉成員

您可以為枚舉成員分配特定的整數值，以明確控制其數值。

enum ErrorCode : int { None = 0, NotFound = 404, Unauthorized = 401 }

enum ErrorCode : int { None = 0, NotFound = 404, Unauthorized = 401 }

Friend Enum ErrorCode As Integer
	None = 0
	NotFound = 404
	Unauthorized = 401
End Enum

VB C#

在此範例中，ErrorCode 是一個列舉，為每個成員分配了自訂的整數值。這對於預定義的數字代碼很有用，例如 HTTP 狀態代碼。

使用列舉作為位元標誌

藉由使用[標誌] 屬性，您可以將列舉定義為一組位旗幟。這允許您在單個枚舉變量中存儲值的組合。

[Flags]
enum Permissions { None = 0, Read = 1, Write = 2, Execute = 4 }

[Flags]
enum Permissions { None = 0, Read = 1, Write = 2, Execute = 4 }

<Flags>
Friend Enum Permissions
	None = 0
	Read = 1
	Write = 2
	Execute = 4
End Enum

VB C#

使用上面定義的 Permissions 列舉，可以使用位元或運算符號結合不同的權限。

Permissions myPermissions = Permissions.Read 
 Permissions.Write;

Permissions myPermissions = Permissions.Read 
 Permissions.Write;

Dim myPermissions As Permissions = Permissions.Read Permissions.Write

VB C#

這將 myPermissions 設置為讀取和寫入權限的組合。

枚舉和切換語句

枚舉與switch語句結合使用效果極佳，允許您根據枚舉的值執行不同的代碼塊。

Season season = Season.Summer;
switch (season)
{
    case Season.Spring:
        Console.WriteLine("It's spring.");
        break;
    case Season.Summer:
        Console.WriteLine("It's summer.");
        break;
    case Season.Autumn:
        Console.WriteLine("It's autumn.");
        break;
    case Season.Winter:
        Console.WriteLine("It's winter.");
        break;
}

Season season = Season.Summer;
switch (season)
{
    case Season.Spring:
        Console.WriteLine("It's spring.");
        break;
    case Season.Summer:
        Console.WriteLine("It's summer.");
        break;
    case Season.Autumn:
        Console.WriteLine("It's autumn.");
        break;
    case Season.Winter:
        Console.WriteLine("It's winter.");
        break;
}

Dim season As Season = Season.Summer
Select Case season
	Case Season.Spring
		Console.WriteLine("It's spring.")
	Case Season.Summer
		Console.WriteLine("It's summer.")
	Case Season.Autumn
		Console.WriteLine("It's autumn.")
	Case Season.Winter
		Console.WriteLine("It's winter.")
End Select

VB C#

這段程式碼將會印出「It's summer.」，因為 season 變數被設定為 Season.Summer。

解析字串為列舉型別

C# 允許您使用 Enum.Parse 方法解析字串以獲取對應的枚舉值。()** 方法。

string input = "Winter";
Season season = (Season)Enum.Parse(typeof(Season), input);

string input = "Winter";
Season season = (Season)Enum.Parse(typeof(Season), input);

Dim input As String = "Winter"
Dim season As Season = DirectCast(System.Enum.Parse(GetType(Season), input), Season)

VB C#

這段代碼將字串 "Winter" 轉換為其對應的枚舉值 Season.Winter。

將 IronPDF 與 C# 中的枚舉整合

IronPDF PDF 庫用於動態文件生成是一個適用於 .NET 應用程式的 PDF 庫，幫助開發人員輕鬆創建、編輯和操作 PDF 文檔。這個強大的庫在需要動態 PDF 生成的情況中特別有用，例如生成報告或發票。在本節中，我們將探討如何將IronPDF與C#列舉結合使用，以便在 .NET 中從 HTML 建立 PDF 報告, 我們還會介紹在您的專案中安裝 IronPDF 的過程。

安裝 IronPDF

使用 NuGet 套件管理器控制台安裝 IronPDF 非常容易。在 Visual Studio 中打開套件管理員主控台並輸入以下命令：

Install-Package IronPdf

此命令將在我們的項目中安裝IronPDF。

另一種方法是使用 Visual Studio 在您的專案中安裝 IronPDF。在 Visual Studio 中，右鍵單擊方案總管，然後點擊「NuGet 套件管理員」以管理方案。然後，點擊左側的瀏覽標籤。接著，搜尋IronPDF，點擊安裝，並將其添加到您的專案中。

C# 列舉(開發人員如何使用): 圖 2 - 使用 NuGet 套件管理器搜尋 IronPDF 來安裝 IronPDF

使用 IronPDF 與枚舉型別

我們來考慮一個情境，您想生成一個包含季節性銷售數據報告的 PDF 文件。您可以使用枚舉來表示不同的季節，並使用IronPDF生成PDF報告。首先，定義一個枚舉用於季節：

public enum Season
{
    Spring,
    Summer,
    Autumn,
    Winter
}

public enum Season
{
    Spring,
    Summer,
    Autumn,
    Winter
}

Public Enum Season
	Spring
	Summer
	Autumn
	Winter
End Enum

VB C#

接下來，我們將撰寫一個方法，以選定的季節為基礎生成 PDF 報告。此方法將使用 IronPDF 創建一個簡單的 PDF 文檔，概述給定季節的銷售數據。

using IronPdf;
public class SalesReportGenerator
{
    public static void GenerateSeasonalSalesReport(Season season)
    {
        IronPdf.License.LicenseKey = "License-Key";
        var Renderer = new IronPdf.ChromePdfRenderer();
        var htmlTemplate = $"<h1>Sales Report for {season}</h1><p>This section contains sales data for the {season} season.</p>";
        var pdf = Renderer.RenderHtmlAsPdf(htmlTemplate);
        var outputPath = $@"{season}SalesReport.pdf";
        pdf.SaveAs(outputPath);
        Console.WriteLine($"PDF report generated: {outputPath}");
    }
}

using IronPdf;
public class SalesReportGenerator
{
    public static void GenerateSeasonalSalesReport(Season season)
    {
        IronPdf.License.LicenseKey = "License-Key";
        var Renderer = new IronPdf.ChromePdfRenderer();
        var htmlTemplate = $"<h1>Sales Report for {season}</h1><p>This section contains sales data for the {season} season.</p>";
        var pdf = Renderer.RenderHtmlAsPdf(htmlTemplate);
        var outputPath = $@"{season}SalesReport.pdf";
        pdf.SaveAs(outputPath);
        Console.WriteLine($"PDF report generated: {outputPath}");
    }
}

Imports IronPdf
Public Class SalesReportGenerator
	Public Shared Sub GenerateSeasonalSalesReport(ByVal season As Season)
		IronPdf.License.LicenseKey = "License-Key"
		Dim Renderer = New IronPdf.ChromePdfRenderer()
		Dim htmlTemplate = $"<h1>Sales Report for {season}</h1><p>This section contains sales data for the {season} season.</p>"
		Dim pdf = Renderer.RenderHtmlAsPdf(htmlTemplate)
		Dim outputPath = $"{season}SalesReport.pdf"
		pdf.SaveAs(outputPath)
		Console.WriteLine($"PDF report generated: {outputPath}")
	End Sub
End Class

VB C#

在此範例中，我們定義了一個名為 GenerateSeasonalSalesReport 的方法，該方法使用 Season 枚舉作為參數。它使用IronPDF的ChromePdfRenderer類別從包含季節名稱和銷售數據佔位符文本的HTML字符串生成PDF。然後將 PDF 保存為包含季節名稱的文件名。

執行

要生成季節性銷售報告，請使用特定季節調用 GenerateSeasonalSalesReport 方法：

static void Main(string [] args)
{
    SalesReportGenerator.GenerateSeasonalSalesReport(Season.Winter);
}

static void Main(string [] args)
{
    SalesReportGenerator.GenerateSeasonalSalesReport(Season.Winter);
}

Shared Sub Main(ByVal args() As String)
	SalesReportGenerator.GenerateSeasonalSalesReport(Season.Winter)
End Sub

VB C#

此呼叫生成了一個名為 WinterSalesReport.pdf 的 PDF 文件，其中包含冬季銷售報告。

C# Enums（開發者如何使用）：圖3 - 使用 IronPDF 從代碼範例生成的 PDF 輸出示例

結論

C# 中的枚舉提供了一種類型安全的方法來處理一組相關的命名常數。它們增強了程式碼的可讀性，減少錯誤，並促進更清晰的程式碼組織。通過將相關的常數值歸類在一個有意義的名稱下，枚舉使您的代碼更易於理解和維護。

將IronPDF與C#中的列舉類型整合，可以基於列舉類型動態生成PDF文件。IronPDF提供一個其全面 PDF 工具的免費試用，提供多種選項以滿足不同專案需求和規模。

< 上一頁
C# 參數（它是如何為開發人員工作的）

下一個 >
Dotnet NuGet（開發人員如何使用）

報告問題

加入我們的漏洞獎勵計劃以獲得 Iron Swag

準備開始了嗎？版本: 2024.12 剛剛發布

查看許可證 >

C# 列舉 (開發人員如何使用)

在C#中引入Enum

枚舉的底層類型

瞭解列舉成員的整數值

在程式碼中使用列舉型別

在 Enum 值和整數之間轉換

使用列舉方法

將特定值賦予枚舉成員

使用列舉作為位元標誌

枚舉和切換語句

解析字串為列舉型別

將 IronPDF 與 C# 中的枚舉整合

安裝 IronPDF

使用 IronPDF 與枚舉型別

執行

結論

本頁內容

報告問題

準備開始了嗎？版本: 2024.12 剛剛發布

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號立即。

試用表格已提交
成功地.

受到全球數百萬工程師的信任

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號立即。

受到全球數百萬工程師的信任

IronPDF 是 IRON 的一部分套件

C# 列舉 (開發人員如何使用)

在C#中引入Enum

枚舉的底層類型

瞭解列舉成員的整數值

在程式碼中使用列舉型別

在 Enum 值和整數之間轉換

使用列舉方法

將特定值賦予枚舉成員

使用列舉作為位元標誌

枚舉和切換語句

解析字串為列舉型別

將 IronPDF 與 C# 中的枚舉整合

安裝 IronPDF

使用 IronPDF 與枚舉型別

執行

結論

本頁內容

報告問題

準備開始了嗎？ 版本: 2024.12 剛剛發布

試用表格已提交成功地.

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號 立即。

試用表格已提交成功地.

受到全球數百萬工程師的信任

在實際環境中測試

全功能產品

24/5技術支援

獲取你的免費 0天試用序號 立即。

受到全球數百萬工程師的信任

IronPDF 是 IRON 的一部分套件

準備開始了嗎？版本: 2024.12 剛剛發布

試用表格已提交
成功地.

獲取你的免費 0天試用序號立即。

試用表格已提交
成功地.

獲取你的免費 0天試用序號立即。