This topic provides information on how to create text using the xamRichTextEditor ™ from a developer’s perspective.
The following topics are prerequisites to understanding this topic:
This topic contains the following sections:
The xamRichTextEditor control supports text content in the document that can be styled differently according to your needs. The text nodes are responsible for holding one chunk of text; however, they do not provide any styling abilities. To style the text nodes add them in a run node instance. The run node is capable of styling all its child text nodes according the provided settings and styles. Run nodes are added in paragraph nodes.
You cannot add text nodes or run nodes directly in the body of the document. You can only add paragraphs and tables in the body and paragraphs may contain only run nodes and hyperlink nodes. The following diagram illustrates the allowed structure when defining text content:
DocumentRootNode
DocumentBodyNode
ParagraphNode
RunNode
TextNode
HyperlinkNode
RunNode
TextNode
TableNode
TableRowNode
TableCellNode
ParagraphNode
TableNodeThe ParagraphNodes are added in the ChildNodes collection of the DocumentBodyNode or TableCellNode and are used to represent a paragraph of the document’s text content. The paragraphs can be customized using their paragraph setting and/or using style.
The following table maps the key configuration to its respective property settings.
Add the RunNodes in the ChildNodes collection of a ParagraphNode or HyperlinkNode to represent one or more chunks of text content with the same settings and style applied. The run nodes can be customized using their character settings and/or using a style.
The following table maps the key configuration to its respective property settings.
Add the TextNodes in the ChildNodes collection of a RunNode and use them to represent a chunk of text content.
The following table maps the key configuration to its respective property settings.
The code snippets below demonstrates two approaches for creating plain text content :
In C#:
TextNode tn = new TextNode();
tn.Text = "Plain text";
RunNode rn = new RunNode();
rn.ChildNodes.Add(tn);
ParagraphNode pn = new ParagraphNode();
pn.ChildNodes.Add(rn);
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);
ParagraphNode pn = new ParagraphNode();
pn.SetText("Plain text");
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);In Visual Basic:
Dim tn As New TextNode()
tn.Text = "Plain text"
Dim rn As New RunNode()
rn.ChildNodes.Add(tn)
Dim pn As New ParagraphNode()
pn.ChildNodes.Add(rn)
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)
Dim pn As New ParagraphNode()
pn.SetText("Plain text")
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)The code snippet below demonstrates how to create text content with different font family, size and styling:
In C#:
CharacterSettings cs = new CharacterSettings()
{
Bold = true,
Italic = true,
FontSize = new Extent(24, ExtentUnitType.Points),
FontSettings = new FontSettings() { Ascii = "Consolas" }
};
TextNode tn = new TextNode();
tn.Text = "Styled text";
RunNode rn = new RunNode();
rn.Settings = cs;
rn.ChildNodes.Add(tn);
ParagraphNode pn = new ParagraphNode();
pn.ChildNodes.Add(rn);
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);In Visual Basic:
Dim cs As New CharacterSettings() With { _
Key .Bold = True, _
Key .Italic = True, _
Key .FontSize = New Extent(24, ExtentUnitType.Points), _
Key .FontSettings = New FontSettings() With { _
Key .Ascii = "Consolas" _
} _
}
Dim tn As New TextNode()
tn.Text = "Styled text"
Dim rn As New RunNode()
rn.Settings = cs
rn.ChildNodes.Add(tn)
Dim pn As New ParagraphNode()
pn.ChildNodes.Add(rn)
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)The code snippet below demonstrates how to create text content with different foreground and highlight color:
In C#:
CharacterSettings cs = new CharacterSettings()
{
Color = new ColorInfo(Colors.Red),
HighlightColorc = HighlightColor.Blue
};
TextNode tn = new TextNode();
tn.Text = "Colored text";
RunNode rn = new RunNode();
rn.Settings = cs;
rn.ChildNodes.Add(tn);
ParagraphNode pn = new ParagraphNode();
pn.ChildNodes.Add(rn);
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);In Visual Basic:
Dim cs As New CharacterSettings() With { _
Key .Color = New ColorInfo(Colors.Red), _
Key .HighlightColorc = HighlightColor.Blue _
}
Dim tn As New TextNode()
tn.Text = "Colored text"
Dim rn As New RunNode()
rn.Settings = cs
rn.ChildNodes.Add(tn)
Dim pn As New ParagraphNode()
pn.ChildNodes.Add(rn)
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)The code snippet below demonstrates how to create subscript and superscript text content:
In C#:
CharacterSettings superscriptCharacterSettings = new CharacterSettings()
{
VerticalAlignment = RunVerticalAlignment.Superscript,
FontSize = new Extent(10, ExtentUnitType.Points),
};
CharacterSettings subscriptCharacterSettings = new CharacterSettings()
{
VerticalAlignment = RunVerticalAlignment.Subscript,
FontSize = new Extent(10, ExtentUnitType.Points),
};
ParagraphNode pn = new ParagraphNode();
pn.ChildNodes.Add(rn);
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);
RunNode rn = new RunNode();
rn.SetText("Normal text");
pn.ChildNodes.Add(rn);
rn = new RunNode();
rn.SetText("Subscripted text");
rn.Settings = subscriptCharacterSettings;
pn.ChildNodes.Add(rn);
rn = new RunNode();
rn.SetText("Superscripted text");
rn.Settings = superscriptCharacterSettings;
pn.ChildNodes.Add(rn);In Visual Basic:
Dim superscriptCharacterSettings As New CharacterSettings() With { _
Key .VerticalAlignment = RunVerticalAlignment.Superscript, _
Key .FontSize = New Extent(10, ExtentUnitType.Points) _
}
Dim subscriptCharacterSettings As New CharacterSettings() With { _
Key .VerticalAlignment = RunVerticalAlignment.Subscript, _
Key .FontSize = New Extent(10, ExtentUnitType.Points) _
}
Dim pn As New ParagraphNode()
pn.ChildNodes.Add(rn)
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)
Dim rn As New RunNode()
rn.SetText("Normal text")
pn.ChildNodes.Add(rn)
rn = New RunNode()
rn.SetText("Subscripted text")
rn.Settings = subscriptCharacterSettings
pn.ChildNodes.Add(rn)
rn = New RunNode()
rn.SetText("Superscripted text")
rn.Settings = superscriptCharacterSettings
pn.ChildNodes.Add(rn)The code snippet below demonstrates how to create a drop cap:
In C#:
// create paragraph for the drop cap
ParagraphNode pn = new ParagraphNode();
pn.Settings = new ParagraphSettings();
pn.Settings.Frame = new TextFrameSettings();
pn.Settings.Frame.DropCap = TextFrameDropCap.Drop; // enable drop cap
pn.Settings.Frame.DropCapLines = 3; // amount of lines spanned by the drop cap
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);
RunNode rn = new RunNode();
rn.Settings = new CharacterSettings();
rn.Settings.FontSize = new Extent(48, ExtentUnitType.Points); // font size
rn.SetText("O");
pn.ChildNodes.Add(rn);
// create paragraph for the rest of the content
pn = new ParagraphNode();
pn.SetText("nce upon a time…");
this.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn);In Visual Basic:
' create paragraph for the drop cap
Dim pn As New ParagraphNode()
pn.Settings = New ParagraphSettings()
pn.Settings.Frame = New TextFrameSettings()
' enable drop cap
pn.Settings.Frame.DropCap = TextFrameDropCap.Drop
' amount of lines spanned by the drop cap
pn.Settings.Frame.DropCapLines = 3
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)
Dim rn As New RunNode()
rn.Settings = New CharacterSettings()
' font size
rn.Settings.FontSize = New Extent(48, ExtentUnitType.Points)
rn.SetText("O")
pn.ChildNodes.Add(rn)
' create paragraph for the rest of the content
pn = New ParagraphNode()
pn.SetText("nce upon a time…")
Me.xamRichTextEditor1.Document.RootNode.Body.ChildNodes.Add(pn)The following topics provide additional information related to this topic.