C# Default Parameters (開発者向けの仕組み)

デフォルトパラメータとは？

C#では、デフォルトパラメータ、別名オプション引数パラメータによって、メソッド定義において固定された引数に値を割り当てることができます。 関数が呼び出されたときにそのパラメータの引数が提供されない場合、デフォルトが使用されます。

デフォルトパラメータ値は以下のコードスニペットのようにメソッド定義で設定されます：

public void Greet(string name = "Friend")
{
    Console.WriteLine("Hello, " + name);
}

public void Greet(string name = "Friend")
{
    Console.WriteLine("Hello, " + name);
}

Public Sub Greet(Optional ByVal name As String = "Friend")
	Console.WriteLine("Hello, " & name)
End Sub

ここで、パラメータnameはオプションの属性です。 文字列 "Friend" はデフォルト値です。 Greet() を引数を渡さずに呼び出すと、name の値として "Friend" が使用されます。

必須パラメータとオプションパラメータ

// Method with required parameters
public void IntroduceYourself(string firstName, string lastName)
{
    Console.WriteLine("Hello, my name is " + firstName + " " + lastName);
}

// Method with required parameters
public void IntroduceYourself(string firstName, string lastName)
{
    Console.WriteLine("Hello, my name is " + firstName + " " + lastName);
}

' Method with required parameters
Public Sub IntroduceYourself(ByVal firstName As String, ByVal lastName As String)
	Console.WriteLine("Hello, my name is " & firstName & " " & lastName)
End Sub

IntroduceYourself("John", "Doe"); // Following call is correct
// IntroduceYourself("John"); // Error: lastName is missing

IntroduceYourself("John", "Doe"); // Following call is correct
// IntroduceYourself("John"); // Error: lastName is missing

IntroduceYourself("John", "Doe") ' Following call is correct
' IntroduceYourself("John"); // Error: lastName is missing

// Method with an optional parameter
public void IntroduceYourself(string firstName, string lastName = "Doe")
{
    Console.WriteLine("Hello, my name is " + firstName + " " + lastName);
}

// Method with an optional parameter
public void IntroduceYourself(string firstName, string lastName = "Doe")
{
    Console.WriteLine("Hello, my name is " + firstName + " " + lastName);
}

' Method with an optional parameter
Public Sub IntroduceYourself(ByVal firstName As String, Optional ByVal lastName As String = "Doe")
	Console.WriteLine("Hello, my name is " & firstName & " " & lastName)
End Sub

IntroduceYourself("John", "Smith"); // Outputs: Hello, my name is John Smith
IntroduceYourself("John");          // Outputs: Hello, my name is John Doe

IntroduceYourself("John", "Smith"); // Outputs: Hello, my name is John Smith
IntroduceYourself("John");          // Outputs: Hello, my name is John Doe

IntroduceYourself("John", "Smith") ' Outputs: Hello, my name is John Smith
IntroduceYourself("John") ' Outputs: Hello, my name is John Doe

デフォルトパラメータの使用規則

デフォルトパラメータを使用してメソッドを定義する際には、覚えておくべきいくつかの重要な規則があります：

1. デフォルト値は定数式でなければなりません。 変数やメソッド呼び出しを使えません。
2. すべてのオプションパラメータは、必須パラメータの後のパラメータリストの最後に定義されなければなりません。
3. オプションパラメータを持つメソッドを呼び出す際、オプションパラメータが定義された順番で省略された引数を提供することもできるし、名前付き引数を使用することもできます。
4. オプションの引数値が提供されていない場合、デフォルト値が使用されます。

オプション引数のコードスニペットを考えてみましょう：

static void Main(string[] args)
{
    ShowMessage("Hello");
    ShowMessage("Hello", "John");
}

public static void ShowMessage(string msg, string name = "Friend")
{
    Console.WriteLine(msg + ", " + name);
}

static void Main(string[] args)
{
    ShowMessage("Hello");
    ShowMessage("Hello", "John");
}

public static void ShowMessage(string msg, string name = "Friend")
{
    Console.WriteLine(msg + ", " + name);
}

Shared Sub Main(ByVal args() As String)
	ShowMessage("Hello")
	ShowMessage("Hello", "John")
End Sub

Public Shared Sub ShowMessage(ByVal msg As String, Optional ByVal name As String = "Friend")
	Console.WriteLine(msg & ", " & name)
End Sub

MainメソッドでShowMessageを二度呼び出します。最初は引数を一つだけ渡すので、nameパラメータはデフォルト値の"Friend"を使用します。 二度目は二つの引数を渡すので、デフォルト値の代わりに"John"が使用されます。

名前付き引数とオプション引数

C#は名前付き引数とオプション引数もサポートしています。 名前付き引数を使用すると、ポジションではなく引数の名前で値を指定することができます。 これは、方法にいくつかのオプション引数があり、一つのために値を提供したいが他のものには提供しない場合に便利です。

以下の例では、ShowGreetingsは二つのオプションパラメータを持っています：

public static void ShowGreetings(string greeting = "Hello", string name = "Friend")
{
    Console.WriteLine(greeting + ", " + name);
}

public static void ShowGreetings(string greeting = "Hello", string name = "Friend")
{
    Console.WriteLine(greeting + ", " + name);
}

Public Shared Sub ShowGreetings(Optional ByVal greeting As String = "Hello", Optional ByVal name As String = "Friend")
	Console.WriteLine(greeting & ", " & name)
End Sub

この方法を最初の引数だけで呼び出すことができます：

ShowGreetings("Hi");

ShowGreetings("Hi");

ShowGreetings("Hi")

または名前付き引数を使ってnameの値を提供しながらgreeting引数を省略することもできます：

ShowGreetings(name: "John");

ShowGreetings(name: "John");

ShowGreetings(name:= "John")

// Method Declaration
public void RegisterUser(string username, string password, string email = "", bool subscribeToNewsletter = false)
{
    // Method body
}

// Method Call
RegisterUser(username: "JohnDoe", password: "password123", subscribeToNewsletter: true);

// Method Declaration
public void RegisterUser(string username, string password, string email = "", bool subscribeToNewsletter = false)
{
    // Method body
}

// Method Call
RegisterUser(username: "JohnDoe", password: "password123", subscribeToNewsletter: true);

' Method Declaration
Public Sub RegisterUser(ByVal username As String, ByVal password As String, Optional ByVal email As String = "", Optional ByVal subscribeToNewsletter As Boolean = False)
	' Method body
End Sub

' Method Call
RegisterUser(username:= "JohnDoe", password:= "password123", subscribeToNewsletter:= True)

デフォルトパラメータとメソッドオーバーロード

public void DisplayMessage(string message)
{
    Console.WriteLine(message);
}

public void DisplayMessage(string message, string name)
{
    Console.WriteLine(message + ", " + name);
}

public void DisplayMessage(string message)
{
    Console.WriteLine(message);
}

public void DisplayMessage(string message, string name)
{
    Console.WriteLine(message + ", " + name);
}

Public Sub DisplayMessage(ByVal message As String)
	Console.WriteLine(message)
End Sub

Public Sub DisplayMessage(ByVal message As String, ByVal name As String)
	Console.WriteLine(message & ", " & name)
End Sub

public void DisplayMessage(string message, string name = "Friend")
{
    Console.WriteLine(message + ", " + name);
}

public void DisplayMessage(string message, string name = "Friend")
{
    Console.WriteLine(message + ", " + name);
}

Public Sub DisplayMessage(ByVal message As String, Optional ByVal name As String = "Friend")
	Console.WriteLine(message & ", " & name)
End Sub

DisplayMessage("Hello");
DisplayMessage("Hello", "John");

DisplayMessage("Hello");
DisplayMessage("Hello", "John");

DisplayMessage("Hello")
DisplayMessage("Hello", "John")

Iron Software Suite

PDFソリューションのためのIronPDFライブラリ、C# Excel操作のためのIronXL、高度なテキスト認識のためのIronOCR、およびバーコード生成のためのIronBarcodeを含むIron Softwareスイートに入りましょう。 これらの強力なライブラリは、C#アプリケーションの機能を拡張するために特別に設計されています。 これらは、デフォルトパラメータ、名前付き引数指定、およびメソッドオーバーロードを含む、記事で説明した概念に簡単に関連付けることができます。

IronPDF：これは、IronPDFによるHTMLからPDFへの変換のためのC#ライブラリです。 IronPDFを使用する場合、デフォルトとオプションのパラメータを理解することが重要です。 IronPDFの多くのメソッドにはオプションのパラメータがあります。これにより、メソッドシグネチャを過度に複雑にすることなく広範なカスタマイズが可能です。 これに関する詳細はIronPDFのHTMLからPDFへのチュートリアルで見つけることができます。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class

IronXL：このライブラリは、C#アプリケーションでExcelファイルを様々な形式で読み書きし、操作することを可能にします。 IronXL内のメソッドは、ファイルを保存する形式やデータをインポートする際にヘッダーを含めるかどうかなど、さまざまなパラメータを持つ場合があります。 名前付きおよびオプションのパラメータが、セル範囲の指定やフォーマットオプションなどを指定するために広範に使用されていることもあるかもしれません。
IronOCR：高度な光学式文字認識 (OCR) ライブラリで、C#アプリケーション内の画像およびPDFからテキストとバーコードを読み取ることができます。 IronOCRのメソッドには、OCRプロセスの側面、例えばテキストの言語、適用するエラー訂正レベルなどを制御するためのオプションパラメータがあるかもしれません。 これらのパラメータを理解することでOCRプロセスをより良くコントロールすることができます。
IronBarcode：このライブラリは、.NETアプリケーションでのバーコードの読み取りと生成のための多用途なツールです。 ここでもデフォルトパラメータの理解が重要です。 たとえば、バーコードの生成時には、サイズ、フォーマット、値を指定するオプションパラメータがあるかもしれません。

結論

結論として、C#におけるデフォルトとオプションパラメータの使用を習得することは、プログラミングの効率とコードの汎用性を大幅に向上させることができます。 これらの概念は、C#の基本です。

これらのライブラリについて言えば、それぞれの個別ライセンスは$799から始まり、これらのライブラリはIron Software製品の無料試用版も提供しています。 しかし、Iron Softwareはパッケージ取引を提供しています：個別ライセンス2つの価格でスイート全体を取得することができます。