Skip to content

Getting-Started.md

Latest commit

 

History

History
383 lines (268 loc) · 11.4 KB

Getting-Started.md

File metadata and controls

383 lines (268 loc) · 11.4 KB
Raw
layout post
title Getting Started with .NET MAUI Rich Text Editor control | Syncfusion®
description Learn here about getting started with Syncfusion® .NET MAUI Rich Text Editor (SfRichTextEditor) control, its elements and more.
platform maui
control Rich Text Editor
documentation ug

Getting Started with .NET MAUI Rich Text Editor

This section guides you through setting up and configuring a Rich Text Editor in your .NET MAUI application. Follow the steps below to add a basic Rich Text Editor to your project.

To get start quickly with our .NET MAUI Rich Text Editor, you can check the below video.

{% youtube "https://www.youtube.com/watch?v=1r8OrZxG_HI" %}

{% tabcontents %} {% tabcontent Visual Studio %}

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with Visual Studio 2022 v17.12 or later.

Step 1: Create a New MAUI Project

  1. Go to File > New > Project and choose the .NET MAUI App template.
  2. Name the project and choose a location. Then, click Next.
  3. Select the .NET framework version and click Create.

Step 2: Install the Syncfusion®.MAUI RichTextEditor NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for and install the latest version.
  3. Ensure the necessary dependencies are installed correctly, and the project is restored.

Step 3: Register the Handler

Syncfusion.Maui.Core nuget is a dependent package for all Syncfusion® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion® core.

{% highlight c# hl_lines="6 17" %}

using Microsoft.Maui; using Microsoft.Maui.Hosting; using Microsoft.Maui.Controls.Compatibility; using Microsoft.Maui.Controls.Hosting; using Microsoft.Maui.Controls.Xaml; using Syncfusion.Maui.Core.Hosting;

namespace RichTextEditorSample { public static class MauiProgram { public static MauiApp CreateMauiApp() { var builder = MauiApp.CreateBuilder(); builder .UseMauiApp() .ConfigureSyncfusionCore() .ConfigureFonts(fonts => { fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular"); });

        return builder.Build();
    }      
}

}

{% endhighlight %}

Step 4: Add a Basic Rich Text Editor

Step 1: Add the namespace as shown in the following code sample.

{% tabs %} {% highlight xaml %}

xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"

{% endhighlight %} {% highlight c# %}

using Syncfusion.Maui.RichTextEditor;

{% endhighlight %} {% endtabs %}

Step 2: Add the SfRichTextEditor control with a required optimal name using the included namespace.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"> <rte:SfRichTextEditor />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.RichTextEditor;

namespace RichTextEditorSample { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRichTextEditor richTextEditor = new SfRichTextEditor(); this.Content = richTextEditor; } } }

{% endhighlight %}

{% endtabs %}

{% endtabcontent %} {% tabcontent Visual Studio Code %}

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with Visual Studio Code.
  3. Ensure that the .NET MAUI workloads are installed and configured as described here.

Step 1: Create a New .NET MAUI Project

  1. Open the Command Palette by pressing Ctrl+Shift+P and type .NET:New Project and press Enter.
  2. Choose the .NET MAUI App template.
  3. Select the project location, type the project name and press Enter.
  4. Then choose Create project

Step 2: Install the Syncfusion®.MAUI RichTextEditor NuGet Package

  1. Press Ctrl + ` (backtick) to open the integrated terminal in Visual Studio Code.
  2. Ensure you're in the project root directory where your .csproj file is located.
  3. Run the command dotnet add package Syncfusion.Maui.RichTextEditor to install the .NET MAUI Rich Text Editor package.
  4. To ensure all dependencies are installed, run dotnet restore.

Step 3: Register the Handler

Syncfusion.Maui.Core nuget is a dependent package for all Syncfusion® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion® core.

{% highlight c# hl_lines="6 17" %}

using Microsoft.Maui; using Microsoft.Maui.Hosting; using Microsoft.Maui.Controls.Compatibility; using Microsoft.Maui.Controls.Hosting; using Microsoft.Maui.Controls.Xaml; using Syncfusion.Maui.Core.Hosting;

namespace RichTextEditorSample { public static class MauiProgram { public static MauiApp CreateMauiApp() { var builder = MauiApp.CreateBuilder(); builder .UseMauiApp() .ConfigureSyncfusionCore() .ConfigureFonts(fonts => { fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular"); });

        return builder.Build();
    }      
}

}

{% endhighlight %}

Step 4: Add a Basic Rich Text Editor

Step 1: Add the namespace as shown in the following code sample.

{% tabs %} {% highlight xaml %}

xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"

{% endhighlight %} {% highlight c# %}

using Syncfusion.Maui.RichTextEditor;

{% endhighlight %} {% endtabs %}

Step 2: Add the SfRichTextEditor control with a required optimal name using the included namespace.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"> <rte:SfRichTextEditor />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.RichTextEditor;

namespace RichTextEditorSample { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRichTextEditor richTextEditor = new SfRichTextEditor(); this.Content = richTextEditor; } } }

{% endhighlight %}

{% endtabs %}

{% endtabcontent %}

{% tabcontent JetBrains Rider %}

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with JetBrains Rider 2024.3 or later.
  3. Make sure the MAUI workloads are installed and configured as described here.

Step 1: Create a new .NET MAUI Project

  1. Go to File > New Solution, Select .NET (C#) and choose the .NET MAUI App template.
  2. Enter the Project Name, Solution Name, and Location.
  3. Select the .NET framework version and click Create.

Step 2: Install the Syncfusion® MAUI RichTextEditor NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Core and install the latest version.
  3. Ensure the necessary dependencies are installed correctly, and the project is restored. If not, Open the Terminal in Rider and manually run: dotnet restore

Step 3: Register the handler

Syncfusion.Maui.Core nuget is a dependent package for all Syncfusion® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion® core.

{% tabs %} {% highlight C# tabtitle="MauiProgram.cs" hl_lines="6 17" %}

using Microsoft.Maui; using Microsoft.Maui.Hosting; using Microsoft.Maui.Controls.Compatibility; using Microsoft.Maui.Controls.Hosting; using Microsoft.Maui.Controls.Xaml; using Syncfusion.Maui.Core.Hosting;

namespace ChartGettingStarted { public static class MauiProgram { public static MauiApp CreateMauiApp() { var builder = MauiApp.CreateBuilder(); builder .UseMauiApp() .ConfigureSyncfusionCore() .ConfigureFonts(fonts => { fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular"); });

        return builder.Build();
    }
}

}

{% endhighlight %} {% endtabs %}

Step 4: Add a Basic Rich Text Editor

Step 1: Add the namespace as shown in the following code sample.

{% tabs %} {% highlight xaml %}

xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"

{% endhighlight %} {% highlight c# %}

using Syncfusion.Maui.RichTextEditor;

{% endhighlight %} {% endtabs %}

Step 2: Add the SfRichTextEditor control with a required optimal name using the included namespace.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:rte="clr-namespace:Syncfusion.Maui.RichTextEditor;assembly=Syncfusion.Maui.RichTextEditor"> <rte:SfRichTextEditor />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.RichTextEditor;

namespace RichTextEditorSample { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRichTextEditor richTextEditor = new SfRichTextEditor(); this.Content = richTextEditor; } } }

{% endhighlight %}

{% endtabs %}

{% endtabcontent %} {% endtabcontents %}

Step 5: Enable the Toolbar

The SfRichTextEditor provides a comprehensive toolbar that allows users to format their content easily. You can enable it by setting the ShowToolbar property to True.

{% tabs %}

{% highlight xaml %}

<rte:SfRichTextEditor ShowToolbar="True" />

{% endhighlight %}

{% highlight C# %}

SfRichTextEditor richTextEditor = new SfRichTextEditor(); richTextEditor.ShowToolbar = true; this.Content = richTextEditor;

{% endhighlight %}

{% endtabs %}

.NET MAUI Rich Text Editor with Toolbar

N> Looking for the full .NET MAUI Rich Text Editor component overview, features, pricing, and documentation? Visit the .NET MAUI Rich Text Editor page.