Namespace: Consultingwerk.Windows.Controls
Class 
SmartRichTextEditorControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.SmartComponents.Base.SmartUserControl
Consultingwerk.Windows.Controls.SmartRichTextEditorControl

Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISupportsReadOnly, Consultingwerk.SmartComponents.Interfaces.ISupportsValueChangedEvent


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ClearContent () Clears the content of the editor
LONGCHAR ExportHtml () Returns the HTML fragment of the document in the editor
LONGCHAR ExportRtf () Returns the RTF text of the document in the editor
LONGCHAR GetContent () Returns the content of the editor in the format of the TextFormat property
IgnoreHtmlExportProperties (character, character) Adds CSS properties to the properties the HtmlFormatProvider does not export for an HTML element
ImportHtml (longchar) Loads an HTML document or fragment into the editor
ImportRtf (longchar) Loads an RTF text into the editor
InitializeComponent ()
InitializeHtmlFormatProvider () Configures the Telerik HtmlFormatProvider for the exchange with the Kendo UI Editor of the Angular frontend
InsertHyperlink () Inserts a hyperlink at the caret position using the insert hyperlink dialog of the editor
InsertImage () Inserts images at the caret position using a File Open Dialog
InsertImageFromFile (character) Inserts an image file at the caret position of the editor
LOGICAL IsImageFile (character) Returns if the file name refers to an image file
LONGCHAR NormalizeExportedHtml (longchar) Normalizes the HTML the HtmlFormatProvider exported into the fragment stored in the field
LONGCHAR NormalizeImportedHtml (longchar) Normalizes an HTML document or fragment through the HtmlReader and HtmlWriter of the text conversions
OnValueChanged (EventArgs) Raises the ValueChanged event
radRichTextEditor1_CurrentEditingStyleChanged (Object, EventArgs) Event handler for the CurrentEditingStyleChanged event of the radRichTextEditor1 control
radRichTextEditor1_DocumentContentChanged (Object, EventArgs) Event handler for the DocumentContentChanged event of the radRichTextEditor1 control
radRichTextEditor1_DragDrop (Object, DragEventArgs) Event handler for the DragDrop event of the radRichTextEditor1 control
radRichTextEditor1_DragEnter (Object, DragEventArgs) Event handler for the DragEnter event of the radRichTextEditor1 control
SetContent (longchar) Loads the content of the editor in the format of the TextFormat property
SetToolImage (character, character) Assigns the image of a toolbar tool from the IImageProvider service
ToggleFontColor () Applies the font color selected in the toolbar to the selection
ToggleFontFace () Applies the font face selected in the toolbar to the selection
ToggleFontSize () Applies the font size selected in the toolbar to the selection
ToggleFormat (character) Toggles a format of the selection
ToggleList (ListStyle) Turns the paragraphs of the selection into items of a bulleted or numbered list, or back into plain paragraphs when the caret is in a list already
ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs) Event handler for the ToolClick event of the ultraToolbarsManager1
ultraToolbarsManager1_ToolValueChanged (Object, ToolEventArgs) Event handler for the ToolValueChanged event of the ultraToolbarsManager1
UpdateToolbarState () Enables and disables the tools of the format toolbar and the editor based on the ReadOnly property

Top Constructor Summary
Options Name Purpose
SmartRichTextEditorControl () Constructor for the SmartRichTextEditorControl class

Top Event Summary
Options Name Purpose
ValueChanged DELEGATE System.EventHandler Raised when the user has changed the content of the editor

Top Property Summary
Options Name Purpose
LOGICAL ReadOnly
Telerik.WinControls.UI.RadRichTextEditor RichTextEditor
Consultingwerk.Util.TextFormatEnum TextFormat


Method Detail
Top

ClearContent ()
Purpose: Clears the content of the editor
Notes: Does not raise the ValueChanged event

Top

LONGCHAR ExportHtml ()
Purpose: Returns the HTML fragment of the document in the editor
Notes: Exported through the Telerik HtmlFormatProvider as a fragment
with inline styles and base64 embedded images, and normalized
through the HtmlReader / HtmlWriter of the text conversions.
An empty document results in an empty string

Returns LONGCHAR
The HTML fragment as UTF-8 longchar
Top

LONGCHAR ExportRtf ()
Purpose: Returns the RTF text of the document in the editor
Notes: Exports through a MemoryStream, so that the result is a LONGCHAR

Returns LONGCHAR
The RTF text
Top

LONGCHAR GetContent ()
Purpose: Returns the content of the editor in the format of the
TextFormat property
Notes:

Returns LONGCHAR
The content of the editor
Top

IgnoreHtmlExportProperties (character, character)
Purpose: Adds CSS properties to the properties the HtmlFormatProvider
does not export for an HTML element
Notes:

Parameters:
pcElement CHARACTER
The name of the HTML element (p, li, table, ...)
pcProperties CHARACTER
The comma-delimited list of CSS property names
Top

ImportHtml (longchar)
Purpose: Loads an HTML document or fragment into the editor
Notes: The HTML is normalized through the HtmlReader / HtmlWriter of
the text conversions before it is imported, so that constructs
the Telerik HtmlFormatProvider does not read (e.g. the del
element of the Kendo UI Editor) arrive in a form it does.
An empty text results in an empty document. Does not raise the
ValueChanged event

Parameters:
plcHtml LONGCHAR
The HTML text
Top

ImportRtf (longchar)
Purpose: Loads an RTF text into the editor
Notes: An empty text results in an empty document. Does not raise
the ValueChanged event

Parameters:
plcRtf LONGCHAR
The RTF text
Top

InitializeComponent ()

Top

InitializeHtmlFormatProvider ()
Purpose: Configures the Telerik HtmlFormatProvider for the exchange with
the Kendo UI Editor of the Angular frontend
Notes: Export: an HTML fragment (no html, head and body elements) with
inline styles only - no style element, no CSS classes and no
Telerik style metadata -, images embedded as base64 data URIs
and only the properties set locally or through a style, so
that text in the default font carries no font declaration.
Import: the default stylesheet of the editor (Verdana) is used
for text without a font declaration, so that it is exported
without one again

Top

InsertHyperlink ()
Purpose: Inserts a hyperlink at the caret position using the insert
hyperlink dialog of the editor
Notes: The selected text becomes the text of the hyperlink

Top

InsertImage ()
Purpose: Inserts images at the caret position using a File Open Dialog
Notes: Supports inserting multiple files

Top

InsertImageFromFile (character)
Purpose: Inserts an image file at the caret position of the editor
Notes: The image is embedded into the document

Parameters:
pcFileName CHARACTER
The name of the image file
Top

LOGICAL IsImageFile (character)
Purpose: Returns if the file name refers to an image file
Notes: Based on the file extension

Parameters:
pcFileName CHARACTER
The name of the file
Returns LOGICAL
Logical value indicating if the file is an image file
Top

LONGCHAR NormalizeExportedHtml (longchar)
Purpose: Normalizes the HTML the HtmlFormatProvider exported into the
fragment stored in the field
Notes: The provider writes the font of the list marker on every item
of a bulleted list, the color of its hyperlink style on every
hyperlink and the alignment attributes of every table cell -
all of them defaults of the editor, none of them chosen by the
user. Reading them back as explicit formatting would degrade a
field edited alternately on both frontends, so they are removed
with regular expressions on the .NET string (safe for every
Unicode character, unlike INDEX on a LONGCHAR - the LONGCHAR
travels to .NET and back as a System.String). The result is
then read and written by the text conversions, which yields
the canonical fragment of the HtmlWriter

Parameters:
plcHtml LONGCHAR
The HTML the HtmlFormatProvider exported
Returns LONGCHAR
The normalized HTML fragment as UTF-8 longchar
Top

LONGCHAR NormalizeImportedHtml (longchar)
Purpose: Normalizes an HTML document or fragment through the HtmlReader
and HtmlWriter of the text conversions
Notes: The HtmlWriter produces the canonical fragment both the
HtmlFormatProvider and the Kendo UI Editor read - e.g. a del
element of the Kendo UI Editor, which the HtmlFormatProvider
drops together with its text, becomes an s element. Without
the text conversions (DocumentConverter not defined in
products.i) the HTML is returned as it is

Parameters:
plcHtml LONGCHAR
The HTML to normalize
Returns LONGCHAR
The normalized HTML fragment as UTF-8 longchar
Top

OnValueChanged (EventArgs)
Purpose: Raises the ValueChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

radRichTextEditor1_CurrentEditingStyleChanged (Object, EventArgs)
Purpose: Event handler for the CurrentEditingStyleChanged event of the
radRichTextEditor1 control
Notes: Synchronizes the format tools with the style at the caret

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

radRichTextEditor1_DocumentContentChanged (Object, EventArgs)
Purpose: Event handler for the DocumentContentChanged event of the
radRichTextEditor1 control
Notes: Raises the ValueChanged event, unless the content is loaded

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

radRichTextEditor1_DragDrop (Object, DragEventArgs)
Purpose: Event handler for the DragDrop event of the radRichTextEditor1 control
Notes: Inserts dropped image files into the document

Parameters:
sender System.Object
The reference to the sending Control
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

radRichTextEditor1_DragEnter (Object, DragEventArgs)
Purpose: Event handler for the DragEnter event of the radRichTextEditor1 control
Notes:

Parameters:
sender System.Object
The reference to the sending Control
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

SetContent (longchar)
Purpose: Loads the content of the editor in the format of the
TextFormat property
Notes: An empty or unknown value results in an empty document. Does
not raise the ValueChanged event

Parameters:
plcContent LONGCHAR
The content to load into the editor
Top

SetToolImage (character, character)
Purpose: Assigns the image of a toolbar tool from the IImageProvider service
Notes:

Parameters:
pcToolKey CHARACTER
The key of the tool
pcImageKey CHARACTER
The key of the image
Top

ToggleFontColor ()
Purpose: Applies the font color selected in the toolbar to the selection
Notes:

Top

ToggleFontFace ()
Purpose: Applies the font face selected in the toolbar to the selection
Notes:

Top

ToggleFontSize ()
Purpose: Applies the font size selected in the toolbar to the selection
Notes: The toolbar shows the size in points, the editor uses
device independent pixels

Top

ToggleFormat (character)
Purpose: Toggles a format of the selection
Notes:

Parameters:
pcFormat CHARACTER
The format (Bold, Italic, Underline, Strikethrough) to toggle
Top

ToggleList (ListStyle)
Purpose: Turns the paragraphs of the selection into items of a bulleted
or numbered list, or back into plain paragraphs when the caret
is in a list already
Notes:

Parameters:
poListStyle Telerik.WinForms.Documents.Model.ListStyle
The Telerik ListStyle to apply (DefaultListStyles:Bulleted or DefaultListStyles:Numbered)
Top

ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick event of the ultraToolbarsManager1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event
Top

ultraToolbarsManager1_ToolValueChanged (Object, ToolEventArgs)
Purpose: Event handler for the ToolValueChanged event of the ultraToolbarsManager1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinToolbars.ToolEventArgs
The ToolEventArgs with the data for this event
Top

UpdateToolbarState ()
Purpose: Enables and disables the tools of the format toolbar and the
editor based on the ReadOnly property
Notes:



Constructor Detail
Top

SmartRichTextEditorControl ()
Purpose: Constructor for the SmartRichTextEditorControl class
Notes:



Event Detail
Top

ValueChanged DELEGATE System.EventHandler
Purpose: Raised when the user has changed the content of the editor
Notes: Not raised while content is loaded through SetContent,
ImportRtf or ClearContent. Enforced by the interface
ISupportsValueChangedEvent

Delegate: System.EventHandler


Property Detail
Top

LOGICAL ReadOnly

Returns LOGICAL
Top

Telerik.WinControls.UI.RadRichTextEditor RichTextEditor

Returns Telerik.WinControls.UI.RadRichTextEditor
Top

Consultingwerk.Util.TextFormatEnum TextFormat

Returns Consultingwerk.Util.TextFormatEnum


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:21:03