NanoByte.Common 2.11.0
NanoByte.Common.Controls.InputBox Class Reference

Shows a simple dialog asking the user to input some text. More...

Inheritance diagram for NanoByte.Common.Controls.InputBox:

Static Public Member Functions

static ? string Show (IWin32Window? owner, [Localizable(true)] string title, [Localizable(true)] string prompt, [Localizable(true)] string? defaultText=null, bool password=false)
 Displays an input box asking the the user to input some text. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Detailed Description

Shows a simple dialog asking the user to input some text.

Member Function Documentation

◆ Dispose()

override void NanoByte.Common.Controls.InputBox.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ Show()

static ? string NanoByte.Common.Controls.InputBox.Show ( IWin32Window?  owner,
[Localizable(true)] string  title,
[Localizable(true)] string  prompt,
[Localizable(true)] string?  defaultText = null,
bool  password = false 
)
inlinestatic

Displays an input box asking the the user to input some text.

Parameters
ownerThe parent window the displayed window is modal to; can be null.
titleThe window title to use.
promptThe prompt to display.
defaultTextThe default text to show pre-entered in the input field.
passwordShall the input characters be hidden as a password?
Returns
The text the user entered if she pressed OK; otherwise null.

The documentation for this class was generated from the following files: