Quick Start

This guide will get a basic text editor running in your main window.

1. Add Namespace

In your MainWindow.xaml, add the namespace declaration for AvaloniaEdit:

<Window xmlns="https://github.com/avaloniaui"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:AvaloniaEdit="clr-namespace:AvaloniaEdit;assembly=AvaloniaEdit"
        x:Class="MyAvaloniaApp.MainWindow"
        Title="AvaloniaEdit Sample">

2. Add the Control

Add the TextEditor control to your XAML layout. You can set basic properties like ShowLineNumbers and FontFamily immediately.

<AvaloniaEdit:TextEditor Name="Editor"
                         ShowLineNumbers="True"
                         FontFamily="Cascadia Code,Consolas,Menlo,Monospace"
                         HorizontalScrollBarVisibility="Auto"
                         VerticalScrollBarVisibility="Visible"
                         FontSize="14" />

3. Interact via Code-Behind

You can access the editor instance to set text or configuration options.

using Avalonia.Controls;
using AvaloniaEdit.Document;

public partial class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();

        var textEditor = this.FindControl<AvaloniaEdit.TextEditor>("Editor");

        // Set initial text
        textEditor.Text = "Hello, AvaloniaEdit!";

        // Or load a document object
        textEditor.Document = new TextDocument("This is a text document.");
    }
}

4. Run

Build and run your application. You should see a text editor with line numbers on the left side.