mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
Fixed doc issues (#3835)
This commit is contained in:
86
README.md
86
README.md
@@ -49,91 +49,7 @@ The team is looking forward to seeing new amazing projects made by the community
|
||||
|
||||
The following example shows a basic Terminal.Gui application in C#:
|
||||
|
||||
```csharp
|
||||
// This is a simple example application. For the full range of functionality
|
||||
// see the UICatalog project
|
||||
|
||||
// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements
|
||||
|
||||
using System;
|
||||
using Terminal.Gui;
|
||||
|
||||
Application.Run<ExampleWindow> ().Dispose ();
|
||||
|
||||
// Before the application exits, reset Terminal.Gui for clean shutdown
|
||||
Application.Shutdown ();
|
||||
|
||||
// To see this output on the screen it must be done after shutdown,
|
||||
// which restores the previous screen.
|
||||
Console.WriteLine ($@"Username: {ExampleWindow.UserName}");
|
||||
|
||||
// Defines a top-level window with border and title
|
||||
public class ExampleWindow : Window
|
||||
{
|
||||
public static string UserName;
|
||||
|
||||
public ExampleWindow ()
|
||||
{
|
||||
Title = $"Example App ({Application.QuitKey} to quit)";
|
||||
|
||||
// Create input components and labels
|
||||
var usernameLabel = new Label { Text = "Username:" };
|
||||
|
||||
var userNameText = new TextField
|
||||
{
|
||||
// Position text field adjacent to the label
|
||||
X = Pos.Right (usernameLabel) + 1,
|
||||
|
||||
// Fill remaining horizontal space
|
||||
Width = Dim.Fill ()
|
||||
};
|
||||
|
||||
var passwordLabel = new Label
|
||||
{
|
||||
Text = "Password:", X = Pos.Left (usernameLabel), Y = Pos.Bottom (usernameLabel) + 1
|
||||
};
|
||||
|
||||
var passwordText = new TextField
|
||||
{
|
||||
Secret = true,
|
||||
|
||||
// align with the text box above
|
||||
X = Pos.Left (userNameText),
|
||||
Y = Pos.Top (passwordLabel),
|
||||
Width = Dim.Fill ()
|
||||
};
|
||||
|
||||
// Create login button
|
||||
var btnLogin = new Button
|
||||
{
|
||||
Text = "Login",
|
||||
Y = Pos.Bottom (passwordLabel) + 1,
|
||||
|
||||
// center the login button horizontally
|
||||
X = Pos.Center (),
|
||||
IsDefault = true
|
||||
};
|
||||
|
||||
// When login button is clicked display a message popup
|
||||
btnLogin.Accept += (s, e) =>
|
||||
{
|
||||
if (userNameText.Text == "admin" && passwordText.Text == "password")
|
||||
{
|
||||
MessageBox.Query ("Logging In", "Login Successful", "Ok");
|
||||
UserName = userNameText.Text;
|
||||
Application.RequestStop ();
|
||||
}
|
||||
else
|
||||
{
|
||||
MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok");
|
||||
}
|
||||
};
|
||||
|
||||
// Add the views to the Window
|
||||
Add (usernameLabel, userNameText, passwordLabel, passwordText, btnLogin);
|
||||
}
|
||||
}
|
||||
```
|
||||
[!code-csharp[](./Example/Example.cs)]
|
||||
|
||||
When run the application looks as follows:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user