Чтобы выполнить привязку данных Document в WPF RichtextBox, я до сих пор видел 2 решения, которые должны быть производными от RichtextBox и добавить DependencyProperty, а также решение с «прокси».
Ни первое, ни второе неудовлетворительны. Кто-нибудь знает другое решение или вместо этого коммерческий элемент управления RTF, который поддерживает DataBinding? Обычный TextBox не альтернатива, так как нам нужно форматирование текста.
Любая идея?





Создайте UserControl с RichTextBox с именем RTB. Теперь добавьте следующее свойство зависимости:
public FlowDocument Document
{
get { return (FlowDocument)GetValue(DocumentProperty); }
set { SetValue(DocumentProperty, value); }
}
public static readonly DependencyProperty DocumentProperty =
DependencyProperty.Register("Document", typeof(FlowDocument), typeof(RichTextBoxControl), new PropertyMetadata(OnDocumentChanged));
private static void OnDocumentChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
RichTextBoxControl control = (RichTextBoxControl) d;
FlowDocument document = e.NewValue as FlowDocument;
if (document == null)
{
control.RTB.Document = new FlowDocument(); //Document is not amused by null :)
}
else
{
control.RTB.Document = document;
}
}
Это решение, вероятно, является тем "прокси" решением, которое вы где-то видели ... Однако ... RichTextBox просто не имеет Document как DependencyProperty ... Так что вам нужно сделать это по-другому ...
HTH
Я могу дать вам хорошее решение, и вы можете с ним согласиться, но прежде я попытаюсь объяснить, почему Document - это нетDependencyProperty.
В течение срока службы элемента управления RichTextBox свойство Document обычно не изменяется. RichTextBox инициализируется с помощью FlowDocument. Этот документ отображается, его можно редактировать и искажать разными способами, но базовое значение свойства Document остается тем единственным экземпляром FlowDocument. Следовательно, на самом деле нет причин, по которым это должен быть DependencyProperty, то есть Bindable. Если у вас есть несколько местоположений, которые ссылаются на этот FlowDocument, вам потребуется только один раз. Поскольку это везде один и тот же экземпляр, изменения будут доступны каждому.
Я не думаю, что FlowDocument поддерживает уведомления об изменении документов, хотя я не уверен.
При этом вот решение. Прежде чем вы начнете, поскольку RichTextBox не реализует INotifyPropertyChanged, а Document не является DependencyProperty, у нас нет уведомлений при изменении свойства Document RichTextBox, поэтому привязка может быть только OneWay.
Создайте класс, который предоставит FlowDocument. Связывание требует наличия DependencyProperty, поэтому этот класс наследуется от DependencyObject.
class HasDocument : DependencyObject
{
public static readonly DependencyProperty DocumentProperty =
DependencyProperty.Register("Document",
typeof(FlowDocument),
typeof(HasDocument),
new PropertyMetadata(new PropertyChangedCallback(DocumentChanged)));
private static void DocumentChanged(DependencyObject obj, DependencyPropertyChangedEventArgs e)
{
Debug.WriteLine("Document has changed");
}
public FlowDocument Document
{
get { return GetValue(DocumentProperty) as FlowDocument; }
set { SetValue(DocumentProperty, value); }
}
}
Создайте Window с полем форматированного текста в XAML.
<Window x:Class = "samples.Window1"
xmlns = "http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x = "http://schemas.microsoft.com/winfx/2006/xaml"
Title = "Flow Document Binding" Height = "300" Width = "300"
>
<Grid>
<RichTextBox Name = "richTextBox" />
</Grid>
</Window>
Дайте Window поле типа HasDocument.
HasDocument hasDocument;
Конструктор окна должен создать привязку.
hasDocument = new HasDocument();
InitializeComponent();
Binding b = new Binding("Document");
b.Source = richTextBox;
b.Mode = BindingMode.OneWay;
BindingOperations.SetBinding(hasDocument, HasDocument.DocumentProperty, b);
Если вы хотите иметь возможность объявлять привязку в XAML, вам нужно сделать свой класс HasDocument производным от FrameworkElement, чтобы его можно было вставить в логическое дерево.
Теперь, если вы измените свойство Document на HasDocument, Document текстового поля также изменится.
FlowDocument d = new FlowDocument();
Paragraph g = new Paragraph();
Run a = new Run();
a.Text = "I showed this using a binding";
g.Inlines.Add(a);
d.Blocks.Add(g);
hasDocument.Document = d;
+1 за хороший ответ, но одна придирка: есть причина сделать свойство Document свойством зависимости - для облегчения использования элемента управления с шаблоном MVVM.
Справедливо, но я не согласен; Тот факт, что MVVM широко используется в приложениях WPF, не означает, что API WPF следует изменять только для того, чтобы приспособиться к нему. Мы работаем над этим любым возможным способом. Это одно из решений. Мы также можем просто инкапсулировать наше текстовое поле Rich Text Box в пользовательский элемент управления и иметь свойство зависимости, определенное в UserControl.
Есть способ намного проще!
Вы можете легко создать прикрепленное свойство DocumentXaml (или DocumentRTF), которое позволит вам связать документ RichTextBox. Он используется следующим образом, где Autobiography - строковое свойство в вашей модели данных:
<TextBox Text = "{Binding FirstName}" />
<TextBox Text = "{Binding LastName}" />
<RichTextBox local:RichTextBoxHelper.DocumentXaml = "{Binding Autobiography}" />
Вуаля! Полностью связываемые данные RichTextBox!
Реализация этого свойства довольно проста: когда свойство установлено, загрузите XAML (или RTF) в новый FlowDocument. При изменении FlowDocument обновите значение свойства.
Этот код должен помочь:
using System.IO;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
public class RichTextBoxHelper : DependencyObject
{
public static string GetDocumentXaml(DependencyObject obj)
{
return (string)obj.GetValue(DocumentXamlProperty);
}
public static void SetDocumentXaml(DependencyObject obj, string value)
{
obj.SetValue(DocumentXamlProperty, value);
}
public static readonly DependencyProperty DocumentXamlProperty =
DependencyProperty.RegisterAttached(
"DocumentXaml",
typeof(string),
typeof(RichTextBoxHelper),
new FrameworkPropertyMetadata
{
BindsTwoWayByDefault = true,
PropertyChangedCallback = (obj, e) =>
{
var richTextBox = (RichTextBox)obj;
// Parse the XAML to a document (or use XamlReader.Parse())
var xaml = GetDocumentXaml(richTextBox);
var doc = new FlowDocument();
var range = new TextRange(doc.ContentStart, doc.ContentEnd);
range.Load(new MemoryStream(Encoding.UTF8.GetBytes(xaml)),
DataFormats.Xaml);
// Set the document
richTextBox.Document = doc;
// When the document changes update the source
range.Changed += (obj2, e2) =>
{
if (richTextBox.Document == doc)
{
MemoryStream buffer = new MemoryStream();
range.Save(buffer, DataFormats.Xaml);
SetDocumentXaml(richTextBox,
Encoding.UTF8.GetString(buffer.ToArray()));
}
};
}
});
}
Тот же код можно использовать для TextFormats.RTF или TextFormats.XamlPackage. Для XamlPackage у вас будет свойство типа byte[] вместо string.
Формат XamlPackage имеет несколько преимуществ по сравнению с обычным XAML, особенно возможность включать такие ресурсы, как изображения, и он более гибкий и простой в работе, чем RTF.
Трудно поверить, что этот вопрос задавался в течение 15 месяцев, и никто не указал на простой способ сделать это.
Если у вас есть несколько RichTextBox в одном окне, это решение не сработает.
@Kelly, используйте DataFormats.Rtf, это может решить проблему с множеством richtextboxes.
Двусторонний у меня не работает (с использованием Rtf). Событие range.Changed никогда не вызывается.
@FabianBigler - Привет - на случай, если у кого-то возникнет такая же проблема - вам нужно добавить объявление xmlns: local в ваш файл xaml, который будет указывать на пространство имен, где это доступно
может кто-нибудь привести пример ценности Автобиографии?
@longlostbro, вот это пример значения: gist.github.com/bakulev/614a665241cc4fd69409e1ab3e03a9ba
@AntonBakulev Спасибо!
Строка поддержки (Autobiography) в виртуальной машине должна быть FlowDocument в формате xml. Например: <FlowDocument xmlns = "http://schemas.microsoft.com/winfx/2006/xaml/presentation"><Paragraph Foreground = "Red"><Bold>Hello</Bold></Paragraph></FlowDocument>
Я немного доработал предыдущий код. Во-первых, range.Changed у меня не работает. После того, как я изменил range.Changed на richTextBox.TextChanged, оказалось, что обработчик событий TextChanged может рекурсивно вызывать SetDocumentXaml, поэтому я обеспечил защиту от него. Я также использовал XamlReader / XamlWriter вместо TextRange.
public class RichTextBoxHelper : DependencyObject
{
private static HashSet<Thread> _recursionProtection = new HashSet<Thread>();
public static string GetDocumentXaml(DependencyObject obj)
{
return (string)obj.GetValue(DocumentXamlProperty);
}
public static void SetDocumentXaml(DependencyObject obj, string value)
{
_recursionProtection.Add(Thread.CurrentThread);
obj.SetValue(DocumentXamlProperty, value);
_recursionProtection.Remove(Thread.CurrentThread);
}
public static readonly DependencyProperty DocumentXamlProperty = DependencyProperty.RegisterAttached(
"DocumentXaml",
typeof(string),
typeof(RichTextBoxHelper),
new FrameworkPropertyMetadata(
"",
FrameworkPropertyMetadataOptions.AffectsRender | FrameworkPropertyMetadataOptions.BindsTwoWayByDefault,
(obj, e) => {
if (_recursionProtection.Contains(Thread.CurrentThread))
return;
var richTextBox = (RichTextBox)obj;
// Parse the XAML to a document (or use XamlReader.Parse())
try
{
var stream = new MemoryStream(Encoding.UTF8.GetBytes(GetDocumentXaml(richTextBox)));
var doc = (FlowDocument)XamlReader.Load(stream);
// Set the document
richTextBox.Document = doc;
}
catch (Exception)
{
richTextBox.Document = new FlowDocument();
}
// When the document changes update the source
richTextBox.TextChanged += (obj2, e2) =>
{
RichTextBox richTextBox2 = obj2 as RichTextBox;
if (richTextBox2 != null)
{
SetDocumentXaml(richTextBox, XamlWriter.Save(richTextBox2.Document));
}
};
}
)
);
}
Спасибо, Лоло! У меня тоже были проблемы с исходным классом. Это исправило это для меня. Огромная экономия времени!
Я обнаружил небольшую проблему с этим решением. Можно установить ловушку для TextChanged несколько раз, если представление не закрывается и не создается заново между вызовами. Я создаю единое представление один раз и загружаю его через выбор списка. Чтобы исправить это, я создал более типичный метод перехвата события TextChanged. Затем я просто отцепляю метод, прежде чем подключать его. Это гарантирует, что он будет зацеплен только один раз. Больше никаких утечек памяти (и больше никакого медленно работающего кода).
Это хорошее рабочее решение, однако, по моему опыту, оно не работает с несколькими элементами управления, см. Мой отвечать.
Это здорово, спасибо. Я предполагаю, что не работает, если вы хотите установить привязку программно, потому что поток, устанавливающий привязку, отличается от того, который устанавливается через XAML. Поэтому мне пришлось добавить метод SetDocumentXamlFirst, который не использует защиту от рекурсии и будет вызываться только вручную, когда вы впервые захотите установить значение.
Строка поддержки в виртуальной машине должна быть FlowDocument в формате xml, иначе загрузка не удастся. Например: <FlowDocument xmlns = "http://schemas.microsoft.com/winfx/2006/xaml/presentation"><Paragraph Foreground = "Red"><Bold>Hello</Bold></Paragraph></FlowDocument>
Вот версия ответа Лоло на VB.Net:
Public Class RichTextBoxHelper
Inherits DependencyObject
Private Shared _recursionProtection As New HashSet(Of System.Threading.Thread)()
Public Shared Function GetDocumentXaml(ByVal depObj As DependencyObject) As String
Return DirectCast(depObj.GetValue(DocumentXamlProperty), String)
End Function
Public Shared Sub SetDocumentXaml(ByVal depObj As DependencyObject, ByVal value As String)
_recursionProtection.Add(System.Threading.Thread.CurrentThread)
depObj.SetValue(DocumentXamlProperty, value)
_recursionProtection.Remove(System.Threading.Thread.CurrentThread)
End Sub
Public Shared ReadOnly DocumentXamlProperty As DependencyProperty = DependencyProperty.RegisterAttached("DocumentXaml", GetType(String), GetType(RichTextBoxHelper), New FrameworkPropertyMetadata("", FrameworkPropertyMetadataOptions.AffectsRender Or FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, Sub(depObj, e)
RegisterIt(depObj, e)
End Sub))
Private Shared Sub RegisterIt(ByVal depObj As System.Windows.DependencyObject, ByVal e As System.Windows.DependencyPropertyChangedEventArgs)
If _recursionProtection.Contains(System.Threading.Thread.CurrentThread) Then
Return
End If
Dim rtb As RichTextBox = DirectCast(depObj, RichTextBox)
Try
rtb.Document = Markup.XamlReader.Parse(GetDocumentXaml(rtb))
Catch
rtb.Document = New FlowDocument()
End Try
' When the document changes update the source
AddHandler rtb.TextChanged, AddressOf TextChanged
End Sub
Private Shared Sub TextChanged(ByVal sender As Object, ByVal e As TextChangedEventArgs)
Dim rtb As RichTextBox = TryCast(sender, RichTextBox)
If rtb IsNot Nothing Then
SetDocumentXaml(sender, Markup.XamlWriter.Save(rtb.Document))
End If
End Sub
Конец класса
Эта версия VB.Net работает в моей ситуации. Я удалил семафор коллекции потоков, вместо этого используя RemoveHandler и AddHandler. Кроме того, поскольку FlowDocument может быть привязан только к одному RichTextBox за раз, я проверил, что IsLoaded = True для RichTextBox. Начнем с того, как я использовал класс в приложении MVVM, которое использует ResourceDictionary вместо Window.
' Loaded and Unloaded events seems to be the only way to initialize a control created from a Resource Dictionary
' Loading document here because Loaded is the last available event to create a document
Private Sub Rtb_Loaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
' only good place to initialize RichTextBox.Document with DependencyProperty
Dim rtb As RichTextBox = DirectCast(sender, RichTextBox)
Try
rtb.Document = RichTextBoxHelper.GetDocumentXaml(rtb)
Catch ex As Exception
Debug.WriteLine("Rtb_Loaded: Message:" & ex.Message)
End Try
End Sub
' Loaded and Unloaded events seems to be the only way to initialize a control created from a Resource Dictionary
' Free document being held by RichTextBox.Document by assigning New FlowDocument to RichTextBox.Document. Otherwise we'll see an of "Document belongs to another RichTextBox"
Private Sub Rtb_Unloaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
Dim rtb As RichTextBox = DirectCast(sender, RichTextBox)
Dim fd As New FlowDocument
RichTextBoxHelper.SetDocumentXaml(rtb, fd)
Try
rtb.Document = fd
Catch ex As Exception
Debug.WriteLine("PoemDocument.PoemDocumentView.PoemRtb_Unloaded: Message:" & ex.Message)
End Try
End Sub
Public Class RichTextBoxHelper
Inherits DependencyObject
Public Shared Function GetDocumentXaml(ByVal depObj As DependencyObject) As FlowDocument
Return depObj.GetValue(DocumentXamlProperty)
End Function
Public Shared Sub SetDocumentXaml(ByVal depObj As DependencyObject, ByVal value As FlowDocument)
depObj.SetValue(DocumentXamlProperty, value)
End Sub
Public Shared ReadOnly DocumentXamlProperty As DependencyProperty = DependencyProperty.RegisterAttached("DocumentXaml", GetType(FlowDocument), GetType(RichTextBoxHelper), New FrameworkPropertyMetadata(Nothing, FrameworkPropertyMetadataOptions.AffectsRender Or FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, Sub(depObj, e)
RegisterIt(depObj, e)
End Sub))
Private Shared Sub RegisterIt(ByVal depObj As System.Windows.DependencyObject, ByVal e As System.Windows.DependencyPropertyChangedEventArgs)
Dim rtb As RichTextBox = DirectCast(depObj, RichTextBox)
If rtb.IsLoaded Then
RemoveHandler rtb.TextChanged, AddressOf TextChanged
Try
rtb.Document = GetDocumentXaml(rtb)
Catch ex As Exception
Debug.WriteLine("RichTextBoxHelper.RegisterIt: ex:" & ex.Message)
rtb.Document = New FlowDocument()
End Try
AddHandler rtb.TextChanged, AddressOf TextChanged
Else
Debug.WriteLine("RichTextBoxHelper: Unloaded control ignored:" & rtb.Name)
End If
End Sub
' When a RichTextBox Document changes, update the DependencyProperty so they're in sync.
Private Shared Sub TextChanged(ByVal sender As Object, ByVal e As TextChangedEventArgs)
Dim rtb As RichTextBox = TryCast(sender, RichTextBox)
If rtb IsNot Nothing Then
SetDocumentXaml(sender, rtb.Document)
End If
End Sub
End Class
Я знаю, что это старый пост, но посмотрите Расширенный набор инструментов WPF. Он имеет RichTextBox, который поддерживает то, что вы пытаетесь делать.
RichTextBox из Extended WPF Toolkit очень медленный, я бы не рекомендовал его.
@ViktorLaCroix, вы же понимаете, что это всего лишь WPF RichTextBox с дополнительным свойством, верно?
(переходите к 2017 году ...) Наборы инструментов wpf RichTextBox сразу после установки работает с форматированным или обычным текстом. Это также кажется намного быстрее, чем использование вспомогательного метода ниже (который вызывает исключение, если вы просто скопируете / вставите его)
Их бесплатная лицензия предназначена только для некоммерческого использования. : /
Почему бы просто не использовать FlowDocumentScrollViewer?
Это настоящий ответ.
Вы не можете редактировать текст в FlowDocumentScrollViewer
Ребята, зачем вообще заморачиваться. Это прекрасно работает. Код не требуется
<RichTextBox>
<FlowDocument>
<Paragraph>
<Run Text = "{Binding Mytextbinding}"/>
</Paragraph>
</FlowDocument>
</RichTextBox>
В моем случае это не работает без тега FlowDocument.
Свойство Text для Run не является свойством зависимости, поэтому оно даже не компилируется. Только свойства зависимости поддерживают такую привязку.
Это было именно то, что мне нужно.
<RichTextBox>
<FlowDocument PageHeight = "180">
<Paragraph>
<Run Text = "{Binding Text, Mode=TwoWay}"/>
</Paragraph>
</FlowDocument>
</RichTextBox>
На данный момент это самый простой способ, и он не отображается ни в одном из этих ответов.
В модели представления просто есть переменная Text.
В моем случае это решение показывает текст свойства Text в модели представления по вертикали, то есть по одному для каждой строки.
Это все, что мне нужно. Спасибо!
Чем это решение отличается от обычного TextBox, привязанного к свойству Text? Это противоречит цели поддержки форматирования поля форматированного текста, которое эффективно отключается с помощью этого кода.
Это было идеально для меня. Чем проще, тем лучше!
Большинство моих потребностей были удовлетворены этим ответом https://stackoverflow.com/a/2989277/3001007 by Кшиштоф. Но с этим кодом возникла одна проблема (с которой я столкнулся): привязка не будет работать с несколькими элементами управления. Поэтому я заменил _recursionProtection реализацией на основе Guid. Таким образом, он работает и для нескольких элементов управления в одном окне.
public class RichTextBoxHelper : DependencyObject
{
private static List<Guid> _recursionProtection = new List<Guid>();
public static string GetDocumentXaml(DependencyObject obj)
{
return (string)obj.GetValue(DocumentXamlProperty);
}
public static void SetDocumentXaml(DependencyObject obj, string value)
{
var fw1 = (FrameworkElement)obj;
if (fw1.Tag == null || (Guid)fw1.Tag == Guid.Empty)
fw1.Tag = Guid.NewGuid();
_recursionProtection.Add((Guid)fw1.Tag);
obj.SetValue(DocumentXamlProperty, value);
_recursionProtection.Remove((Guid)fw1.Tag);
}
public static readonly DependencyProperty DocumentXamlProperty = DependencyProperty.RegisterAttached(
"DocumentXaml",
typeof(string),
typeof(RichTextBoxHelper),
new FrameworkPropertyMetadata(
"",
FrameworkPropertyMetadataOptions.AffectsRender | FrameworkPropertyMetadataOptions.BindsTwoWayByDefault,
(obj, e) =>
{
var richTextBox = (RichTextBox)obj;
if (richTextBox.Tag != null && _recursionProtection.Contains((Guid)richTextBox.Tag))
return;
// Parse the XAML to a document (or use XamlReader.Parse())
try
{
string docXaml = GetDocumentXaml(richTextBox);
var stream = new MemoryStream(Encoding.UTF8.GetBytes(docXaml));
FlowDocument doc;
if (!string.IsNullOrEmpty(docXaml))
{
doc = (FlowDocument)XamlReader.Load(stream);
}
else
{
doc = new FlowDocument();
}
// Set the document
richTextBox.Document = doc;
}
catch (Exception)
{
richTextBox.Document = new FlowDocument();
}
// When the document changes update the source
richTextBox.TextChanged += (obj2, e2) =>
{
RichTextBox richTextBox2 = obj2 as RichTextBox;
if (richTextBox2 != null)
{
SetDocumentXaml(richTextBox, XamlWriter.Save(richTextBox2.Document));
}
};
}
)
);
}
Для полноты картины позвольте мне добавить еще несколько строк из исходного ответа https://stackoverflow.com/a/2641774/3001007 от лучевые ожоги. Вот как использовать помощник.
<RichTextBox local:RichTextBoxHelper.DocumentXaml = "{Binding Autobiography}" />
Вот мое решение, основанное на ответе Рэя Бернса с DataBinding и преобразованием XAML-строки в RichTextBox-Document:
ViewModel
TestText = @"<FlowDocument xmlns = ""http://schemas.microsoft.com/winfx/2006/xaml/presentation""><Paragraph><Bold>Hello World!</Bold></Paragraph></FlowDocument>";
Вид
<RichTextBox local:RichTextBoxHelper.DocumentXaml = "{Binding TestText}"/>
RichTextBoxHelper
public class RichTextBoxHelper : DependencyObject
{
public static string GetDocumentXaml(DependencyObject obj) { return (string) obj.GetValue(DocumentXamlProperty); }
public static void SetDocumentXaml(DependencyObject obj,
string value)
{
obj.SetValue(DocumentXamlProperty, value);
}
public static readonly DependencyProperty DocumentXamlProperty = DependencyProperty.RegisterAttached
(
"DocumentXaml",
typeof(string),
typeof(RichTextBoxHelper),
new FrameworkPropertyMetadata
{
BindsTwoWayByDefault = true,
PropertyChangedCallback = (obj,
e) =>
{
var richTextBox = (RichTextBox) obj;
var xaml = GetDocumentXaml(richTextBox);
Stream sm = new MemoryStream(Encoding.UTF8.GetBytes(xaml));
richTextBox.Document = (FlowDocument) XamlReader.Load(sm);
sm.Close();
}
}
);
}
В последней строке вы используете «документ», который вызывает ошибку в моем коде. Это должен быть экземпляр Document из-за статического метода. Но пример чего? Я устанавливаю документ, который я получаю через DependencyProperty, «Документ». Удаление «статики» нарушает последний аргумент DependencyProperty. Итак, я застрял. Вспомогательный класс сверху тоже не показывает никакого текста :(