Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.Toolkit Assembly / Xceed.Wpf.Toolkit Namespace / ITextFormatter Interface
Example


In This Topic
    ITextFormatter Interface
    In This Topic
    Provides an interface for formatting text in the RichTextBox.
    Syntax
    'Declaration
 

    Public Interface ITextFormatter 
    'Usage
 

    Dim instance As ITextFormatter
    public interface ITextFormatter
    Public Methods
     NameDescription
    MethodGetTextReturns the formatted text of the passed FlowDocument.  
    MethodSetTextSets the content of the passed FlowDocument.  
    Top
    Remarks

    The RichTextBox control uses text formatters to allow a user to format the content of the RichTextBox control into any format of their choice. Three text formatters are included: PlainTextFormatter, RtfFormatter, and XamlFormatter. The RtfFormatter is the default text formatter. A user can create their own custom text formatter by creating a class that inherits from ITextFormatter and implementing its members accordlingly.

    Example
    The following shows an example of implementing the ITextFormatter interface.The following shows how to use a custom ITextFormatter-derived class.
    public class MyFormatter : ITextFormatter
{
        public string GetText(System.Windows.Documents.FlowDocument document)
        {
            return new TextRange(document.ContentStart, document.ContentEnd).Text;
        }

        public void SetText(System.Windows.Documents.FlowDocument document, string text)
        {
            new TextRange(document.ContentStart, document.ContentEnd).Text = text;
        }
 }
    <xctk:RichTextBox x:Name="_richTextBox" Grid.Row="1" Margin="10" BorderBrush="Gray" Padding="10"
                                     Text="{Binding Notes}" 
                                     ScrollViewer.VerticalScrollBarVisibility="Auto">
            <xctk:RichTextBox.TextFormatter>
                <myCustomFormatter:MyFormatter />
            </xctk:RichTextBox.TextFormatter>
</xctk:RichTextBox>
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    ITextFormatter Members
    Xceed.Wpf.Toolkit Namespace

    Send Feedback