Skip to content

getting-started.md

Latest commit

 

History

History
585 lines (427 loc) · 18.7 KB

getting-started.md

File metadata and controls

585 lines (427 loc) · 18.7 KB
Raw
layout post
title Getting started with .NET MAUI Range Selector control | Syncfusion®
description This section explains about the getting started with Syncfusion® MAUI Range Selector (SfRangeSelector) control.
platform maui
control SfRangeSelector
documentation ug

Getting Started with .NET MAUI Range Selector

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

To quickly get started with the .NET MAUI Range Selector, watch this video.

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

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

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET SDK
  1. Set up a .NET MAUI Environment with Visual Studio. Supported Visual Studio Versions:
  • Visual Studio 2022: Version 17.13 or later (e.g., 17.14.7) for .NET 9 development.
  • Visual Studio 2026: Required for .NET 10 development.

Step 1: Create a New .NET 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 Sliders NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Sliders 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 RangeSelector { 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 Range Selector

Import the SfRangeSelector namespace and initialize the Range Selector as shown below.

{% tabs %}

{% highlight xaml %}

<ContentPage . . . xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders"> <sliders:SfRangeSelector />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.Sliders;

namespace GettingStarted { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRangeSelector rangeSelector = new SfRangeSelector(); content = rangeSelector; } } }

{% endhighlight %}

{% endtabs %}

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

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install the .NET 9 SDK or a later version.
  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 Sliders 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.Sliders to install the Syncfusion® .NET MAUI Sliders 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 RangeSelector { 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 Range Selector

Import the SfRangeSelector namespace and initialize the Range Selector as shown below.

{% tabs %}

{% highlight xaml %}

<ContentPage . . . xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders"> <sliders:SfRangeSelector />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.Sliders;

namespace GettingStarted { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRangeSelector rangeSelector = new SfRangeSelector(); content = rangeSelector; } } }

{% endhighlight %}

{% endtabs %}

{% endtabcontent %} {% tabcontent JetBrains Rider %}

Prerequisites

Before proceeding, ensure the following are set up:

  1. Ensure you have the latest version of JetBrains Rider.
  2. Install the .NET 9 SDK or a later version.
  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 Sliders NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Sliders 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.

{% 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 RangeSelector { 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 Range Selector

Import the SfRangeSelector namespace and initialize the Range Selector as shown below.

{% tabs %}

{% highlight xaml %}

<ContentPage . . . xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders"> <sliders:SfRangeSelector />

{% endhighlight %}

{% highlight C# %}

using Syncfusion.Maui.Sliders;

namespace GettingStarted { public partial class MainPage : ContentPage { public MainPage() { InitializeComponent(); SfRangeSelector rangeSelector = new SfRangeSelector(); content = rangeSelector; } } }

{% endhighlight %}

{% endtabs %}

{% endtabcontent %} {% endtabcontents %}

Initialize RangeSelector

Adding content to Range Selector

The Content property will add the content to the Range Selector. Add any control within the Range Selector with this property. In most cases, the Charts will be added as a content.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders" xmlns:charts="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts" xmlns:local="clr-namespace:SliderTestbedSample.RangeSelector">

<ContentPage.BindingContext>
    <local:ViewModel />
</ContentPage.BindingContext>

<sliders:SfRangeSelector Minimum="10"
                         Maximum="20"
                         RangeStart="13"
                         RangeEnd="17">
    <charts:SfCartesianChart>

        <charts:SfCartesianChart.XAxes>
            <charts:DateTimeAxis IsVisible="False"
                                ShowMajorGridLines="False" />
        </charts:SfCartesianChart.XAxes>

        <charts:SfCartesianChart.YAxes>
            <charts:NumericalAxis IsVisible="False"
                                 ShowMajorGridLines="False" />
        </charts:SfCartesianChart.YAxes>

        <charts:SfCartesianChart.Series>
            <charts:SplineAreaSeries ItemsSource="{Binding Source}"
                                    XBindingPath="X"
                                    YBindingPath="Y">
            </charts:SplineAreaSeries>

        </charts:SfCartesianChart.Series>
    
    </charts:SfCartesianChart>

</sliders:SfRangeSelector>

{% endhighlight %}

{% highlight C# %}

SfRangeSelector rangeSelector = new SfRangeSelector(); rangeSelector.Minimum = 10; rangeSelector.Maximum = 20; rangeSelector.RangeStart = 13; rangeSelector.RangeEnd = 17; SfCartesianChart chart = new SfCartesianChart(); DateTimeAxis primaryAxis = new DateTimeAxis(); chart.XAxes = primaryAxis; NumericalAxis secondaryAxis = new NumericalAxis(); chart.YAxes = secondaryAxis; SplineAreaSeries series = new SplineAreaSeries(); series.ItemsSource = (new ViewModel()).Source; series.XBindingPath = "X"; series.YBindingPath = "Y"; rangeSelector.Content = chart;

{% endhighlight %}

{% endtabs %}

RangeSelector labels

Enable labels

The ShowLabels property enables the labels which renders on given interval.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders" xmlns:charts="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts">

<sliders:SfRangeSelector Minimum="0" 
                         Maximum="10" 
                         RangeStart="2" 
                         RangeEnd="8"
                         Interval="2" 
                         ShowLabels="True">

    <charts:SfCartesianChart>
        ...
    </charts:SfCartesianChart>

</sliders:SfRangeSelector>

{% endhighlight %}

{% highlight C# %}

SfRangeSelector rangeSelector = new SfRangeSelector(); rangeSelector.Minimum = 0; rangeSelector.Maximum = 10; rangeSelector.RangeStart = 2; rangeSelector.RangeEnd = 8; rangeSelector.Interval = 2; rangeSelector.ShowLabels = true; SfCartesianChart chart = new SfCartesianChart(); rangeSelector.Content = chart;

{% endhighlight %}

{% endtabs %}

RangeSelector labels

Enable ticks

The ShowTicks property enables the ticks in the Range Selector, while the MinorTicksPerInterval property enables the minor ticks between the major ticks.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders" xmlns:charts="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts">

<sliders:SfRangeSelector Minimum="0" 
                         Maximum="10" 
                         RangeStart="2" 
                         RangeEnd="8"                       
                         Interval="2" 
                         ShowLabels="True"
                         ShowTicks="True" 
                         MinorTicksPerInterval="1">
    
    <charts:SfCartesianChart>
        ...
    </charts:SfCartesianChart>

</sliders:SfRangeSelector>

{% endhighlight %}

{% highlight C# %}

SfRangeSelector rangeSelector = new SfRangeSelector(); rangeSelector.Minimum = 0; rangeSelector.Maximum = 10; rangeSelector.RangeStart = 2; rangeSelector.RangeEnd = 8; rangeSelector.Interval = 2; rangeSelector.ShowLabels = true; rangeSelector.ShowTicks = true; rangeSelector.MinorTicksPerInterval = 1; SfCartesianChart chart = new SfCartesianChart(); rangeSelector.Content = chart;

{% endhighlight %}

{% endtabs %}

RangeSelector ticks

Inverse the Range Selector

Invert the Range Selector using the IsInversed property. The default value of the IsInversed property is False.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders" xmlns:charts="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts">

<sliders:SfRangeSelector Minimum="0" 
                         Maximum="10" 
                         RangeStart="2" 
                         RangeEnd="8"
                         Interval="2"
                         ShowLabels="True"
                         ShowTicks="True" 
                         MinorTicksPerInterval="1" 
                         IsInversed="True">

    <charts:SfCartesianChart>
        ...
    </charts:SfCartesianChart>

</sliders:SfRangeSelector>

{% endhighlight %}

{% highlight C# %}

SfRangeSelector rangeSelector = new SfRangeSelector(); rangeSelector.Minimum = 0; rangeSelector.Maximum = 10; rangeSelector.RangeStart = 2; rangeSelector.RangeEnd = 8; rangeSelector.Interval = 2; rangeSelector.ShowLabels = true; rangeSelector.ShowTicks = true; rangeSelector.MinorTicksPerInterval = 1; rangeSelector.IsInversed = true; SfCartesianChart chart = new SfCartesianChart(); rangeSelector.Content = chart;

{% endhighlight %}

{% endtabs %}

Inverse rangeselector

Formatting labels

Add prefix or suffix to the labels using the NumberFormat property.

{% tabs %}

{% highlight xaml %}

<ContentPage ... xmlns:sliders="clr-namespace:Syncfusion.Maui.Sliders;assembly=Syncfusion.Maui.Sliders" xmlns:charts="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts">

<sliders:SfRangeSelector Minimum="20" 
                         Maximum="100" 
                         RangeStart="40" 
                         RangeEnd="80"
                         Interval="20"
                         ShowLabels="True"
                         NumberFormat="$#" 
                         ShowTicks="True">
    
    <charts:SfCartesianChart>
        ...
    </charts:SfCartesianChart>

</sliders:SfRangeSelector>

{% endhighlight %}

{% highlight C# %}

SfRangeSelector rangeSelector = new SfRangeSelector(); rangeSelector.Minimum = 20; rangeSelector.Maximum = 100; rangeSelector.RangeStart = 40; rangeSelector.RangeEnd = 80; rangeSelector.ShowLabels = true; rangeSelector.ShowTicks = true; rangeSelector.Interval = 20; rangeSelector.NumberFormat = "$#"; SfCartesianChart chart = new SfCartesianChart(); rangeSelector.Content = chart;

{% endhighlight %}

{% endtabs %}

RangeSelector label format

N> You can refer to our .NET MAUI Range Selector feature tour page for its groundbreaking feature representations. You can also explore our .NET MAUI Range Selector Example that shows you how to render the Range Selector in .NET MAUI.