Class RichText
Class RichText
Namespace: Aspose.Note
Assembly: Aspose.Note.dll (24.12.0)
Represents a rich text.
public sealed class RichText : Node, IOutlineElementChildNode, ITaggable, INode, IEnumerable<char>, IEnumerableInheritance
Implements
IOutlineElementChildNode, ITaggable, INode, IEnumerable<char>, IEnumerable
Inherited Members
Node.Accept(DocumentVisitor), Node.Document, Node.IsComposite, Node.NodeType, Node.ParentNode, Node.PreviousSibling, Node.NextSibling, object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Examples
Shows how to get all text from the document.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Retrieve text
string text = string.Join(Environment.NewLine, oneFile.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);</richtext>
Shows how to get all text from the page.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Get list of page nodes
var page = oneFile.GetChildNodes<page>().FirstOrDefault();
if (page != null)
{
// Retrieve text
string text = string.Join(Environment.NewLine, page.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}</richtext></page>Let’s emphasize page’s titles among other headers by increasing font’s size.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Aspose.one");
// Iterate through page's titles.
foreach (var title in document.Select(e => e.Title.TitleText))
{
title.ParagraphStyle.FontSize = 24;
title.ParagraphStyle.IsBold = true;
foreach (var run in title.TextRuns)
{
run.Style.FontSize = 24;
run.Style.IsBold = true;
}
}
document.Save(Path.Combine(dataDir, "ChangePageTitleStyle.pdf"));
Shows how to get text from every table's row.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
foreach (Table table in nodes)
{
// Iterate through table rows
foreach (TableRow row in table)
{
// Retrieve text
string text = string.Join(Environment.NewLine, row.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}
}</richtext></table></table>Shows how to get text from a table.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
// Set table count
int tblCount = 0;
foreach (Table table in nodes)
{
tblCount++;
Console.WriteLine("table # " + tblCount);
// Retrieve text
string text = string.Join(Environment.NewLine, table.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}</richtext></table></table>
Let's emphasize latest text's changes by highlighting.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Aspose.one");
// Get RichText nodes modified last week.
var richTextNodes = document.GetChildNodes<richtext>().Where(e => e.LastModifiedTime >= DateTime.Today.Subtract(TimeSpan.FromDays(7)));
foreach (var node in richTextNodes)
{
// Set highlight color
node.ParagraphStyle.Highlight = Color.DarkGreen;
foreach (var run in node.TextRuns)
{
// Set highlight color
run.Style.Highlight = Color.DarkSeaGreen;
}
}
document.Save(Path.Combine(dataDir, "HighlightAllRecentChanges.pdf"));</richtext>Shows how to set a title for a page.```csharp string dataDir = RunExamples.GetDataDir_Text(); string outputPath = dataDir + “CreateTitleMsStyle_out.one”;
var doc = new Document();
var page = new Page(doc);
page.Title = new Title(doc)
{
TitleText = new RichText(doc)
{
Text = "Title text.",
ParagraphStyle = ParagraphStyle.Default
},
TitleDate = new RichText(doc)
{
Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture),
ParagraphStyle = ParagraphStyle.Default
},
TitleTime = new RichText(doc)
{
Text = "12:34",
ParagraphStyle = ParagraphStyle.Default
}
};
doc.AppendChildLast(page);
doc.Save(outputPath);
Set proofing language for a text.```csharp
var document = new Document();
var page = new Page();
var outline = new Outline();
var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = ParagraphStyle.Default };
text.Append("United States", new TextStyle() { Language = CultureInfo.GetCultureInfo("en-US") })
.Append(" Germany", new TextStyle() { Language = CultureInfo.GetCultureInfo("de-DE") })
.Append(" China", new TextStyle() { Language = CultureInfo.GetCultureInfo("zh-CN") });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetProofingLanguageForText.one"));Shows how to pass through all pages and make a replacement in the text.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Text();
Dictionary<string, string=""> replacements = new Dictionary<string, string="">();
replacements.Add("Some task here", "New Text Here");
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Get all RichText nodes
IList<richtext> textNodes = oneFile.GetChildNodes<richtext>();
foreach (RichText richText in textNodes)
{
foreach (KeyValuePair<string, string=""> kvp in replacements)
{
// Replace text of a shape
richText.Replace(kvp.Key, kvp.Value);
}
}
dataDir = dataDir + "ReplaceTextOnAllPages_out.pdf";
// Save to any supported file format
oneFile.Save(dataDir, SaveFormat.Pdf);</string,></richtext></richtext></string,></string,>
Manipulate by text format using paragraph style.```csharp
var document = new Document();
var page = new Page();
var outline = new Outline();
var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = new ParagraphStyle() { FontName = "Courier New", FontSize = 20 } }
.Append($"DefaultParagraphFontAndSize{Environment.NewLine}")
.Append($"OnlyDefaultParagraphFont{Environment.NewLine}", new TextStyle() { FontSize = 14 })
.Append("OnlyDefaultParagraphFontSize", new TextStyle() { FontName = "Verdana" });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetDefaultParagraphStyle.one"));Shows how to get text from a table’s cells.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
foreach (Table table in nodes)
{
// Iterate through table rows
foreach (TableRow row in table)
{
// Get list of TableCell nodes
// Iterate through table cells
foreach (TableCell cell in row)
{
// Retrieve text
string text = string.Join(Environment.NewLine, cell.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}
}
}</richtext></table></table>
Shows how to pass through page's text and make a replacement.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();
Dictionary<string, string=""> replacements = new Dictionary<string, string="">();
replacements.Add("voice over", "voice over new text");
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
IList<page> pageNodes = oneFile.GetChildNodes<page>();
// Get all RichText nodes
IList<richtext> textNodes = pageNodes[0].GetChildNodes<richtext>();
foreach (RichText richText in textNodes)
{
foreach (KeyValuePair<string, string=""> kvp in replacements)
{
// Replace text of a shape
richText.Replace(kvp.Key, kvp.Value);
}
}
// Save to any supported file format
dataDir = dataDir + "ReplaceTextOnParticularPage_out.pdf";
oneFile.Save(dataDir, SaveFormat.Pdf);</string,></richtext></richtext></page></page></string,></string,>Shows how to create a document and save it in html format using default options.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Initialize OneNote document
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// Save into HTML format
dataDir = dataDir + "CreateOneNoteDocAndSaveToHTML_out.html";
doc.Save(dataDir);
Shows how to add new paragraph with tag.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
RichText text = new RichText(doc) { Text = "OneNote text.", ParagraphStyle = textStyle };
text.Tags.Add(NoteTag.CreateYellowStar());
// Add text node
outlineElem.AppendChildLast(text);
// Add outline element node
outline.AppendChildLast(outlineElem);
// Add outline node
page.AppendChildLast(outline);
// Add page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddTextNodeWithTag_out.one";
doc.Save(dataDir);Shows how to create a document and save in html format specified range of pages.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Initialize OneNote document
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// Save into HTML format
dataDir = dataDir + "CreateAndSavePageRange_out.html";
doc.Save(dataDir, new HtmlSaveOptions
{
PageCount = 1,
PageIndex = 0
});
Shows how to access details of a tag.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tags();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "TagFile.one");
// Get all RichText nodes
IList<richtext> nodes = oneFile.GetChildNodes<richtext>();
// Iterate through each node
foreach (RichText richText in nodes)
{
var tags = richText.Tags.OfType<notetag>();
if (tags.Any())
{
Console.WriteLine($"Text: {richText.Text}");
foreach (var noteTag in tags)
{
// Retrieve properties
Console.WriteLine($" Completed Time: {noteTag.CompletedTime}");
Console.WriteLine($" Create Time: {noteTag.CreationTime}");
Console.WriteLine($" Font Color: {noteTag.FontColor}");
Console.WriteLine($" Status: {noteTag.Status}");
Console.WriteLine($" Label: {noteTag.Label}");
Console.WriteLine($" Icon: {noteTag.Icon}");
Console.WriteLine($" High Light: {noteTag.Highlight}");
}
}
}</notetag></richtext></richtext>Shows how to create a document with a text.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize RichText class object and apply text style
RichText text = new RichText(doc) { Text = "Hello OneNote text!", ParagraphStyle = textStyle };
// Add RichText node
outlineElem.AppendChildLast(text);
// Add OutlineElement node
outline.AppendChildLast(outlineElem);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "CreateDocWithSimpleRichText_out.one";
doc.Save(dataDir);
Shows how to insert new list with chinese numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize OneNote page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline = new Outline(doc);
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);Shows how to insert new bulleted lis.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyBulletsOnText_out.one";
doc.Save(dataDir);
Shows how to insert new list with numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);Shows how to prepare a template for weekly meeting.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
var headerStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 16 };
var bodyStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 12 };
var d = new Document();
bool restartFlag = true;
var outline = d.AppendChildLast(new Page()
{
Title = new Title() { TitleText = new RichText() { Text = $"Weekly meeting {DateTime.Today:d}", ParagraphStyle = ParagraphStyle.Default } }
})
.AppendChildLast(new Outline() { VerticalOffset = 30, HorizontalOffset = 30 });
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "Important", ParagraphStyle = headerStyle });
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle });
restartFlag = false;
}
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "TO DO", ParagraphStyle = headerStyle, SpaceBefore = 15 });
restartFlag = true;
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle, Tags = { NoteCheckBox.CreateBlueCheckBox() } });
restartFlag = false;
}
d.Save(Path.Combine(dataDir, "meetingNotes.one"));
Shows how to bind a hyperlink to a text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tasks();
// Create an object of the Document class
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Initialize Title class object
Title title = new Title() { TitleText = titleText };
// Initialize Page class object
Page page = new Note.Page() { Title = title };
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);Constructors
RichText()
Initializes a new instance of the Aspose.Note.RichText class.
public RichText()Properties
Alignment
Gets or sets the alignment.
public HorizontalAlignment Alignment { get; set; }Property Value
IsTitleDate
Gets a value indicating whether the RichText element contains the date in the page title.
public bool IsTitleDate { get; }Property Value
IsTitleText
Gets a value indicating whether the RichText element contains the text of the page title.
public bool IsTitleText { get; }Property Value
IsTitleTime
Gets a value indicating whether the RichText element contains the time in the page title.
public bool IsTitleTime { get; }Property Value
LastModifiedTime
Gets or sets the last modified time.
public DateTime LastModifiedTime { get; set; }Property Value
Examples
Let’s emphasize latest text’s changes by highlighting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Aspose.one");
// Get RichText nodes modified last week.
var richTextNodes = document.GetChildNodes<richtext>().Where(e => e.LastModifiedTime >= DateTime.Today.Subtract(TimeSpan.FromDays(7)));
foreach (var node in richTextNodes)
{
// Set highlight color
node.ParagraphStyle.Highlight = Color.DarkGreen;
foreach (var run in node.TextRuns)
{
// Set highlight color
run.Style.Highlight = Color.DarkSeaGreen;
}
}
document.Save(Path.Combine(dataDir, "HighlightAllRecentChanges.pdf"));</richtext>
### <a id="Aspose_Note_RichText_Length"></a> Length
Gets the length of the text.
```csharp
public int Length { get; }Property Value
LineSpacing
Gets or sets the line spacing.
public float? LineSpacing { get; set; }Property Value
ParagraphStyle
Gets or sets the paragraph style. These settings are used if there is no matching TextStyle object in Aspose.Note.RichText.Styles collection either this object doesn’t specify a needed setting.
public ParagraphStyle ParagraphStyle { get; set; }Property Value
Examples
Let’s emphasize page’s titles among other headers by increasing font’s size.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Aspose.one");
// Iterate through page's titles.
foreach (var title in document.Select(e => e.Title.TitleText))
{
title.ParagraphStyle.FontSize = 24;
title.ParagraphStyle.IsBold = true;
foreach (var run in title.TextRuns)
{
run.Style.FontSize = 24;
run.Style.IsBold = true;
}
}
document.Save(Path.Combine(dataDir, "ChangePageTitleStyle.pdf"));
Shows how to apply Dark theme style to a Document.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document doc = new Document(Path.Combine(dataDir, "Aspose.one"));
foreach (var page in doc)
{
page.BackgroundColor = Color.Black;
}
foreach (var node in doc.GetChildNodes<richtext>())
{
var c = node.ParagraphStyle.FontColor;
if (c.IsEmpty || Math.Abs(c.R - Color.Black.R) + Math.Abs(c.G - Color.Black.G) + Math.Abs(c.B - Color.Black.B) <= 30)
{
node.ParagraphStyle.FontColor = Color.White;
}
}
doc.Save(Path.Combine(dataDir, "AsposeDarkTheme.pdf"));</richtext>Let’s emphasize latest text’s changes by highlighting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Aspose.one");
// Get RichText nodes modified last week.
var richTextNodes = document.GetChildNodes<richtext>().Where(e => e.LastModifiedTime >= DateTime.Today.Subtract(TimeSpan.FromDays(7)));
foreach (var node in richTextNodes)
{
// Set highlight color
node.ParagraphStyle.Highlight = Color.DarkGreen;
foreach (var run in node.TextRuns)
{
// Set highlight color
run.Style.Highlight = Color.DarkSeaGreen;
}
}
document.Save(Path.Combine(dataDir, "HighlightAllRecentChanges.pdf"));</richtext>
Shows how to set a title for a page.```csharp
string dataDir = RunExamples.GetDataDir_Text();
string outputPath = dataDir + "CreateTitleMsStyle_out.one";
var doc = new Document();
var page = new Page(doc);
page.Title = new Title(doc)
{
TitleText = new RichText(doc)
{
Text = "Title text.",
ParagraphStyle = ParagraphStyle.Default
},
TitleDate = new RichText(doc)
{
Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture),
ParagraphStyle = ParagraphStyle.Default
},
TitleTime = new RichText(doc)
{
Text = "12:34",
ParagraphStyle = ParagraphStyle.Default
}
};
doc.AppendChildLast(page);
doc.Save(outputPath);Manipulate by text format using paragraph style.```csharp var document = new Document(); var page = new Page(); var outline = new Outline(); var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = new ParagraphStyle() { FontName = "Courier New", FontSize = 20 } }
.Append($"DefaultParagraphFontAndSize{Environment.NewLine}")
.Append($"OnlyDefaultParagraphFont{Environment.NewLine}", new TextStyle() { FontSize = 14 })
.Append("OnlyDefaultParagraphFontSize", new TextStyle() { FontName = "Verdana" });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetDefaultParagraphStyle.one"));
Shows how to add new paragraph with tag.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
RichText text = new RichText(doc) { Text = "OneNote text.", ParagraphStyle = textStyle };
text.Tags.Add(NoteTag.CreateYellowStar());
// Add text node
outlineElem.AppendChildLast(text);
// Add outline element node
outline.AppendChildLast(outlineElem);
// Add outline node
page.AppendChildLast(outline);
// Add page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddTextNodeWithTag_out.one";
doc.Save(dataDir);Shows how to access details of a tag.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tags();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "TagFile.one");
// Get all RichText nodes
IList<richtext> nodes = oneFile.GetChildNodes<richtext>();
// Iterate through each node
foreach (RichText richText in nodes)
{
var tags = richText.Tags.OfType<notetag>();
if (tags.Any())
{
Console.WriteLine($"Text: {richText.Text}");
foreach (var noteTag in tags)
{
// Retrieve properties
Console.WriteLine($" Completed Time: {noteTag.CompletedTime}");
Console.WriteLine($" Create Time: {noteTag.CreationTime}");
Console.WriteLine($" Font Color: {noteTag.FontColor}");
Console.WriteLine($" Status: {noteTag.Status}");
Console.WriteLine($" Label: {noteTag.Label}");
Console.WriteLine($" Icon: {noteTag.Icon}");
Console.WriteLine($" High Light: {noteTag.Highlight}");
}
}
}</notetag></richtext></richtext>
Shows how to insert new list with chinese numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize OneNote page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline = new Outline(doc);
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);Shows how to insert new bulleted lis.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyBulletsOnText_out.one";
doc.Save(dataDir);
Shows how to insert new list with numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);Shows how to prepare a template for weekly meeting.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
var headerStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 16 };
var bodyStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 12 };
var d = new Document();
bool restartFlag = true;
var outline = d.AppendChildLast(new Page()
{
Title = new Title() { TitleText = new RichText() { Text = $"Weekly meeting {DateTime.Today:d}", ParagraphStyle = ParagraphStyle.Default } }
})
.AppendChildLast(new Outline() { VerticalOffset = 30, HorizontalOffset = 30 });
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "Important", ParagraphStyle = headerStyle });
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle });
restartFlag = false;
}
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "TO DO", ParagraphStyle = headerStyle, SpaceBefore = 15 });
restartFlag = true;
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle, Tags = { NoteCheckBox.CreateBlueCheckBox() } });
restartFlag = false;
}
d.Save(Path.Combine(dataDir, "meetingNotes.one"));
Shows how to bind a hyperlink to a text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tasks();
// Create an object of the Document class
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Initialize Title class object
Title title = new Title() { TitleText = titleText };
// Initialize Page class object
Page page = new Note.Page() { Title = title };
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);SpaceAfter
Gets or sets the minimum amount of space after.
public float? SpaceAfter { get; set; }Property Value
SpaceBefore
Gets or sets the minimum amount of space before.
public float? SpaceBefore { get; set; }Property Value
Styles
Gets the styles.
[Obsolete("Obsolete since 22.5 release. Use TextRuns property.")]
public IEnumerable<textstyle> Styles { get; }Property Value
IEnumerable<TextStyle>
Examples
Shows how to compose a table having text with various styles.```csharp string dataDir = RunExamples.GetDataDir_Text();
var headerText = new RichText() { ParagraphStyle = new ParagraphStyle() { FontSize = 18, IsBold = true }, Alignment = HorizontalAlignment.Center }
.Append("Super contest for suppliers.");
var page = new Page();
var outline = page.AppendChildLast(new Outline() { HorizontalOffset = 50 });
outline.AppendChildLast(new OutlineElement()).AppendChildLast(headerText);
// Summary text before table
var bodyTextHeader = outline.AppendChildLast(new OutlineElement()).AppendChildLast(new RichText() { ParagraphStyle = ParagraphStyle.Default });
bodyTextHeader.Append("This is the final ranking of proposals got from our suppliers.");
var ranking = outline.AppendChildLast(new OutlineElement()).AppendChildLast(new Table());
var headerRow = ranking.AppendChildFirst(new TableRow());
var headerStyle = ParagraphStyle.Default;
headerStyle.IsBold = true;
// Let's add a set of columns and a header row
var backGroundColor = Color.LightGray;
foreach (var header in new[] { "Supplier", "Contacts", "Score A", "Score B", "Score C", "Final score", "Attached materials", "Comments" })
{
ranking.Columns.Add(new TableColumn());
headerRow.AppendChildLast(new TableCell() { BackgroundColor = backGroundColor })
.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { ParagraphStyle = headerStyle })
.Append(header);
}
// Let's 5 empty rows. Rows have interchanging background color
for (int i = 0; i < 5; i++)
{
backGroundColor = backGroundColor.IsEmpty ? Color.LightGray : Color.Empty;
var row = ranking.AppendChildLast(new TableRow());
for (int j = 0; j < ranking.Columns.Count(); j++)
{
row.AppendChildLast(new TableCell() { BackgroundColor = backGroundColor })
.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { ParagraphStyle = ParagraphStyle.Default });
}
}
// Let's add some template for content in 'Contacts' column
foreach (var row in ranking.Skip(1))
{
var contactsCell = row.ElementAt(1);
contactsCell.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { ParagraphStyle = ParagraphStyle.Default })
.Append("Web: ").Append("link", new TextStyle() { HyperlinkAddress = "www.link.com", IsHyperlink = true });
contactsCell.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { ParagraphStyle = ParagraphStyle.Default })
.Append("E-mail: ").Append("mail", new TextStyle() { HyperlinkAddress = "mailto:hi@link.com", IsHyperlink = true });
}
var d = new Document();
d.AppendChildLast(page);
d.Save(Path.Combine(dataDir, "ComposeTable_out.one"));
### <a id="Aspose_Note_RichText_Tags"></a> Tags
Gets the list of all tags of a paragraph.
```csharp
public List<itag> Tags { get; }Property Value
Examples
Shows how to access details of outlook’s tasks.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tasks();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Get all RichText nodes
IList<richtext> nodes = oneFile.GetChildNodes<richtext>();
// Iterate through each node
foreach (RichText richText in nodes)
{
var tasks = richText.Tags.OfType<notetask>();
if (tasks.Any())
{
Console.WriteLine($"Task: {richText.Text}");
foreach (var noteTask in tasks)
{
// Retrieve properties
Console.WriteLine($" Completed Time: {noteTask.CompletedTime}");
Console.WriteLine($" Create Time: {noteTask.CreationTime}");
Console.WriteLine($" Due Date: {noteTask.DueDate}");
Console.WriteLine($" Status: {noteTask.Status}");
Console.WriteLine($" Icon: {noteTask.Icon}");
}
}
}</notetask></richtext></richtext>
### <a id="Aspose_Note_RichText_Text"></a> Text
Gets or sets the text. The string MUST NOT contain any characters of the value 10 (line feed).
```csharp
public string Text { get; set; }Property Value
Examples
Shows how to get all text from the document.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Retrieve text
string text = string.Join(Environment.NewLine, oneFile.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);</richtext>
Shows how to get all text from the page.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Get list of page nodes
var page = oneFile.GetChildNodes<page>().FirstOrDefault();
if (page != null)
{
// Retrieve text
string text = string.Join(Environment.NewLine, page.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}</richtext></page>Shows how to get text from every table’s row.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
foreach (Table table in nodes)
{
// Iterate through table rows
foreach (TableRow row in table)
{
// Retrieve text
string text = string.Join(Environment.NewLine, row.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}
}</richtext></table></table>
Shows how to get text from a table.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
// Set table count
int tblCount = 0;
foreach (Table table in nodes)
{
tblCount++;
Console.WriteLine("table # " + tblCount);
// Retrieve text
string text = string.Join(Environment.NewLine, table.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}</richtext></table></table>Shows how to set a title for a page.```csharp string dataDir = RunExamples.GetDataDir_Text(); string outputPath = dataDir + “CreateTitleMsStyle_out.one”;
var doc = new Document();
var page = new Page(doc);
page.Title = new Title(doc)
{
TitleText = new RichText(doc)
{
Text = "Title text.",
ParagraphStyle = ParagraphStyle.Default
},
TitleDate = new RichText(doc)
{
Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture),
ParagraphStyle = ParagraphStyle.Default
},
TitleTime = new RichText(doc)
{
Text = "12:34",
ParagraphStyle = ParagraphStyle.Default
}
};
doc.AppendChildLast(page);
doc.Save(outputPath);
Shows how to pass through all pages and make a replacement in the text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();
Dictionary<string, string=""> replacements = new Dictionary<string, string="">();
replacements.Add("Some task here", "New Text Here");
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
// Get all RichText nodes
IList<richtext> textNodes = oneFile.GetChildNodes<richtext>();
foreach (RichText richText in textNodes)
{
foreach (KeyValuePair<string, string=""> kvp in replacements)
{
// Replace text of a shape
richText.Replace(kvp.Key, kvp.Value);
}
}
dataDir = dataDir + "ReplaceTextOnAllPages_out.pdf";
// Save to any supported file format
oneFile.Save(dataDir, SaveFormat.Pdf);</string,></richtext></richtext></string,></string,>Shows how to get text from a table’s cells.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tables();
// Load the document into Aspose.Note.
Document document = new Document(dataDir + "Sample1.one");
// Get a list of table nodes
IList<table> nodes = document.GetChildNodes<table>();
foreach (Table table in nodes)
{
// Iterate through table rows
foreach (TableRow row in table)
{
// Get list of TableCell nodes
// Iterate through table cells
foreach (TableCell cell in row)
{
// Retrieve text
string text = string.Join(Environment.NewLine, cell.GetChildNodes<richtext>().Select(e => e.Text)) + Environment.NewLine;
// Print text on the output screen
Console.WriteLine(text);
}
}
}</richtext></table></table>
Shows how to create a document and save it in html format using default options.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Initialize OneNote document
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// Save into HTML format
dataDir = dataDir + "CreateOneNoteDocAndSaveToHTML_out.html";
doc.Save(dataDir);Shows how to add new paragraph with tag.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
RichText text = new RichText(doc) { Text = "OneNote text.", ParagraphStyle = textStyle };
text.Tags.Add(NoteTag.CreateYellowStar());
// Add text node
outlineElem.AppendChildLast(text);
// Add outline element node
outline.AppendChildLast(outlineElem);
// Add outline node
page.AppendChildLast(outline);
// Add page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddTextNodeWithTag_out.one";
doc.Save(dataDir);
Shows how to create a document and save in html format specified range of pages.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Initialize OneNote document
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// Default style for all text in the document.
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// Save into HTML format
dataDir = dataDir + "CreateAndSavePageRange_out.html";
doc.Save(dataDir, new HtmlSaveOptions
{
PageCount = 1,
PageIndex = 0
});Shows how to access details of a tag.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tags();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "TagFile.one");
// Get all RichText nodes
IList<richtext> nodes = oneFile.GetChildNodes<richtext>();
// Iterate through each node
foreach (RichText richText in nodes)
{
var tags = richText.Tags.OfType<notetag>();
if (tags.Any())
{
Console.WriteLine($"Text: {richText.Text}");
foreach (var noteTag in tags)
{
// Retrieve properties
Console.WriteLine($" Completed Time: {noteTag.CompletedTime}");
Console.WriteLine($" Create Time: {noteTag.CreationTime}");
Console.WriteLine($" Font Color: {noteTag.FontColor}");
Console.WriteLine($" Status: {noteTag.Status}");
Console.WriteLine($" Label: {noteTag.Label}");
Console.WriteLine($" Icon: {noteTag.Icon}");
Console.WriteLine($" High Light: {noteTag.Highlight}");
}
}
}</notetag></richtext></richtext>
Shows how to create a document with a text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize RichText class object and apply text style
RichText text = new RichText(doc) { Text = "Hello OneNote text!", ParagraphStyle = textStyle };
// Add RichText node
outlineElem.AppendChildLast(text);
// Add OutlineElement node
outline.AppendChildLast(outlineElem);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "CreateDocWithSimpleRichText_out.one";
doc.Save(dataDir);Shows how to insert new list with chinese numbering.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize OneNote page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline = new Outline(doc);
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);
Shows how to insert new bulleted lis.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyBulletsOnText_out.one";
doc.Save(dataDir);Shows how to insert new list with numbering.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);
Shows how to prepare a template for weekly meeting.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
var headerStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 16 };
var bodyStyle = new ParagraphStyle() { FontName = "Calibri", FontSize = 12 };
var d = new Document();
bool restartFlag = true;
var outline = d.AppendChildLast(new Page()
{
Title = new Title() { TitleText = new RichText() { Text = $"Weekly meeting {DateTime.Today:d}", ParagraphStyle = ParagraphStyle.Default } }
})
.AppendChildLast(new Outline() { VerticalOffset = 30, HorizontalOffset = 30 });
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "Important", ParagraphStyle = headerStyle });
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle });
restartFlag = false;
}
outline.AppendChildLast(new OutlineElement())
.AppendChildLast(new RichText() { Text = "TO DO", ParagraphStyle = headerStyle, SpaceBefore = 15 });
restartFlag = true;
foreach (var e in new[] { "First", "Second", "Third" })
{
outline.AppendChildLast(new OutlineElement() { NumberList = CreateListNumberingStyle(bodyStyle, restartFlag) })
.AppendChildLast(new RichText() { Text = e, ParagraphStyle = bodyStyle, Tags = { NoteCheckBox.CreateBlueCheckBox() } });
restartFlag = false;
}
d.Save(Path.Combine(dataDir, "meetingNotes.one"));Shows how to bind a hyperlink to a text.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tasks();
// Create an object of the Document class
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Initialize Title class object
Title title = new Title() { TitleText = titleText };
// Initialize Page class object
Page page = new Note.Page() { Title = title };
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);
### <a id="Aspose_Note_RichText_TextRuns"></a> TextRuns
Gets the collection of text runs.
```csharp
public IEnumerable<textrun> TextRuns { get; }Property Value
IEnumerable<TextRun>
Methods
Accept(DocumentVisitor)
Accepts the visitor of the node.
public override void Accept(DocumentVisitor visitor)Parameters
visitor DocumentVisitor
The object of a class derived from the Aspose.Note.DocumentVisitor.
Append(string, TextStyle)
Adds a string to the end.
public RichText Append(string value, TextStyle style)Parameters
value string
The added value.
style TextStyle
The style of added string.
Returns
The Aspose.Note.RichText.
Examples
Set proofing language for a text.```csharp var document = new Document(); var page = new Page(); var outline = new Outline(); var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = ParagraphStyle.Default };
text.Append("United States", new TextStyle() { Language = CultureInfo.GetCultureInfo("en-US") })
.Append(" Germany", new TextStyle() { Language = CultureInfo.GetCultureInfo("de-DE") })
.Append(" China", new TextStyle() { Language = CultureInfo.GetCultureInfo("zh-CN") });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetProofingLanguageForText.one"));
Manipulate by text format using paragraph style.```csharp
var document = new Document();
var page = new Page();
var outline = new Outline();
var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = new ParagraphStyle() { FontName = "Courier New", FontSize = 20 } }
.Append($"DefaultParagraphFontAndSize{Environment.NewLine}")
.Append($"OnlyDefaultParagraphFont{Environment.NewLine}", new TextStyle() { FontSize = 14 })
.Append("OnlyDefaultParagraphFontSize", new TextStyle() { FontName = "Verdana" });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetDefaultParagraphStyle.one"));Shows how to bind a hyperlink to a text.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Tasks();
// Create an object of the Document class
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Initialize Title class object
Title title = new Title() { TitleText = titleText };
// Initialize Page class object
Page page = new Note.Page() { Title = title };
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);
Shows how to create a document with formatted rich text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Title class object
Title title = new Title();
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultTextStyle = new ParagraphStyle
{
FontColor = Color.Black,
FontName = "Arial",
FontSize = 10
};
RichText titleText = new RichText() { ParagraphStyle = defaultTextStyle }.Append("Title!");
Outline outline = new Outline()
{
VerticalOffset = 100,
HorizontalOffset = 100
};
OutlineElement outlineElem = new OutlineElement();
TextStyle textStyleForHelloWord = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleForOneNoteWord = new TextStyle
{
FontColor = Color.Green,
FontName = "Calibri",
FontSize = 10,
IsItalic = true,
};
TextStyle textStyleForTextWord = new TextStyle
{
FontColor = Color.Blue,
FontName = "Arial",
FontSize = 15,
IsBold = true,
IsItalic = true,
};
RichText text = new RichText() { ParagraphStyle = defaultTextStyle }
.Append("Hello", textStyleForHelloWord)
.Append(" OneNote", textStyleForOneNoteWord)
.Append(" text", textStyleForTextWord)
.Append("!", TextStyle.Default);
title.TitleText = titleText;
// Set page title
page.Title = title;
// Add RichText node
outlineElem.AppendChildLast(text);
// Add OutlineElement node
outline.AppendChildLast(outlineElem);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "CreateDocWithFormattedRichText_out.one";
doc.Save(dataDir);Append(string)
Adds a string to the last text range.
public RichText Append(string value)Parameters
value string
The added value.
Returns
The Aspose.Note.RichText.
Examples
Manipulate by text format using paragraph style.```csharp var document = new Document(); var page = new Page(); var outline = new Outline(); var outlineElem = new OutlineElement();
var text = new RichText() { ParagraphStyle = new ParagraphStyle() { FontName = "Courier New", FontSize = 20 } }
.Append($"DefaultParagraphFontAndSize{Environment.NewLine}")
.Append($"OnlyDefaultParagraphFont{Environment.NewLine}", new TextStyle() { FontSize = 14 })
.Append("OnlyDefaultParagraphFontSize", new TextStyle() { FontName = "Verdana" });
outlineElem.AppendChildLast(text);
outline.AppendChildLast(outlineElem);
page.AppendChildLast(outline);
document.AppendChildLast(page);
document.Save(Path.Combine(RunExamples.GetDataDir_Text(), "SetDefaultParagraphStyle.one"));
Shows how to bind a hyperlink to a text.```csharp
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tasks();
// Create an object of the Document class
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// Add outline elements
outline.AppendChildLast(outlineElem);
// Initialize Title class object
Title title = new Title() { TitleText = titleText };
// Initialize Page class object
Page page = new Note.Page() { Title = title };
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);AppendFront(string)
Adds a string to the front of the first text range.
public RichText AppendFront(string value)Parameters
value string
The added value.
Returns
The Aspose.Note.RichText.
AppendFront(string, TextStyle)
Adds a string to the front.
public RichText AppendFront(string value, TextStyle style)Parameters
value string
The added value.
style TextStyle
The style of added string.
Returns
The Aspose.Note.RichText.
Clear()
Clears content of this instance.
public RichText Clear()Returns
The Aspose.Note.RichText.
GetEnumerator()
Returns an enumerator that iterates through characters of this RichText object.
public IEnumerator<char> GetEnumerator()Returns
IEnumerator<char>
The System.Collections.IEnumerator.
IndexOf(string, int, int, StringComparison)
Returns the zero-based index of the first occurrence of the specified string in the current instance.
public int IndexOf(string value, int startIndex, int count, StringComparison comparisonType)Parameters
value string
The value.
startIndex int
The starting search position
count int
The count.
comparisonType StringComparison
The type of search to use for the specified string
Returns
The System.Int32.
IndexOf(string, int, StringComparison)
Returns the zero-based index of the first occurrence of the specified string in the current instance. Parameters specify the starting search position in the current string and the type of search to use for the specified string.
public int IndexOf(string value, int startIndex, StringComparison comparisonType)Parameters
value string
The value.
startIndex int
The starting search position
comparisonType StringComparison
The type of search to use for the specified string
Returns
The System.Int32.
IndexOf(char, int, int)
Returns the zero-based index of the first occurrence of the specified character in this instance. The search starts at a specified character position and examines a specified number of character positions.
public int IndexOf(char value, int startIndex, int count)Parameters
value char
The value.
startIndex int
The starting search position
count int
The count.
Returns
The System.Int32.
IndexOf(string, StringComparison)
Returns the zero-based index of the first occurrence of the specified string in the current instance. A parameter specifies the type of search to use for the specified string.
public int IndexOf(string value, StringComparison comparisonType)Parameters
value string
The value.
comparisonType StringComparison
The type of search to use for the specified string
Returns
The System.Int32.
IndexOf(string, int, int)
Returns the zero-based index of the first occurrence of the specified string in this instance. The search starts at a specified character position and examines a specified number of character positions.
public int IndexOf(string value, int startIndex, int count)Parameters
value string
The value.
startIndex int
The starting search position
count int
The count.
Returns
The System.Int32.
IndexOf(char, int)
Returns the zero-based index of the first occurrence of the specified Unicode character in this string. The search starts at a specified character position.
public int IndexOf(char value, int startIndex)Parameters
value char
The value.
startIndex int
The starting search position
Returns
The System.Int32.
IndexOf(string)
Returns the zero-based index of the first occurrence of the specified string in this instance.
public int IndexOf(string value)Parameters
value string
The value.
Returns
The System.Int32.
IndexOf(char)
Returns the zero-based index of the first occurrence of the specified Unicode character in this string.
public int IndexOf(char value)Parameters
value char
The value.
Returns
The System.Int32.
IndexOf(string, int)
Returns the zero-based index of the first occurrence of the specified string in this instance. The search starts at a specified character position.
public int IndexOf(string value, int startIndex)Parameters
value string
The value.
startIndex int
The starting search position
Returns
The System.Int32.
Insert(int, string)
Inserts a specified string at a specified index position in this instance.
public RichText Insert(int startIndex, string value)Parameters
startIndex int
The start index.
value string
The value.
Returns
The Aspose.Note.RichText.
Exceptions
Insert(int, string, TextStyle)
Inserts a specified string with specified style at a specified index position in this instance.
public RichText Insert(int startIndex, string value, TextStyle style)Parameters
startIndex int
The start index.
value string
The value.
style TextStyle
The style.
Returns
The Aspose.Note.RichText.
Exceptions
Remove(int, int)
Removes specified number of characters in the current instance beginning at a specified position.
public RichText Remove(int startIndex, int count)Parameters
startIndex int
The start index.
count int
The count.
Returns
The Aspose.Note.RichText.
Exceptions
Remove(int)
Removes all the characters in the current instance, beginning at a specified position and continuing through the last position.
public RichText Remove(int startIndex)Parameters
startIndex int
The start index.
Returns
The Aspose.Note.RichText.
Exceptions
Replace(char, char)
Replaces all occurrences of a specified Unicode character in this instance with another specified Unicode character.
public RichText Replace(char oldChar, char newChar)Parameters
oldChar char
The old char.
newChar char
The new char.
Returns
The Aspose.Note.RichText.
Replace(string, string)
Replaces all occurrences of a specified string in the current instance with another specified string.
public RichText Replace(string oldValue, string newValue)Parameters
oldValue string
The old value.
newValue string
The new value.
Returns
The Aspose.Note.RichText.
Examples
Shows how to pass through page’s text and make a replacement.```csharp // The path to the documents directory. string dataDir = RunExamples.GetDataDir_Text();
Dictionary<string, string=""> replacements = new Dictionary<string, string="">();
replacements.Add("voice over", "voice over new text");
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");
IList<page> pageNodes = oneFile.GetChildNodes<page>();
// Get all RichText nodes
IList<richtext> textNodes = pageNodes[0].GetChildNodes<richtext>();
foreach (RichText richText in textNodes)
{
foreach (KeyValuePair<string, string=""> kvp in replacements)
{
// Replace text of a shape
richText.Replace(kvp.Key, kvp.Value);
}
}
// Save to any supported file format
dataDir = dataDir + "ReplaceTextOnParticularPage_out.pdf";
oneFile.Save(dataDir, SaveFormat.Pdf);</string,></richtext></richtext></page></page></string,></string,>
Shows how to generate a new document by replacing special text pieces in a template.```csharp
string dataDir = RunExamples.GetDataDir_Text();
var D = new Dictionary<string, string="">
{
{ "Company", "Atlas Shrugged Ltd" },
{ "CandidateName", "John Galt" },
{ "JobTitle", "Chief Entrepreneur Officer" },
{ "Department", "Sales" },
{ "Salary", "123456 USD" },
{ "Vacation", "30" },
{ "StartDate", "29 Feb 2024" },
{ "YourName", "Ayn Rand" }
};
// Load the template document into Aspose.Note.
var d = new Document(Path.Combine(dataDir, "JobOffer.one"));
// Let's replace all template words
foreach (var e in d.GetChildNodes<richtext>())
{
foreach (var replace in D)
{
e.Replace($"${{{replace.Key}}}", replace.Value);
}
}
d.Save(Path.Combine(dataDir, "JobOffer_out.one"));</richtext></string,>Exceptions
Replace(string, string, TextStyle)
Replaces all occurrences of a specified string in the current instance with another specified string in specified style.
public RichText Replace(string oldValue, string newValue, TextStyle style)Parameters
oldValue string
The old value.
newValue string
The new value.
style TextStyle
The style of the new value.
Returns
The Aspose.Note.RichText.
Exceptions
Trim(params char[])
Removes all leading and trailing occurrences of a set of characters specified in an array.
public RichText Trim(params char[] trimChars)Parameters
trimChars char[]
The trim chars.
Returns
The Aspose.Note.RichText.
Trim(char)
Removes all leading and trailing instances of a characte.
public RichText Trim(char trimChar)Parameters
trimChar char
The trim char.
Returns
The Aspose.Note.RichText.
Trim()
Removes all leading and trailing white-space characters.
public RichText Trim()Returns
The Aspose.Note.RichText.
TrimEnd(params char[])
Removes all the trailing occurrences of a set of characters specified in an array.
public RichText TrimEnd(params char[] trimChars)Parameters
trimChars char[]
The trim chars.
Returns
The Aspose.Note.RichText.
TrimEnd(char)
Removes all the trailing occurrences of a character.
public RichText TrimEnd(char trimChar)Parameters
trimChar char
The trim char.
Returns
The Aspose.Note.RichText.
TrimEnd()
Removes all the trailing white-space characters.
public RichText TrimEnd()Returns
The Aspose.Note.RichText.
TrimStart(params char[])
Removes all the leading occurrences of a set of characters specified in an array.
public RichText TrimStart(params char[] trimChars)Parameters
trimChars char[]
The trim chars.
Returns
The Aspose.Note.RichText.
TrimStart(char)
Removes all the leading occurrences of a specified character.
public RichText TrimStart(char trimChar)Parameters
trimChar char
The trim char.
Returns
The Aspose.Note.RichText.
TrimStart()
Removes all the leading white-space characters.
public RichText TrimStart()Returns
The Aspose.Note.RichText. </char>