Skip to content

Commit c54115a

Browse files
Choza-rajanChoza-rajan
authored
Merge pull request #3596 from syncfusion-content/Tools-UG-Rich-text-editor
Update Migrated APIs from Xamarin in Migration Page
2 parents 88098ea + d9c341d commit c54115a

File tree

2 files changed

+149
-19
lines changed

2 files changed

+149
-19
lines changed

‎MAUI/Rich-Text-Editor/Migration.md‎

Lines changed: 149 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,162 @@ documentation: ug
99

1010
# Migrating from Xamarin RichTextEditor to .NET MAUI RichTextEditor
1111

12-
To migrate easily from [`Xamarin SfRichTextEditor`](https://help.syncfusion.com/cr/xamarin/Syncfusion.SfRichTextEditor.XForms.SfRichTextEditor.html) to [`.NET MAUI SfRichTextEditor`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.RichTextEditor.SfRichTextEditor.html?tabs=tabid-1), we kept all the APIs from Xamarin SfRichTextEditor in MAUI SfRichTextEditor. However, to maintain the consistency of API naming in MAUI SfRichTextEditor, we renamed some of the APIs. The APIs that have been changed in MAUI SfRichTextEditor from Xamarin SfRichTextEditor are detailed as follows.
12+
To migrate easily from [`Xamarin SfRichTextEditor`](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.html) to `.NET MAUI SfRichTextEditor`, we kept all the APIs from Xamarin SfRichTextEditor in MAUI SfRichTextEditor. However, to maintain the consistency of API naming in MAUI SfRichTextEditor, we renamed some of the APIs. The APIs that have been changed in MAUI SfRichTextEditor from Xamarin SfRichTextEditor are detailed as follows.
1313

1414
## Namespaces
1515

1616
<table>
17-
<tr>
18-
<th>Xamarin SfRichTextEditor</th>
19-
<th>.NET MAUI SfRichTextEditor</th></tr>
20-
<tr>
21-
<td>Syncfusion.RichTextEditor.XForms</td>
22-
<td>Syncfusion.Maui.RichTextEditor</td></tr>
17+
<tr>
18+
<th>Xamarin SfRichTextEditor</th>
19+
<th>.NET MAUI SfRichTextEditor</th>
20+
</tr>
21+
<tr>
22+
<td>Syncfusion.RichTextEditor.XForms</td>
23+
<td>Syncfusion.Maui.RichTextEditor</td>
24+
</tr>
2325
</table>
2426

2527
## Properties
2628

2729
<table>
28-
<tr>
29-
<th>Xamarin SfRichTextEditor</th>
30-
<th>.NET MAUI SfRichTextEditor</th>
31-
<th>Description</th></tr>
32-
<tr>
33-
<td>{{'[AutoSize](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_AutoSize)'| markdownify }}</td>
34-
35-
https://helpstaging.syncfusion.com/xamarin/rich-text-editor/autosize
36-
<td>EnableAutoSize</td>
37-
<td>Gets or sets the value of AutoSize.
38-
</td></tr>
30+
<tr>
31+
<th>Xamarin SfRichTextEditor</th>
32+
<th>.NET MAUI SfRichTextEditor</th>
33+
<th>Description</th>
34+
</tr>
35+
<tr>
36+
<td>{{'[AutoSize](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_AutoSize)'| markdownify }}</td>
37+
<td>EnableAutoSize</td>
38+
<td>Gets or sets a value indicating whether the editor should automatically resize based on its content.</td>
39+
</tr>
40+
<tr>
41+
<td>{{'[BackgroundColor](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_BackgroundColor)'| markdownify }}</td>
42+
<td>EditorBackgroundColor</td>
43+
<td>Gets or sets the background color of the editor's content area.</td>
44+
</tr>
45+
<tr>
46+
<td>{{'[DefaultFont](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_DefaultFont)'| markdownify }}</td>
47+
<td>DefaultFontFamily</td>
48+
<td>Gets or sets the default font family.</td>
49+
</tr>
50+
<tr>
51+
<td>{{'[DefaultFontColor](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_DefaultFontColor)'| markdownify }}</td>
52+
<td>DefaultTextColor</td>
53+
<td>Gets or sets the default text color.</td>
54+
</tr>
55+
<tr>
56+
<td>{{'[PlaceHolder](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_PlaceHolder)'| markdownify }}</td>
57+
<td>Placeholder</td>
58+
<td>Gets or sets the placeholder text that is displayed when the editor is empty.</td>
59+
</tr>
60+
<tr>
61+
<td>{{'[PlaceHolderFontColor](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_PlaceHolderFontColor)'| markdownify }}</td>
62+
<td>PlaceholderColor</td>
63+
<td>Gets or sets the value for place holder font color.</td>
64+
</tr>
65+
<tr>
66+
<td>{{'[PlaceHolderFontFamily](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_PlaceHolderFontFamily)'| markdownify }}</td>
67+
<td>PlaceholderFontFamily</td>
68+
<td>Gets or sets the value for place holder font family.</td>
69+
</tr>
70+
<tr>
71+
<td>{{'[PlaceHolderFontSize](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_PlaceHolderFontSize)'| markdownify }}</td>
72+
<td>PlaceholderFontSize</td>
73+
<td>Gets or sets the value for place holder font size.</td>
74+
</tr>
75+
<tr>
76+
<td>{{'[WordWrap](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_PlaceHolderFontSize)'| markdownify }}</td>
77+
<td>EnableWordWrap</td>
78+
<td>Gets or sets the word-wrap that allows long words to be able to be broken and wrap onto the next line.<td>
79+
</tr>
3980
</table>
81+
82+
## Events
83+
84+
<table>
85+
<tr>
86+
<th>Xamarin SfRichTextEditor</th>
87+
<th>.NET MAUI SfRichTextEditor</th>
88+
<th>Description</th>
89+
</tr>
90+
<tr>
91+
<td>{{'[ImageInserted](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_ImageRequest)'| markdownify }}</td>
92+
<td>ImageRequested</td>
93+
<td>Occurs when an image is about to be inserted, allowing for customization of the image source.</td>
94+
</tr>
95+
<tr>
96+
<td>{{'[HyperlinkSelected](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_ImageInserted)'| markdownify }}</td>
97+
<td>HyperlinkClicked</td>
98+
<td>Occurs when a hyperlink is tapped, allowing for custom actions to be performed.</td>
99+
</tr>
100+
</table>
101+
102+
## Methods
103+
104+
<table>
105+
<tr>
106+
<th>Xamarin SfRichTextEditor</th>
107+
<th>.NET MAUI SfRichTextEditor</th>
108+
<th>Description</th>
109+
</tr>
110+
<tr>
111+
<td>{{'[AlignFull()](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_AlignFull)'| markdownify }}</td>
112+
<td>AlignJustify()</td>
113+
<td>Justifies the paragraph.</td>
114+
</tr>
115+
<tr>
116+
<td>{{'[ApplyFont(string fontName)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_ApplyFont_System_String_)'| markdownify }}</td>
117+
<td>ApplyFontFamily(string fontName)</td>
118+
<td>JApplies the specified font family.</td>
119+
</tr>
120+
<tr>
121+
<td>{{'[EditHyperlink(string url, string text)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_EditHyperlink_System_String_System_String_)'| markdownify }}</td>
122+
<td>EditHyperlink(string text, string oldUrl, string newUrl)</td>
123+
<td>Edits the hyperlink.</td>
124+
</tr>
125+
<tr>
126+
<td>{{'[InsertHyperlink(string url, string displayText)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_InsertHyperlink_System_String_System_String_)'| markdownify }}</td>
127+
<td>InsertHyperlink(string displayText, string Url)</td>
128+
<td>Inserts the hyperlink.</td>
129+
</tr>
130+
<tr>
131+
<td>{{'[RemoveHyperlink()](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_RemoveHyperlink)'| markdownify }}</td>
132+
<td>RemoveHyperlink(string text, string Url)</td>
133+
<td>Removes the hyperlink.</td>
134+
</tr>
135+
<tr>
136+
<td>{{'[InsertImage(ImageSource imageSource)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_InsertImage_Syncfusion_XForms_RichTextEditor_ImageSource_)'| markdownify }}</td>
137+
<td>InsertImage(SfRichTextEditorImageSource imageSource)</td>
138+
<td>Inserts the specified image into the SfRichTextEditor.</td>
139+
</tr>
140+
<tr>
141+
<td>{{'[SetFontColor(string fontColor)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_SetFontColor_System_String_)'| markdownify }}</td>
142+
<td>ApplyTextColor(Color textColor)</td>
143+
<td>Apply the text color.</td>
144+
</tr>
145+
<tr>
146+
<td>{{'[SetFontSize(string fontSize)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_SetFontSize_System_String_)'| markdownify }}</td>
147+
<td>ApplyFontSize(double fontSize)</td>
148+
<td>Apply the font size.</td>
149+
</tr>
150+
<tr>
151+
<td>{{'[SetHighlightColor(string color)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_SetHighlightColor_System_String_)'| markdownify }}</td>
152+
<td>ApplyHighlightColor(Color highlightColor)</td>
153+
<td>Highlights the background color.</td>
154+
</tr>
155+
<tr>
156+
<td>{{'[SetParagraphFormat(string heading)](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_SetParagraphFormat_System_String_)'| markdownify }}</td>
157+
<td>ApplyParagraphFormat(RichTextEditorParagraphFormat format)</td>
158+
<td>Apply the paragraph formatting style.</td>
159+
</tr>
160+
<tr>
161+
<td>{{'[ToggleSubScript()](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_ToggleSubScript)'| markdownify }}</td>
162+
<td>ToggleSubscript()</td>
163+
<td>Toggles the selected text as sub script format.</td>
164+
</tr>
165+
<tr>
166+
<td>{{'[ToggleSuperScript()](https://help.syncfusion.com/cr/xamarin/Syncfusion.XForms.RichTextEditor.SfRichTextEditor.html#Syncfusion_XForms_RichTextEditor_SfRichTextEditor_ToggleSuperScript)'| markdownify }}</td>
167+
<td>ToggleSuperscript()</td>
168+
<td>Toggles the selected text as super script format.</td>
169+
</tr>
170+
</table>

‎MAUI/Rich-Text-Editor/Overview.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,4 @@ The .NET MAUI Rich Text Editor provides a simple yet powerful editor interface t
2222
* `Customizable toolbar` - Includes a rich, configurable toolbar for quick access to formatting actions. Developers can show, hide, or customize toolbar items.
2323
* `Copy, paste, and cut` - Features built-in clipboard operations for user convenience.
2424
* `Undo and redo` - Provides robust undo and redo history for user-friendly editing.
25-
* `Clear formatting` - Includes an option to reset formatting and styles for selected text.
2625
* `Localization and accessibility` - Supports right-to-left layouts and accessibility features.

0 commit comments

Comments
 (0)