Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,37 @@
# SfSpellChecker control samples

This repository contains the samples that demonstrate the functionalities of SfSpellChecker.
This repository contains the samples that demonstrate the functionalities of **Syncfusion WPF SfSpellChecker** control. SfSpellChecker provides spell-checking capabilities for text-based controls in WPF applications.

## Samples in this Repository

<table>
<tr>
<td><a href="Samples/SfSpellChecker">SfSpellChecker options</a></td>
<td><a href="Samples/CustomSpellCheck">Custom Dictionary</a></td>
<td><a href="Samples/Themes">Themes</a></td>
<tr>
<td><a href="Samples/SfSpellChecker">SfSpellChecker options</a></td>
<td><a href="Samples/CustomSpellCheck">Custom Dictionary</a></td>
<td><a href="Samples/Themes">Themes</a></td>
</tr>
</table>

## Explanation of Samples
- **SfSpellChecker Options**: Demonstrates the basic features of SfSpellChecker, including enabling spell-checking for text boxes and rich text controls. It shows how to configure language dictionaries, ignore case, and manage spelling suggestions.

- **Custom Dictionary**: Explains how to add custom words to the dictionary to prevent them from being flagged as errors. This is useful for domain-specific terms or brand names. You can load custom dictionaries from external files or add words programmatically.

- **Themes**: Illustrates how to apply Syncfusion themes to SfSpellChecker for a consistent look and feel across your application. Themes like Office, Metro, and Fluent are supported.

## Key Features
- **Real-Time Spell Checking**: Highlights misspelled words as you type.
- **Context Menu Suggestions**: Provides correction suggestions via right-click.
- **Custom Dictionary Support**: Add or remove words to tailor spell-checking to your needs.
- **MVVM Friendly**: Fully supports data binding and command patterns.

## Documentation
- [Getting Started with SfSpellChecker](https://help.syncfusion.com/wpf/spellchecker/getting-started)
- [Custom Dictionary Support](https://help.syncfusion.com/wpf/spellchecker/custom-dictionary-support)
- [Appearance and Themes](https://help.syncfusion.com/wpf/spellchecker/appearance)

---

### Requirements
Ensure that the **Syncfusion.Shared.WPF** assembly is referenced in your WPF application to use the SfSpellChecker control successfully.