PromptPlus

# PromptPlus ## **File — Methods** [](https://www.nuget.org/packages/PromptPlus) [](https://opensource.org/licenses/MIT) [](https://dotnet.microsoft.com/)

← Back to Home • Next: File — Operations →

---

Every fluent method on IFileControl. Each returns the same control instance, so calls chain in any order. Call Run last.

The factory is PromptPlus.Controls.File(string prompt = "", string? description = null), which returns IFileControl.

Quick jump: Root · SearchPattern · OnlyFolders · ShowHidden · ShowSystem · SelectFilesOnly · HideSize · ShowFullPath · PageSize · Default · EnableHistory · Styles · Options · Run

---

Choosing the root

Root

IFileControl Root(string path)

Sets the folder the tree starts at. When not set, the current directory (Directory.GetCurrentDirectory()) is used. Point it at a drive root (e.g. C:\) to browse a whole volume.

PromptPlus.Controls.File("Pick")
    .Root(@"C:\Projects")
    .Run();

Throws ArgumentNullException if path is null.

---

Filtering what is listed

SearchPattern

IFileControl SearchPattern(string pattern)

Filters files by a wildcard pattern; directories are always listed so the tree can be navigated. Default is * (all files).

PromptPlus.Controls.File("Pick a C# file")
    .Root(root)
    .SearchPattern("*.cs")
    .Run();

Throws ArgumentNullException if pattern is null.

---

OnlyFolders

IFileControl OnlyFolders(bool value = true)

Lists directories only, hiding all files. Useful when the user should pick a folder.

PromptPlus.Controls.File("Pick a folder").Root(root).OnlyFolders().Run();

---

ShowHidden

IFileControl ShowHidden(bool value = true)

Includes entries marked with the Hidden attribute. Hidden by default.

---

ShowSystem

IFileControl ShowSystem(bool value = true)

Includes entries marked with the System attribute. Hidden by default.

PromptPlus.Controls.File("Browse (incl. hidden/system)")
    .Root(root)
    .ShowHidden()
    .ShowSystem()
    .Run();

---

Selection rule

SelectFilesOnly

IFileControl SelectFilesOnly(bool value = true)

Restricts the returned entry to files. Folders can still be expanded and browsed, but pressing Enter on a folder does not confirm it.

PromptPlus.Controls.File("Pick a file")
    .Root(root)
    .SearchPattern("*.cs")
    .SelectFilesOnly()
    .Run();

---

Layout & display

HideSize

IFileControl HideSize(bool value = true)

Hides the file-size column shown next to files.

PromptPlus.Controls.File("Pick").Root(root).HideSize().Run();

---

ShowFullPath

IFileControl ShowFullPath(bool value = true)

Sets whether the answer/summary shows the full path or just the entry name for the selected item. Default is to show only the name. The user can flip this at runtime with the full-path hotkey (Shift+F3) regardless of the initial value.

PromptPlus.Controls.File("Select (answer shows short name)")
    .Root(root)
    .ShowFullPath(false)
    .Run();

---

PageSize

IFileControl PageSize(byte value)

Rows visible at once (valid range 0–255). 0 (default) auto-fits to the console height, reserving lines for the header, footer, and pagination.

PromptPlus.Controls.File("Pick").Root(root).PageSize(12).Run();

---

Initial value

Default

IFileControl Default(string fullPath, bool useDefaultHistory = true)

Pre-selects a file or directory, expanding the tree down to it when the path lies under the root. When useDefaultHistory is true and history is enabled, a stored value may override this default.

PromptPlus.Controls.File("Pick")
    .Root(root)
    .Default(@"C:\Projects\App\Program.cs")
    .Run();

Throws ArgumentNullException if fullPath is null.

---

History

EnableHistory

IFileControl EnableHistory(string filename, Action<IHistoryOptions>? options = null)

Persists the confirmed path to filename and can restore it as the default on the next run (the tree expands to it). The IHistoryOptions builder is identical to the one documented for Input → EnableHistory (MinPrefixLength, MaxItems, ExpirationTime, FilterType, PageSize).

PromptPlus.Controls.File("Pick a file (remembered)")
    .Root(root)
    .EnableHistory("file-history")
    .Run();

Throws ArgumentNullException if filename is null.

---

Appearance & behavior

Styles

IFileControl Styles(FileStyles styleType, Style style)

Recolors one visual region of this control. See the region list and examples on the Styles page.

using PromptPlusLibrary;
using ConsolePlusLibrary;   // Color, Style live here
PromptPlus.Controls.File("Pick").Root(root)
    .Styles(FileStyles.FileTypeFolder, new Style(Color.Cyan, Color.Default))
    .Run();

---

Options

IFileControl Options(Action<IControlOptions> options)

Overrides global behaviors for this one control (prompt/description text, abort key, tooltip, hide-after-finish). See Global Behaviors → Per-Control Override.

PromptPlus.Controls.File("Pick").Root(root)
    .Options(opt =>
    {
        opt.ShowTooltip(true);
        opt.EnabledAbortKey(true);
        opt.HideAfterFinish(false);
    })
    .Run();

Throws ArgumentNullException if options is null.

---

Running the control

Run

ResultPrompt<FileItem?> Run(CancellationToken token = default)

Renders the tree and blocks until the user confirms (Enter) or aborts (Esc). Returns ResultPrompt<FileItem?>; .Content is null when aborted.

var result = PromptPlus.Controls.File("Pick").Root(root).Run();
if (!result.IsAborted)
    PromptPlus.Console.WriteLine(result.Content?.FullPath);

---

See also

• Operations — how these methods behave at runtime
• Styles — the FileStyles regions
• Index — overview and method map
• MultiFile → Methods — the multiple-selection sibling

This site is open source. Improve this page.