IRichTextValueStorage Interface

Declares members of the Rich Text editor’s value storage.

Namespace: DevExpress.ExpressApp.Office.Win

Assembly: DevExpress.ExpressApp.Office.Win.v21.2.dll

NuGet Package: DevExpress.ExpressApp.Office.Win

Declaration

C#

public interface IRichTextValueStorage

VB.NET

Public Interface IRichTextValueStorage

Remarks

A Rich Text editor’s value storage allows you to implement custom logic executed when saving or loading a RichText document. Follow the steps below to create a custom value storage that overrides a file storage format.

1. In the WinForms Module project, create a class that implements the IRichTextValueStorage interface as shown below:

   C#

   using DevExpress.ExpressApp.Office.Win;
   using DevExpress.XtraRichEdit;
   //..
   public class MhtRichTextValueStorage : IRichTextValueStorage {
       public object GetValue(RichEditControl control) {
           return control.MhtText;
       }
       public void SetValue(RichEditControl control, object propertyValue) {
           control.MhtText = (string)propertyValue;
       }
   }
   

   VB.NET

   Imports DevExpress.ExpressApp.Office.Win
   Imports DevExpress.XtraRichEdit
   ' ...
   Public Class MhtRichTextValueStorage
       Implements IRichTextValueStorage
       Public Function GetValue(ByVal control As RichEditControl) As Object _
       Implements IRichTextValueStorage.GetValue
           Return control.MhtText
       End Function
       Public Sub SetValue(ByVal control As RichEditControl, ByVal propertyValue As Object) _
       Implements IRichTextValueStorage.SetValue
           control.MhtText = DirectCast(propertyValue, String)
       End Sub
   End Class
   

2. Create a View Controller and access the RichTextPropertyEditor as described in the Ways to Access UI Elements and Their Controls topic. Set the editor’s ValueStorage property to an instance of CustomRichTextValueStorage as shown below:

   C#

   using DevExpress.ExpressApp;
   using DevExpress.ExpressApp.Office.Win;
   // ...
   public class RichTextValueStorageController : ObjectViewController<DetailView, Document> {
       protected override void OnActivated() {
           base.OnActivated();
           RichTextPropertyEditor richTextPropertyEditor = View.FindItem("Text") as RichTextPropertyEditor;
           if (richTextPropertyEditor != null) {
               richTextPropertyEditor.ValueStorage = new MhtRichTextValueStorage();
           }
       }
   }
   

   VB.NET

   Imports DevExpress.ExpressApp
   Imports DevExpress.ExpressApp.Office.Win
   ' ...
   Public Class RichTextValueStorageController
     Inherits ObjectViewController(Of DetailView, Document)
     Protected Overrides Sub OnActivated()
       MyBase.OnActivated()
       Dim richTextPropertyEditor As RichTextPropertyEditor = TryCast(View.FindItem("Text"), RichTextPropertyEditor)
       If richTextPropertyEditor IsNot Nothing Then
         richTextPropertyEditor.ValueStorage = New MhtRichTextValueStorage()
       End If
     End Sub
   End Class