Avalonia UI - ダイアログのソースを表示

== 概要 ==
Avalonia UIは、クロスプラットフォームのUI開発フレームワークであり、C#を使用してデスクトップアプリケーションを構築できる。<br>
このフレームワークでは、ダイアログは重要なUIコンポーネントの一つとして位置付けられている。<br>
<br>
ダイアログは、ユーザに情報を表示する、または、入力を求めるための一時的なウインドウである。<br>
主に、警告メッセージの表示、確認の要求、データ入力の促進等に使用される。<br>
<br>
Avalonia UIでは、標準的なダイアログとカスタムダイアログの両方を実装することができる。<br>
標準的なダイアログには、メッセージボックス、ファイル選択ダイアログ、ディレクトリ選択ダイアログ等が含まれる。<br>
これらは、Avalonia.Dialogsネームスペースに含まれるクラスを使用して簡単に実装することができる。<br>
<br>
カスタムダイアログを作成する場合、通常はWindowクラスを継承して、必要なコンテンツやボタンを追加する。<br>
MVVMパターンに従って実装することにより、ビジネスロジックとUIを分離して、保守性の高いコードを記述することができる。<br>
<br>
ダイアログの表示方法には同期的なものと非同期的なものがある。<br>
同期的な方法では、ダイアログが閉じられるまでコードの実行がブロックされる。<br>
一方、非同期的な方法では、ダイアログを表示しながら他の処理を続行できる。<br>
<br>
Avalonia UIでは、ダイアログのスタイリングも柔軟に行うことができる。<br>
XAMLを使用してダイアログの外観をカスタマイズして、アプリケーション全体のデザインに合わせることが可能である。<br>
<br>
ダイアログの結果の処理において、ユーザの選択や入力に基づいて、適切なアクションを実行するようにコードを設計する必要がある。<br>
<br><br>

== ファイル選択タイアログ ==
==== OpenFileDialogのプロパティ ====
下表に、ファイル選択ダイアログのプロパティのうち、設定を意識する必要がある主なプロパティを示す。<br>
<br>
<center>表. OpenFileDialogの主なプロパティ<br>
{| class="wikitable" style="background-color:#fefefe;"
|-
! style="background-color:#00ffff;" | プロパティ名 
! style="background-color:#00ffff;" | データ型 
! style="background-color:#00ffff;" | 意味
|-
| AllowMultiple || bool || 複数ファイルの選択を許可するかどうかを指定する。<br>許可する場合はtrue、単一のファイルのみの場合はfalseを指定する。(既定値 : false)
|-
| Directory || string || ダイアログが開かれる初期ディレクトリを指定する。
|-
| Filters || List<FileDialogFilter> || ダイアログに表示されるファイルタイプを制限する。
|-
| InitialFileName || string || ダイアログに表示される初期ファイル名を指定する。
|-
| Title || string || ファイル選択ダイアログのウインドウタイトルを指定する。
|}
</center>
<br>
WinFormsにあるような以下に示すプロパティは存在しない。<br>
そのため、Avalonia UIでの代替方法を以下に示す。<br>
<br>
* AddExtension (拡張子が入力されない場合、自動的に拡張子を付けるかどうか)
*: Avalonia UIでは、この機能は自動的に処理される。
*: Filtersプロパティで指定された拡張子が使用される。
*: <br>
* CheckFileExistsプロパティ / CheckPathExistsプロパティ
*: Avalonia UIでは、これらの検証はファイル選択後に手動で行う必要がある。
*: <br>
* FileNameプロパティ / FileNamesプロパティ (選択したファイルパスを取得)
*: Avalonia UIでは、OpenFileDialogクラスの<u><code>ShowAsync</code>メソッドの戻り値を使用</u>する。
*: <br>
* FilterIndexプロパティ (ファイルの種類のプルダウンの選択肢リストの初期選択インデックスを指定)
*: Avalonia UIでは、Filtersプロパティを使用してファイルタイプを制御する。
*: 特定のフィルタを選択する場合は、<code>Filters</code>リストの順序を調整する。
*: <br>
* Multiselectプロパティ (複数のファイルを選択できるかどうかを指定)
*: Avalonia UIでは、<code>AllowMultiple</code>プロパティを使用する。
*: <code>dialog.AllowMultiple = true;  // 複数ファイルの選択を許可</code>
*: <br>
* ReadOnlyCheckedプロパティ (読み取り専用として開くチェックボックスのON/OFFを設定または取得)
* ShowReadOnlyプロパティ (読み取り専用として開くチェックボックスを表示するかどうかを設定)
*: Avalonia UIでは、これらの機能は直接サポートされていない。
*: 必要に応じてカスタムダイアログを実装する、あるいは、ファイル選択後に読み取り専用の状態を確認・設定するロジックを実装する必要がある。
*: <br>
* SafeFileNameプロパティ (選択した拡張子を含むファイル名のみ(パスは含まない)を取得)
* SafeFileNamesプロパティ (選択した複数の拡張子を含むファイル名のみ(パスは含まない)を取得)
*: Avalonia UIでは、これらの概念は直接サポートされていない。
*: 必要に応じて、選択されたファイルパスから安全なファイル名を抽出するロジックを実装する必要がある。
*: <br>
* ShowHelpプロパティ (ヘルプボタン[?]を表示するかどうかを指定)
*: Avalonia UIのファイルダイアログでは、ヘルプ機能は標準では提供されていない。
*: 必要に応じて、別途ヘルプ機能を実装する必要がある。
<br>

==== Filtersプロパティ (ファイルの種類) の設定 ====
ダイアログで開くことができるファイルの種類は、<code>Filters</code>プロパティにフィルタ文字列を設定する。<br>
<br>
フィルタ文字列の設定を以下に示す。<br>
* FileDialogFilterクラスの使用
*: 各フィルタはFileDialogFilterオブジェクトとして定義される。
* Nameプロパティ
*: ユーザに表示されるフィルタの名前。
* Extensionsプロパティ
*: 拡張子のリストであり、ワイルドカード (*) を含めずに指定する。
* 複数の拡張子
*: 1つのフィルタに複数の拡張子を含めることができる。
* 全てのファイル
*: 全てのファイルを表す場合は、拡張子として <code>"*"</code> を使用する。
* フィルタの順序
*: リストに追加した順序でユーザに表示される。
<br>
WinFormsとの主な違いを、以下に示す。<br>
* Avalonia UIでは、拡張子にワイルドカード (*) を含めずに、単に拡張子名のみを指定する。
* 複数の拡張子やファイルタイプを1つのフィルタにまとめる場合、<code>Extensions</code>リストに全ての拡張子を追加する。
* フィルタ間の区切り (<code>|</code>) は使用せず、代わりに別の<code>FileDialogFilter</code>オブジェクトを作成する。
<br>
 <syntaxhighlight lang="c#">
 using Avalonia.Controls;
 using System.Collections.Generic;
 
 public class FileDialogExample
 {
    public void ShowFileDialog()
    {
       var dialog = new OpenFileDialog();
 
       // Filtersプロパティの設定方法 1
       // List<FileDialogFilter>の使用
       dialog.Filters = new List<FileDialogFilter>
       {
          new FileDialogFilter { Name = "すべてのファイル", Extensions = new List<string> { "*" } },
          new FileDialogFilter { Name = "テキストファイル", Extensions = new List<string> { "txt" } },
          new FileDialogFilter { Name = "テキストファイルとすべてのファイル", Extensions = new List<string> { "txt", "*" } },
          new FileDialogFilter { Name = "XMLファイル", Extensions = new List<string> { "xml" } },
          new FileDialogFilter { Name = "HTMLファイル", Extensions = new List<string> { "html", "htm" } },
          new FileDialogFilter { Name = "XMLファイルとHTMLファイルとすべてのファイル", Extensions = new List<string> { "xml", "html", "htm", "*" } },
          new FileDialogFilter { Name = "イメージファイル", Extensions = new List<string> { "png", "jpg", "gif", "bmp" } }
       };
 
       // Filtersプロパティの設定方法 2
       // FiltersのAddメソッドの使用
       dialog.Filters.Add(new FileDialogFilter { Name = "すべてのファイル", Extensions = { "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "テキストファイル", Extensions = { "txt" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "テキストファイルとすべてのファイル", Extensions = new List<string> { "txt", "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "XMLファイル", Extensions = { "xml" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "HTMLファイル", Extensions = new List<string> { "html", "htm" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "XMLファイルとHTMLファイルとすべてのファイル", Extensions = new List<string> { "xml", "html", "htm", "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "イメージファイル", Extensions = new List<string> { "png", "jpg", "gif", "bmp" } });
 
       // ファイル選択ダイアログを表示
       var result = await dialog.ShowAsync(this);
       if (result != null)
       {
          foreach (var path in result)
          {
             System.Console.WriteLine($"Selected file: {path}");
          }
       }
    }
 }
 </syntaxhighlight>
<br>

==== 使用例 ====
ダイアログを表示する場合は、OpenFileDialogクラスのShowAsyncメソッドを実行する。<br>
ShowAsyncメソッドは、非同期で動作してTask<string[]>型を返す。<br>
これにより、UIがブロックされることなくファイル選択操作を行うことができる。<br>
<br>
ShowAsyncメソッドの戻り値が<code>null</code>ではないこと、および、配列の長さが<u>0より大きいこと</u>を常に確認することが重要である。<br>
これにより、ユーザがファイルを選択せずにダイアログを閉じた場合や操作をキャンセルした場合にも適切に対応することができる。<br>
<br>
 <syntaxhighlight lang="c#">
 using Avalonia.Controls;
 using System.Collections.Generic;
 
 var dialog = new OpenFileDialog();
 dialog.Filters.Add(new FileDialogFilter() { Name = "テキストファイル", Extensions = { "txt" } });
 dialog.AllowMultiple = false;
 dialog.Directory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
 dialog.Title = "テキストファイルを選択してください";
 
 var result = await dialog.ShowAsync(this);
 if (result != null && result.Length > 0)
 {
    string selectedFilePath    = result[0];  // 単一ファイルの場合
    string[] selectedFilePaths = result;     // 複数ファイルの場合
 
    // 選択されたファイルを処理
    // ...略
 }
 </syntaxhighlight>
<br><br>

== ファイル選択タイアログ (StorageProviderクラス) ==
==== StorageProviderのプロパティ ====
下表に、ファイル選択ダイアログのプロパティのうち、設定を意識する必要がある主なプロパティを示す。<br>
<br>
<center>表. StorageProviderクラスの主なプロパティ<br>
{| class="wikitable" style="background-color:#fefefe;"
|-
! style="background-color:#00ffff;" | プロパティ名 
! style="background-color:#00ffff;" | データ型 
! style="background-color:#00ffff;" | 意味
|-
| AllowMultiple || bool || 複数のアイテムの選択を許可するかどうかを指定する。<br>複数のアイテムを選択する場合 : true<br>単一のファイルのみの場合 : false (既定値 : false)
|-
| FileTypeFilter<br><br>(厳密にはプロパティではない) || IReadOnlyList<FilePickerFileType>型 || <code>FilePickerOpenOptions</code>等のオプションクラスのプロパティとして使用する。<br>選択可能なファイルタイプを制限するためのフィルタのリストを指定する。
|-
| SuggestedStartLocation<br><br>(厳密にはプロパティではない) || IStorageFolder型 || ファイルピッカーやフォルダピッカーが開く初期ディレクトリを指定する。<br><code>FilePickerOpenOptions</code>や<code>FolderPickerOpenOptions</code>等のオプションクラスのプロパティとして使用する。<br><br>未指定または<code>null</code>を指定した場合、ファイルピッカーやフォルダピッカーは、システムやアプリケーションのデフォルトの開始位置を使用する。<br>多くの場合、ユーザのドキュメントディレクトリ、または、最後にファイルピッカーを使用した場所になる。
|-
| Title || string || ファイル選択ダイアログのウインドウタイトルを指定する。
|}
</center>
<br>

==== FileTypeFilter (ファイルの種類) の設定 ====
ダイアログで開くことができるファイルの種類は、<code>FilePickerOpenOptions</code>クラスの<code>FileTypeFilter</code>プロパティにフィルタ文字列を設定する。<br>
<br>
フィルタ文字列の設定を以下に示す。<br>
* FilePickerOpenOptionsクラス (オプションクラス) の使用
*: FilePickerOpenOptionsクラスのインスタンスを作成し、そのFileTypeFilterプロパティにフィルタを設定する。
*: <br>
* FilePickerFileTypeクラスの使用
*: 各フィルタはFilePickerFileTypeオブジェクトとして定義されます。コンストラクタの引数にフィルタの名前を指定する。
*: <br>
* Patterns
*: Patternsプロパティに、フィルタに含める拡張子のパターンを指定する。
*: <br>
* 複数の拡張子
*: 1つのフィルタに複数の拡張子を含めることができる。
*: 例えば、"HTMLファイル"フィルタでは、"*.html" と "*.htm" の両方を指定する。
*: <br>
* 全てのファイル
*: 全てのファイルを表す場合は、拡張子として "*" を使用する。
*: 例えば、"すべてのファイル"フィルタがこれに該当する。
*: <br>
* フィルタの順序
*: リストに追加した順序でユーザに表示される。
*: 以下の例では、"すべてのファイル"が最初に表示されて、以降"テキストファイル"、"XMLファイル"等の順で表示される。
<br>
この設定により、ユーザは様々なファイルタイプから選択できる。<br>
特定のファイル形式に絞り込む場合や全てのファイルを表示することもできる。<br>
<br>
<br>
 <syntaxhighlight lang="c#">
 var storageProvider = TopLevel.GetTopLevel(this)?.StorageProvider;
 
 var options = new FilePickerOpenOptions
 {
    FileTypeFilter = new[] 
    {
       new FilePickerFileType("すべてのファイル") { Patterns = new[] { "*" } },
       new FilePickerFileType("テキストファイル") { Patterns = new[] { "*.txt" } },
       new FilePickerFileType("XMLファイル")     { Patterns = new[] { "*.xml" } },
       new FilePickerFileType("HTMLファイル")    { Patterns = new[] { "*.html", "*.htm" } },
       new FilePickerFileType("Webファイル")     { Patterns = new[] { "*.html", "*.htm", "*.css", "*.js" } },
       new FilePickerFileType("XMLファイルとHTMLファイル") { Patterns = new[] { "*.xml", "*.html", "*.htm" } },
       new FilePickerFileType("イメージファイル") { Patterns = new[] { "*.png", "*.jpg", "*.gif", "*.bmp", "*.webp" } }
    }
 };
 
 var file = await storageProvider.OpenFilePickerAsync(options);
 </syntaxhighlight>
<br>

==== 使用例 ====
以下の例では、FilePickerOpenOptionsクラスを使用してstorageProviderクラスを設定した後、ディレクトリ選択ダイアログを開いている。<br>
<br>
SuggestedStartLocationやFileTypeFilterは、StorageProviderクラスの直接のプロパティではないことに注意する。<br>
<br>
 <syntaxhighlight lang="c#">
 using Avalonia.Platform.Storage;
 using System.IO;
 using System.Threading.Tasks;
 
 public class MyClass
 {
    public async Task OpenFileAsync()
    {
       var storageProvider = TopLevel.GetTopLevel(this)?.StorageProvider;
       if (storageProvider != null)
       {
          var options = new FilePickerOpenOptions
          {
             SuggestedStartLocation = await StorageProvider.TryGetFolderFromPathAsync($"/usr/local/bin"),
             FileTypeFilter = new[] 
             {
                new FilePickerFileType("Text Files") { Patterns = new[] { "*.txt" } },
                new FilePickerFileType("All Files") { Patterns = new[] { "*" } }
             },
             AllowMultiple = false
          };
 
          var file = await storageProvider.OpenFilePickerAsync(options);
 
          if (file.Count > 0)
          {  // ファイルが選択された場合の処理
             // ...略
          }
       }
    }
 }
 </syntaxhighlight>
<br><br>

== ファイル保存タイアログ (SaveFileDialogクラス) ==
==== SaveFileDialogのプロパティ ====
下表に、ファイル選択ダイアログのプロパティのうち、設定を意識する必要がある主なプロパティを示す。<br>
<br>
<center>表. SaveFileDialogの主なプロパティ<br>
{| class="wikitable" style="background-color:#fefefe;"
|-
! style="background-color:#00ffff;" | プロパティ名 
! style="background-color:#00ffff;" | データ型 
! style="background-color:#00ffff;" | 意味
|-
| DefaultExtension || string || ユーザが拡張子を指定しなかった場合に使用される既定の拡張子を設定または取得する。
|-
| Directory || string || ダイアログが開かれる初期ディレクトリを指定する。
|-
| Filters || List<FileDialogFilter> || ファイル種類のフィルタのリストを指定および取得する。<br>ユーザが選択できるファイル形式を制限するのに使用する。
|-
| InitialDirectory || string || ダイアログが最初に開かれるディレクトリを指定および取得する。<br><code>Directory</code>プロパティと似ているが、こちらはより優先度が高い。
|-
| InitialFileName || string || ダイアログに表示される初期ファイル名を指定する。
|-
| ShowOverwritePrompt || bool || 既存のファイルを上書きする前に確認ダイアログを表示するかどうかを指定および取得する。
|-
| Title || string || ファイル選択ダイアログのウインドウタイトルを指定する。
|}
</center>
<br>
以下の例では、各プロパティを指定して、ファイル保存ダイアログの動作をカスタマイズしている。<br>
<br>
 <syntaxhighlight lang="c#">
 var saveFileDialog = new SaveFileDialog
 {
    Title = "プロジェクトを保存",
    InitialFileName = "新規プロジェクト",
    Directory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments),
    DefaultExtension = ".proj",
 
    Filters = new List<FileDialogFilter>
    {
        new FileDialogFilter { Name = "プロジェクトファイル", Extensions = { "proj" } },
        new FileDialogFilter { Name = "すべてのファイル", Extensions = { "*" } }
    },
 
    ShowOverwritePrompt = true
 };
 </syntaxhighlight>
<br>
==== Filtersプロパティ (ファイルの種類) の設定 ====
ダイアログで開くことができるファイルの種類は、<code>Filters</code>プロパティにフィルタ文字列を設定する。<br>
<br>
フィルタ文字列の設定を以下に示す。<br>
* FileDialogFilterクラスの使用
*: 各フィルタはFileDialogFilterオブジェクトとして定義される。
* Nameプロパティ
*: ユーザに表示されるフィルタの名前。
* Extensionsプロパティ
*: 拡張子のリストであり、ワイルドカード (*) を含めずに指定する。
* 複数の拡張子
*: 1つのフィルタに複数の拡張子を含めることができる。
* 全てのファイル
*: 全てのファイルを表す場合は、拡張子として <code>"*"</code> を使用する。
* フィルタの順序
*: リストに追加した順序でユーザに表示される。
<br>
WinFormsとの主な違いを、以下に示す。<br>
* Avalonia UIでは、拡張子にワイルドカード (*) を含めずに、単に拡張子名のみを指定する。
* 複数の拡張子やファイルタイプを1つのフィルタにまとめる場合、<code>Extensions</code>リストに全ての拡張子を追加する。
* フィルタ間の区切り (<code>|</code>) は使用せず、代わりに別の<code>FileDialogFilter</code>オブジェクトを作成する。
<br>
 <syntaxhighlight lang="c#">
 using Avalonia.Controls;
 using System.Collections.Generic;
 
 public class FileDialogExample
 {
    public void ShowFileDialog()
    {
       var dialog = new SaveFileDialog();
 
       // Filtersプロパティの設定方法 1
       // List<FileDialogFilter>の使用
       dialog.Filters = new List<FileDialogFilter>
       {
          new FileDialogFilter { Name = "すべてのファイル", Extensions = new List<string> { "*" } },
          new FileDialogFilter { Name = "テキストファイル", Extensions = new List<string> { "txt" } },
          new FileDialogFilter { Name = "テキストファイルとすべてのファイル", Extensions = new List<string> { "txt", "*" } },
          new FileDialogFilter { Name = "XMLファイル", Extensions = new List<string> { "xml" } },
          new FileDialogFilter { Name = "HTMLファイル", Extensions = new List<string> { "html", "htm" } },
          new FileDialogFilter { Name = "XMLファイルとHTMLファイルとすべてのファイル", Extensions = new List<string> { "xml", "html", "htm", "*" } },
          new FileDialogFilter { Name = "イメージファイル", Extensions = new List<string> { "png", "jpg", "gif", "bmp" } }
       };
 
       // Filtersプロパティの設定方法 2
       // FiltersのAddメソッドの使用
       dialog.Filters.Add(new FileDialogFilter { Name = "すべてのファイル", Extensions = { "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "テキストファイル", Extensions = { "txt" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "テキストファイルとすべてのファイル", Extensions = new List<string> { "txt", "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "XMLファイル", Extensions = { "xml" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "HTMLファイル", Extensions = new List<string> { "html", "htm" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "XMLファイルとHTMLファイルとすべてのファイル", Extensions = new List<string> { "xml", "html", "htm", "*" } });
       dialog.Filters.Add(new FileDialogFilter { Name = "イメージファイル", Extensions = new List<string> { "png", "jpg", "gif", "bmp" } });
 
       // ファイル選択ダイアログを表示
       var result = await dialog.ShowAsync(this);
       if (result != null)
       {
          foreach (var path in result)
          {
             System.Console.WriteLine($"Selected file: {path}");
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== 使用例 ====
以下の例では、Avalonia UIを使用してファイル保存ダイアログを実装している。<br>
<br>
 <syntaxhighlight lang="c#">
 using Avalonia;
 using Avalonia.Controls;
 using Avalonia.Interactivity;
 using Avalonia.Markup.Xaml;
 using System;
 using System.IO;
 using System.Threading.Tasks;
 
 public partial class MainWindow : Window
 {
    public MainWindow()
    {
       InitializeComponent();
    }
 
    private void InitializeComponent()
    {
       AvaloniaXamlLoader.Load(this);
    }
 
    // 保存ボタンを押下
    public async void OnSaveButtonClicked(object sender, RoutedEventArgs e)
    {
       try
       {
          string content = "Hello, directory.";  // 保存する内容
          string savedFilePath = await ShowSaveFileDialogAsync();
 
          if (!string.IsNullOrEmpty(savedFilePath))
          {
             await SaveFileAsync(savedFilePath, content);
             Console.WriteLine("成功", $"ファイルを正常に保存: {savedFilePath}");
          }
       }
       catch (Exception ex)
       {
          Console.WriteLine("エラー", $"ファイルの保存中にエラーが発生: {ex.Message}");
       }
    }
 
    // ファイル保存ダイアログを表示して、選択されたファイルパスを返す
    private async Task<string> ShowSaveFileDialogAsync()
    {
       var saveFileDialog = new SaveFileDialog();
 
       // ダイアログのタイトル
       saveFileDialog.Title = "ファイルを保存";
 
       // .txtファイルのフィルタを追加
       saveFileDialog.Filters.Add(new FileDialogFilter { Name = "テキストファイル", Extensions = { "txt" } });
 
       string result = await saveFileDialog.ShowAsync(this);
       return result;
    }
 
    // 指定されたパスにファイルを非同期で保存
    private async Task SaveFileAsync(string filePath, string content)
    {
       await File.WriteAllTextAsync(filePath, content);
    }
 }
 </syntaxhighlight>
<br><br>

== ディレクトリ選択タイアログ ==
==== OpenFolderDialogクラスのプロパティ ====
下表に、ディレクトリ選択ダイアログのプロパティのうち、設定を意識する必要がある主なプロパティを示す。<br>
<br>
<center>表. OpenFolderDialogクラスの主なプロパティ<br>
{| class="wikitable" style="background-color:#fefefe;"
|-
! style="background-color:#00ffff;" | プロパティ名 
! style="background-color:#00ffff;" | データ型 
! style="background-color:#00ffff;" | 意味
|-
| AllowMultiple || bool || 複数のアイテムの選択を許可するかどうかを指定する。<br>複数のアイテムを選択する場合 : true<br>単一のファイルのみの場合 : false (既定値 : false)
|-
| Directory || string || ダイアログが最初に開くディレクトリのパスを指定する。<br>ユーザが頻繁にアクセスするディレクトリやアプリケーションのデフォルトディレクトリを初期表示するために使用する。<br><br>例: "ドキュメント"ディレクトリを初期ディレクトリとして指定する場合<br><code>Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments)</code>
|-
| SuggestedStartLocation || IStorageFolder型 || ダイアログの推奨される開始位置を指定する。<br><code>Directory</code>プロパティの代替として使用できる。<br>特定のストレージプロバイダ (例: OneDriveディレクトリ) を初期位置として指定する場合に特に有効である。<br><br><u>※注意</u><br><u>この値が設定されている場合、Directoryプロパティよりも優先される。</u>
|-
| Title || string || ディレクトリ選択ダイアログのウインドウタイトルを指定する。
|}
</center>
<br>

==== 使用例 ====
以下の例では、Avalonia UIを使用してディレクトリ選択ダイアログを使用している。<br>
<br>
ダイアログはユーザのデスクトップディレクトリから開始されるが、何らかの理由でデスクトップディレクトリにアクセスできない場合は、ドキュメントディレクトリにフォールバックする。<br>
<br>
この方法は、ユーザが頻繁に使用するディレクトリからダイアログを開始することにより、ユーザエクスペリエンスを向上させることができる。<br>
また、<code>SuggestedStartLocation</code>プロパティを使用することで、将来的により柔軟な開始位置の設定 (例: アプリケーション固有のストレージフォルダ等) が可能になる。<br>
<br>
 <syntaxhighlight lang="c#">
 using Avalonia;
 using Avalonia.Controls;
 using Avalonia.Interactivity;
 using System;
 using System.Threading.Tasks;
 
 public partial class MainWindow : Window
 {
    public MainWindow()
    {
       InitializeComponent();
    }
 
    // ディレクトリ選択ボタンのクリックイベントハンドラ
    private async void OnSelectDirectoryClicked(object sender, RoutedEventArgs e)
    {
       try
       {
          // OpenFolderDialogのインスタンスを生成
          var dialog = new OpenFolderDialog
          {
             // ダイアログのタイトルを設定
             Title = "ディレクトリを選択してください",
 
             // 初期ディレクトリを設定
             Directory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments)
          };
 
          // SuggestedStartLocationを設定
          // デスクトップディレクトリを推奨開始位置として使用
          var desktopFolder = await StorageProvider.TryGetFolderFromPathAsync(
                                       Environment.GetFolderPath(Environment.SpecialFolder.Desktop));
          if (desktopFolder != null)
          {
             dialog.SuggestedStartLocation = desktopFolder;
          }
          else
          {  // デスクトップフォルダが取得できない場合は、従来のDirectoryプロパティを使用
             dialog.Directory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
          }
 
          // ダイアログを表示して、ディレクトリを選択するまで待機
          string? result = await dialog.ShowAsync(this);
 
          // 結果の処理
          if (result != null)
          {  // 選択されたディレクトリパスを表示
             Console.WriteLine($"{result}");
          }
          else
          {  // ユーザがキャンセルした場合やディレクトリが選択されなかった場合
             Console.WriteLine("ディレクトリが未選択");
          }
       }
       catch (Exception ex)
       {  // 予期せぬエラーが発生した場合
          Console.WriteLine($"エラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight> 
<br><br>

== ディレクトリ選択タイアログ (StorageProviderクラス) ==
==== StorageProviderクラスのプロパティ ====
下表に、ディレクトリ選択ダイアログのプロパティのうち、設定を意識する必要がある主なプロパティを示す。<br>
<br>
<center>表. StorageProviderクラスの主なプロパティ<br>
{| class="wikitable" style="background-color:#fefefe;"
|-
! style="background-color:#00ffff;" | プロパティ名 
! style="background-color:#00ffff;" | データ型 
! style="background-color:#00ffff;" | 意味
|-
| AllowMultiple || bool || 複数のアイテムの選択を許可するかどうかを指定する。<br>複数のアイテムを選択する場合 : true<br>単一のファイルのみの場合 : false (既定値 : false)
|-
| FileTypeFilter || IReadOnlyList<FilePickerFileType>型 || <code>FilePickerOpenOptions</code>等のオプションクラスのプロパティとして使用する。<br>選択可能なファイルタイプを制限するためのフィルタのリストを指定する。
|-
| SuggestedStartLocation || IStorageFolder型 || ファイルピッカーやフォルダピッカーが開く初期ディレクトリを指定する。<br><code>FilePickerOpenOptions</code>や<code>FolderPickerOpenOptions</code>等のオプションクラスのプロパティとして使用する。<br><br>未指定または<code>null</code>を指定した場合、ファイルピッカーやフォルダピッカーは、システムやアプリケーションのデフォルトの開始位置を使用する。<br>多くの場合、ユーザのドキュメントディレクトリ、または、最後にファイルピッカーを使用した場所になる。
|-
| Title || string || ファイル選択ダイアログのウインドウタイトルを指定する。
|}
</center>
<br>

==== 使用例 ====
以下の例では、指定された開始位置 ("/usr/local/bin") からディレクトリ選択ダイアログを開き、ユーザが選択したディレクトリのパスを取得している。<br>
<br>
 <syntaxhighlight lang="c#">
 using Avalonia.Platform.Storage;
 using System.IO;
 using System.Threading.Tasks;
 
 public class MyClass
 {
    public async Task OpenDirectoryAsync()
    {
       var storageProvider = TopLevel.GetTopLevel(this)?.StorageProvider;
       if (storageProvider != null)
       {
          var options = new FolderPickerOpenOptions
          {
             SuggestedStartLocation = await storageProvider.TryGetFolderFromPathAsync("/usr/local/bin"),
             AllowMultiple = false
          };
 
          var folders = await storageProvider.OpenFolderPickerAsync(options);
 
          if (folders.Count > 0)
          {
             var selectedFolder = folders[0];
             // 選択されたディレクトリに対する処理
             // 例: ディレクトリのパスを取得
             var path = await selectedFolder.GetPathAsync();
             System.Diagnostics.Debug.WriteLine($"選択ディレクトリ: {path}");
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== ディレクトリパスのURLデコード ====
Avalonia UIのストレージシステムは、内部でパスの処理を適切に行うように設計されている。<br>
そのため、IStorageFolder.GetPathAsyncメソッドは、デコードされたパスを返す。<br>
<br>
しかし、もしパスに特殊文字が含まれている場合や何らかの理由でURLエンコードされた形式で返される可能性がある場合は、以下に示すようにURLデコードを行うことができる。<br>
<br>
 <syntaxhighlight lang="c#">
 // 方法 1
 
 using System.Web;
 
 var path = await selectedFolder.GetPathAsync();
 var decodedPath = HttpUtility.UrlDecode(path);
 System.Diagnostics.Debug.WriteLine($"選択ディレクトリ: {decodedPath}");
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c#">
 // 方法 2
 
 using System.Net;
 using System.Linq;
 
 // ディレクトリが空でないことを確認
 if (folders.Any())
 {
    var selectedFolder = folders.First();
    var path = await selectedFolder.GetPathAsync();  // パスを取得
    var decodedPath = WebUtility.UrlDecode(path);    // パスをデコード
    System.Diagnostics.Debug.WriteLine($"選択ディレクトリ: {decodedPath}");
 }
 else
 {
    System.Diagnostics.Debug.WriteLine("ディレクトリが未選択");
 }
 </syntaxhighlight>
<br><br>


{{#seo:
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,電気回路,電子回路,基板,プリント基板
|description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報 | This page is {{PAGENAME}} in our wiki about electronic circuits and SUSE Linux
|image=/resources/assets/MochiuLogo_Single_Blue.png
}}

__FORCETOC__
[[カテゴリ:C_Sharp]]