diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index c55fb27e2d..2aa011d2ee 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -7912,6 +7912,12 @@
  • Loading and Saving document
    • +
  • + Working with Paragraphs +
    • +
  • + Working with BlockQuotes +
    • diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md new file mode 100644 index 0000000000..e8e051a0d2 --- /dev/null +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md @@ -0,0 +1,569 @@ +--- +title: Working with Blockquotes in .NET Markdown Library | Syncfusion +description: Learn how to create, format, and manipulate blockquotes in a Markdown document using the Syncfusion .NET Markdown library. +platform: document-processing +control: Markdown +documentation: UG +--- + +# Working with Blockquotes in Markdown Library + +Blockquotes are used to highlight quoted text, notes, warnings, or other content that needs visual distinction from the main text. In the Syncfusion Markdown library, blockquotes are created using the `HasBlockquote` and `BlockQuoteLevel` properties of the `MdParagraph` class. Blockquotes support single-level and multi-level nesting, and can contain formatted text, links, and other inline elements. + +## Adding a Blockquote + +The following code example demonstrates how to add a simple blockquote to a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + + // Creates a new MarkdownDocument instance + MarkdownDocument markdownDocument = new MarkdownDocument(); + // Adds a new paragraph to the document + MdParagraph paragraph = markdownDocument.AddParagraph(); + // Enables blockquote for the paragraph + paragraph.HasBlockquote = true; + // Sets the blockquote level to 1 + paragraph.BlockQuoteLevel = 1; + // Adds text to the blockquote paragraph. + paragraph.AddTextRange().Text = "This is a simple blockquote in a Markdown document."; + // Gets the Markdown text of the document + string markdownText = markdownDocument.GetMarkdownText(); + // Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8); + // Disposes the document + markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +paragraph.HasBlockquote = True +' Sets the blockquote level to 1 +paragraph.BlockQuoteLevel = 1 +' Adds text to the blockquote paragraph. +paragraph.AddTextRange().Text = "This is a simple blockquote in a Markdown document." +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Applying Blockquote Style Using ApplyParagraphStyle + +You can also create a blockquote by applying the `"Quote"` style using the `ApplyParagraphStyle` method of the `MdParagraph` class. This is equivalent to setting `HasBlockquote = true` and `BlockQuoteLevel = 1`. + +The following code example demonstrates how to create a blockquote using the `ApplyParagraphStyle` method. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + + // Creates a new Markdown document. + MarkdownDocument markdownDocument = new MarkdownDocument(); + // Adds a new paragraph + MdParagraph paragraph = markdownDocument.AddParagraph(); + // Applies the Quote paragraph style + paragraph.ApplyParagraphStyle("Quote"); + // Adds text to the blockquote paragraph. + paragraph.AddTextRange().Text = "This blockquote is created using paragraph style."; + // Gets the Markdown text of the document. + string markdownText = markdownDocument.GetMarkdownText(); + // Saves the Markdown document to the file system. + File.WriteAllText("Output.md", markdownText, Encoding.UTF8); + // Disposes the document to release all memory. + markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + + ' Creates a new Markdown document. + Dim markdownDocument As New MarkdownDocument() + ' Adds a new paragraph + Dim paragraph As MdParagraph = markdownDocument.AddParagraph() + ' Applies the Quote paragraph style + paragraph.ApplyParagraphStyle("Quote") + ' Adds text to the blockquote paragraph. + paragraph.AddTextRange().Text = "This blockquote is created using paragraph style." + ' Gets the Markdown text of the document. + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system. + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + ' Disposes the document to release all memory. + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Adding Leading Space + +By default, blockquote are followed by without a leading space. You can add a leading space after the blockquote paragraph by setting the `BlockQuoteHasLeadingSpace` property to `true`. + +The following code example demonstrates how to add the leading space to blockquotes. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new Markdown document. +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph +MdParagraph firstParagraph = markdownDocument.AddParagraph(); +// Adds text to the blockquote paragraph. +firstParagraph.AddTextRange().Text = "First paragraph of the document"; +// Adds a new paragraph +MdParagraph secondParagraph = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +secondParagraph.HasBlockquote = true; +// Sets the blockquote level to 1 +secondParagraph.BlockQuoteLevel = 1; +// Enables blockquote has leading space for the paragraph +secondParagraph.BlockQuoteHasLeadingSpace = true; +// Adds text to the blockquote paragraph. +secondParagraph.AddTextRange().Text = "This quote shows a leading space."; +// Adds a new paragraph +MdParagraph thirdParagraph = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +thirdParagraph.HasBlockquote = true; +// Sets the blockquote level to 1 +thirdParagraph.BlockQuoteLevel = 1; +// Blockquote has no leading space for the paragraph - Default values as False. +thirdParagraph.BlockQuoteHasLeadingSpace = false; +// Adds text to the blockquote paragraph. +thirdParagraph.AddTextRange().Text = "This quote has no leading space."; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new Markdown document. +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph +Dim firstParagraph As MdParagraph = markdownDocument.AddParagraph() +' Adds text to the blockquote paragraph. +firstParagraph.AddTextRange().Text = "First paragraph of the document" +' Adds a new paragraph +Dim secondParagraph As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +secondParagraph.HasBlockquote = True +' Sets the blockquote level to 1 +secondParagraph.BlockQuoteLevel = 1 +' Enables blockquote has leading space for the paragraph +secondParagraph.BlockQuoteHasLeadingSpace = True +' Adds text to the blockquote paragraph. +secondParagraph.AddTextRange().Text = "This quote shows a leading space." +' Adds a new paragraph +Dim thirdParagraph As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +thirdParagraph.HasBlockquote = True +' Sets the blockquote level to 1 +thirdParagraph.BlockQuoteLevel = 1 +' Blockquote has no leading space for the paragraph - Default values as False. +thirdParagraph.BlockQuoteHasLeadingSpace = False +' Adds text to the blockquote paragraph. +thirdParagraph.AddTextRange().Text = "This quote has no leading space." +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + + +## Creating Nested Blockquotes + +Blockquotes can be nested to represent hierarchical quoted content, such as replies in email threads or multi-level notes. The `BlockQuoteLevel` property controls the nesting level, with values starting from 1 for the first level. + +The following code example demonstrates how to create nested blockquotes. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph +MdParagraph blockLevel1 = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +blockLevel1.HasBlockquote = true; +// Sets the blockquote level +blockLevel1.BlockQuoteLevel = 1; +// Adds text to the blockquote paragraph. +blockLevel1.AddTextRange().Text = "This is the first level blockquote."; +// Adds a level 2 blockquote (nested) +MdParagraph blockLevel2 = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +blockLevel2.HasBlockquote = true; +// Sets the blockquote level +blockLevel2.BlockQuoteLevel = 2; +// Adds text to the blockquote paragraph. +blockLevel2.AddTextRange().Text = "This is the second level blockquote."; +// Adds a level 3 blockquote (double nested) +MdParagraph blockLevel3 = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +blockLevel3.HasBlockquote = true; +// Sets the blockquote level +blockLevel3.BlockQuoteLevel = 3; +// Adds text to the blockquote paragraph. +blockLevel3.AddTextRange().Text = "This is the third level blockquote."; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph +Dim blockLevel1 As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +blockLevel1.HasBlockquote = True +' Sets the blockquote level +blockLevel1.BlockQuoteLevel = 1 +' Adds text to the blockquote paragraph. +blockLevel1.AddTextRange().Text = "This is the first level blockquote." +' Adds a level 2 blockquote (nested) +Dim blockLevel2 As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +blockLevel2.HasBlockquote = True +' Sets the blockquote level +blockLevel2.BlockQuoteLevel = 2 +' Enables blockquote has leading space for the paragraph +blockLevel2.BlockQuoteHasLeadingSpace = True +' Adds text to the blockquote paragraph. +blockLevel2.AddTextRange().Text = "This is the second level blockquote." +' Adds a level 3 blockquote (double nested) +Dim blockLevel3 As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +blockLevel3.HasBlockquote = True +' Sets the blockquote level +blockLevel3.BlockQuoteLevel = 3 +' Enables blockquote has leading space for the paragraph +blockLevel3.BlockQuoteHasLeadingSpace = True +' Adds text to the blockquote paragraph. +blockLevel3.AddTextRange().Text = "This is the third level blockquote." +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Applying Text Formatting in a Blockquote + +Blockquotes can contain formatted text such as bold, italic, strikethrough, and inline code. You can apply formatting to text within a blockquote using the `MdTextFormat` class. + +The following code example demonstrates how to apply text formatting within a blockquote. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new Markdown document. +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph firstQuote = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +firstQuote.HasBlockquote = true; +// Enables blockquote has leading space for the paragraph +firstQuote.BlockQuoteHasLeadingSpace = true; +// Sets the blockquote level to 1 +firstQuote.BlockQuoteLevel = 1; +// Adds plain text to the blockquote paragraph. +firstQuote.AddTextRange().Text = "This is the "; +// Adds bold text to the blockquote paragraph. +MdTextRange boldText = firstQuote.AddTextRange(); +boldText.Text = "first level"; +boldText.TextFormat.Bold = true; +// Adds a new paragraph to the document +MdParagraph secondQuote = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +secondQuote.HasBlockquote = true; +// Enables blockquote has leading space for the paragraph +secondQuote.BlockQuoteHasLeadingSpace = true; +// Sets the blockquote level to 1 +secondQuote.BlockQuoteLevel = 1; +// Adds plain text to the blockquote paragraph. +secondQuote.AddTextRange().Text = "This is the "; +// Adds italic text to the blockquote paragraph. +MdTextRange italicText = secondQuote.AddTextRange(); +italicText.Text = "first level"; +italicText.TextFormat.Italic = true; +// Adds a new paragraph to the document +MdParagraph thirdQuote = markdownDocument.AddParagraph(); +// Enables blockquote for the paragraph +thirdQuote.HasBlockquote = true; +// Enables blockquote has leading space for the paragraph +thirdQuote.BlockQuoteHasLeadingSpace = true; +// Sets the blockquote level to 1 +thirdQuote.BlockQuoteLevel = 1; +// Adds plain text to the blockquote paragraph. +thirdQuote.AddTextRange().Text = "This is the "; +// Adds italic text to the blockquote paragraph. +MdTextRange codespanText = thirdQuote.AddTextRange(); +codespanText.Text = "first level"; +codespanText.TextFormat.CodeSpan = true; +// Gets the Markdown text of the document. +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system. +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document to release all memory. +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new Markdown document. +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim firstQuote As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +firstQuote.HasBlockquote = True +' Enables blockquote has leading space for the paragraph +firstQuote.BlockQuoteHasLeadingSpace = True +' Sets the blockquote level to 1 +firstQuote.BlockQuoteLevel = 1 +' Adds plain text to the blockquote paragraph. +firstQuote.AddTextRange().Text = "This is the " +' Adds bold text to the blockquote paragraph. +Dim boldText As MdTextRange = firstQuote.AddTextRange() +boldText.Text = "first level" +boldText.TextFormat.Bold = True +' Adds a new paragraph to the document +Dim secondQuote As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +secondQuote.HasBlockquote = True +' Enables blockquote has leading space for the paragraph +secondQuote.BlockQuoteHasLeadingSpace = True +' Sets the blockquote level to 1 +secondQuote.BlockQuoteLevel = 1 +' Adds plain text to the blockquote paragraph. +secondQuote.AddTextRange().Text = "This is the " +' Adds italic text to the blockquote paragraph. +Dim italicText As MdTextRange = secondQuote.AddTextRange() +italicText.Text = "first level" +italicText.TextFormat.Italic = True +' Adds a new paragraph to the document +Dim thirdQuote As MdParagraph = markdownDocument.AddParagraph() +' Enables blockquote for the paragraph +thirdQuote.HasBlockquote = True +' Enables blockquote has leading space for the paragraph +thirdQuote.BlockQuoteHasLeadingSpace = True +' Sets the blockquote level to 1 +thirdQuote.BlockQuoteLevel = 1 +' Adds plain text to the blockquote paragraph. +thirdQuote.AddTextRange().Text = "This is the " +' Adds italic text to the blockquote paragraph. +Dim codespanText As MdTextRange = thirdQuote.AddTextRange() +codespanText.Text = "first level" +codespanText.TextFormat.CodeSpan = True +' Gets the Markdown text of the document. +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system. +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document to release all memory. +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Modifying an Existing Blockquote + +Modify an existing blockquote in a Markdown document by iterating over the `Blocks` collection and updating the `HasBlockquote`, `BlockQuoteLevel`, or inline text content. + +The following code example demonstrates how to modify an existing blockquote. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + + FileStream fileStream = new FileStream(Path.GetFullPath(@"Data\Input.md"), FileMode.Open, FileAccess.Read, FileShare.ReadWrite); + MdImportSettings settings = new MdImportSettings(); + // Opens an existing document + MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, settings); + // Iterates through the blocks of the document + foreach (IMdBlock block in markdownDocument.Blocks) + { + // Checks whether the block is a paragraph + if (block is MdParagraph) + { + MdParagraph paragraph = block as MdParagraph; + // Checks whether the paragraph is a blockquote + if (paragraph.HasBlockquote) + { + // Increases the nesting level of the blockquote. + paragraph.BlockQuoteLevel++; + // Iterates through the inline elements of the blockquote. + foreach (IMdInline inline in paragraph.Inlines) + { + if (inline is MdTextRange textRange) + { + // Modifies the text content. + textRange.Text = "Modified blockquote content."; + break; + } + } + break; + } + } + } + // Gets the Markdown text of the document + string markdownText = markdownDocument.GetMarkdownText(); + // Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8); + // Disposes the document + markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +Dim fileStream As New FileStream(Path.GetFullPath("Data\Input.md"), FileMode.Open, FileAccess.Read, FileShare.ReadWrite) +Dim settings As New MdImportSettings() +' Opens an existing document +Dim markdownDocument As New MarkdownDocument(fileStream, settings) +' Iterates through the blocks of the document +For Each block As IMdBlock In markdownDocument.Blocks + ' Checks whether the block is a paragraph + If TypeOf block Is MdParagraph Then + Dim paragraph As MdParagraph = TryCast(block, MdParagraph) + ' Checks whether the paragraph is a blockquote + If paragraph.HasBlockquote Then + ' Increases the nesting level of the blockquote. + paragraph.BlockQuoteLevel += 1 + ' Iterates through the inline elements of the blockquote. + For Each inline As IMdInline In paragraph.Inlines + If TypeOf inline Is MdTextRange Then + Dim textRange As MdTextRange = TryCast(inline, MdTextRange) + ' Modifies the text content. + textRange.Text = "Modified blockquote content." + Exit For + End If + Next + Exit For + End If + End If +Next +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Removing a Blockquote + +The following code example demonstrates how to remove blockquote from paragraphs. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Opens an existing Markdown document. +FileStream fileStream = new FileStream(Path.GetFullPath(@"Data\Input.md"), FileMode.Open, FileAccess.Read); +MdImportSettings settings = new MdImportSettings(); +MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, settings); + // Iterates through the blocks of the document. + foreach (IMdBlock block in markdownDocument.Blocks) + { + // Checks whether the block is a paragraph + if (block is MdParagraph) + { + MdParagraph paragraph = block as MdParagraph; + // Checks whether the paragraph is a blockquote + if (paragraph.HasBlockquote) + { + // Removes the blockquote. + paragraph.HasBlockquote = false; + paragraph.BlockQuoteLevel = 0; + break; + } + } + } +// Gets the Markdown text of the document. +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system. +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document to release all memory. +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Opens an existing Markdown document. +Dim fileStream As New FileStream(Path.GetFullPath("Data\Input.md"), FileMode.Open, FileAccess.Read) +Dim settings As New MdImportSettings() +Dim markdownDocument As New MarkdownDocument(fileStream, settings) +' Iterates through the blocks of the document. +For Each block As IMdBlock In markdownDocument.Blocks + ' Checks whether the block is a paragraph + If TypeOf block Is MdParagraph Then + Dim paragraph As MdParagraph = TryCast(block, MdParagraph) + ' Checks whether the paragraph is a blockquote + If paragraph.HasBlockquote Then + ' Removes the blockquote. + paragraph.HasBlockquote = False + paragraph.BlockQuoteLevel = 0 + Exit For + End If + End If +Next +' Gets the Markdown text of the document. +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system. +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document to release all memory. +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. \ No newline at end of file diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md new file mode 100644 index 0000000000..fa92acdd5f --- /dev/null +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md @@ -0,0 +1,443 @@ +--- +title: Working with Images in .NET Markdown library | Syncfusion +description: Learn to add, format, and modify images in a Markdown document using Syncfusion® .NET Markdown library without any third-party dependencies. +platform: document-processing +control: Markdown +documentation: UG +--- + +# Working with Images + +Images are essential elements of Markdown documents that enhance visual communication and documentation. The Syncfusion® Markdown library facilitates adding, modifying, and managing images in a Markdown document. Images in Markdown are represented by the `MdPicture` class, which is an inline element that can be added to a `MdParagraph`. The library supports both URL-based and byte array-based images, allowing you to reference external image files or embed images directly into the document. + +## Adding image from URL + +An image can be added to a paragraph in a Markdown document by creating an instance of the `MdPicture` class and adding it to the paragraph's inline collection. + +The following code example demonstrates how to add a new image to a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Creates a new picture instance +MdPicture image = new MdPicture(); +// Adds the image to the paragraph +paragraph.Inlines.Add(image); +// Sets the image URL +image.Url = "https://example.com/images/logo.png"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Creates a new picture instance +Dim image As New MdPicture() +' Adds the image to the paragraph +paragraph.Inlines.Add(image) +' Sets the image URL +image.Url = "https://example.com/images/logo.png" +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + +### Adding image from relative path + +Images can also be add images using relative file paths, which is useful for organizing documentation with local image resources. The following code example demonstrates how to add an image from a relative path. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Creates a new picture instance +MdPicture image = new MdPicture(); +// Adds the image to the paragraph +paragraph.Inlines.Add(image); +// Sets the relative path to the image +image.Url = "./Data/Adventure Cycle.png"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + + ' Creates a new MarkdownDocument instance + Dim markdownDocument As New MarkdownDocument() + ' Adds a new paragraph to the document + Dim paragraph As MdParagraph = markdownDocument.AddParagraph() + ' Creates a new picture instance + Dim image As New MdPicture() + ' Adds the image to the paragraph + paragraph.Inlines.Add(image) + ' Sets the relative path to the image + image.Url = "./Data/Adventure Cycle.png" + ' Gets the Markdown text of the document + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + 'Disposes the document + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + +### Adding image from local file path + +The Syncfusion Markdown library supports adding images from absolute local file paths. The following code example demonstrates how to add an image from a local file path. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Creates a new picture instance +MdPicture image = new MdPicture(); +// Adds the image to the paragraph +paragraph.Inlines.Add(image); +// Sets the absolute file path +image.Url = "C:\\Images\\Adventure Cycle.png"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Creates a new picture instance +Dim image As New MdPicture() +' Adds the image to the paragraph +paragraph.Inlines.Add(image) +' Sets the absolute file path +image.Url = "C:\Images\Adventure Cycle.png" +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + +### Adding image from image bytes + +The Syncfusion Markdown library allows embedding images directly into a Markdown document using byte arrays. This is particularly useful when you need to include images that are dynamically generated, retrieved from a database, or loaded from memory. When using image bytes, the library **automatically encodes the image data as a base64 data URI in the Markdown output**. + +The following code example demonstrates how to load an image from a file and embed it as byte data in a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + + // Creates a new MarkdownDocument instance + MarkdownDocument markdownDocument = new MarkdownDocument(); + // Adds a new paragraph to the document + MdParagraph paragraph = markdownDocument.AddParagraph(); + // Loads image bytes from file + byte[] imageBytes = File.ReadAllBytes(Path.GetFullPath(@"../../Data/Adventure Cycle.png")); + // Creates a new picture instance + MdPicture image = new MdPicture(); + // Adds the image to the paragraph + paragraph.Inlines.Add(image); + // Sets the image bytes + image.ImageBytes = imageBytes; + // Gets the Markdown text of the document (image will be base64-encoded) + string markdownText = markdownDocument.GetMarkdownText(); + // Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8); + // Disposes the document + markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Loads image bytes from file +Dim imageBytes() As Byte = File.ReadAllBytes(Path.GetFullPath("../../Data/Adventure Cycle.png")) +' Creates a new picture instance +Dim image As New MdPicture() +' Adds the image to the paragraph +paragraph.Inlines.Add(image) +' Sets the image bytes +image.ImageBytes = imageBytes +' Gets the Markdown text of the document (image will be base64-encoded) +Dim markdownText As String = markdownDocument.GetMarkdownText() +'Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +'Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + +N> When using the `ImageBytes` property, the Markdown output contains a base64-encoded data URI in the format. + +## Replacing images + +An existing image in a Markdown document can be replaced by iterating through the paragraph's inline collection and modifying the properties of the `MdPicture` instance. + +The following code example demonstrates how to replace an existing image. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Opens an existing Markdown document +FileStream fileStream = new FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite); +MdImportSettings importSettings = new MdImportSettings(); +MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, importSettings); +// Iterates through the blocks of the document +foreach (IMdBlock block in markdownDocument.Blocks) +{ + if (block is MdParagraph paragraph) + { + // Iterates through the inline elements of the paragraph + foreach (IMdInline inline in paragraph.Inlines) + { + if (inline is MdPicture picture) + { + // Replaces the image URL + if (picture.Url.Contains("Adventure Cycle.png")) + { + picture.Url = "./images/Adventure Cycle.png"; + break; + } + } + } + } +} +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Opens an existing Markdown document +Dim fileStream As New FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite) +Dim importSettings As New MdImportSettings() +Dim markdownDocument As New MarkdownDocument(fileStream, importSettings) +' Iterates through the blocks of the document +For Each block As IMdBlock In markdownDocument.Blocks + If TypeOf block Is MdParagraph Then + Dim paragraph As MdParagraph = TryCast(block, MdParagraph) + ' Iterates through the inline elements of the paragraph + For Each inline As IMdInline In paragraph.Inlines + If TypeOf inline Is MdPicture Then + Dim picture As MdPicture = TryCast(inline, MdPicture) + ' Replaces the image URL + If picture.Url.Contains("Adventure Cycle.png") Then + picture.Url = "./images/Adventure Cycle.png" + Exit For + End If + End If + Next + End If +Next +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + +## Removing images + +Images can be removed from a Markdown document by iterating through the paragraph's inline collection and removing the `MdPicture` instances. + +The following code example demonstrates how to remove images from a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Opens an existing Markdown document +FileStream fileStream = new FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite); +MdImportSettings importSettings = new MdImportSettings(); +MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, importSettings); +// Iterates through the blocks of the document +foreach (IMdBlock block in markdownDocument.Blocks) +{ + if (block is MdParagraph paragraph) + { + // Iterates through the inline elements in reverse to safely remove items + for (int i = paragraph.Inlines.Count - 1; i >= 0; i--) + { + if (paragraph.Inlines[i] is MdPicture) + { + // Removes the image from the paragraph + paragraph.Inlines.RemoveAt(i); + break; + } + } + } +} +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Opens an existing Markdown document +Dim fileStream As New FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite) +Dim importSettings As New MdImportSettings() +Dim markdownDocument As New MarkdownDocument(fileStream, importSettings) +' Iterates through the blocks of the document +For Each block As IMdBlock In markdownDocument.Blocks + If TypeOf block Is MdParagraph Then + Dim paragraph As MdParagraph = TryCast(block, MdParagraph) + ' Iterates through the inline elements in reverse to safely remove items + For i As Integer = paragraph.Inlines.Count - 1 To 0 Step -1 + If TypeOf paragraph.Inlines(i) Is MdPicture Then + ' Removes the image from the paragraph + paragraph.Inlines.RemoveAt(i) + Exit For + End If + Next + End If +Next +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + + +## Working with alternative text + +Alternative text (alt text) is essential for accessibility, providing textual descriptions of images for screen readers and situations where images cannot be displayed. The Syncfusion Markdown library allows you to set and modify alternative text for images using the `AltText` property. + +The following code example demonstrates how to add descriptive alternative text to images. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a paragraph for the chart image +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Creates a new picture instance +MdPicture picture = new MdPicture(); +// Adds the image to the paragraph +paragraph.Inlines.Add(picture); +// Sets the image URL +picture.Url = "./images/Adventure Cycle.png"; +// Sets descriptive alternative text for accessibility +picture.AltText = "Adventure Cycle Image"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + + ' Creates a new MarkdownDocument instance + Dim markdownDocument As New MarkdownDocument() + ' Adds a paragraph for the chart image + Dim paragraph As MdParagraph = markdownDocument.AddParagraph() + ' Creates a new picture instance + Dim picture As New MdPicture() + ' Adds the image to the paragraph + paragraph.Inlines.Add(picture) + ' Sets the image URL + picture.Url = "./images/Adventure Cycle.png" + ' Sets descriptive alternative text for accessibility + picture.AltText = "Adventure Cycle Image" + ' Gets the Markdown text of the document + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + ' Disposes the document + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +A complete working sample is available on GitHub. + + + diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md new file mode 100644 index 0000000000..ea15012bec --- /dev/null +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md @@ -0,0 +1,711 @@ +--- +title: Working with Paragraph in .NET Markdown Library | Syncfusion +description: Learn how to add, format, and modify paragraphs in a Markdown document using the .NET Markdown library. +platform: document-processing +control: Markdown +documentation: UG +--- + +# Working with Paragraph in Markdown Library + +A paragraph is the basic building block of a Markdown document. All textual content in a Markdown document is represented by the `MdParagraph` class. Each paragraph contains a collection of inline elements such as text ranges, hyperlinks, and images, which are represented by the `Inlines` property. The `IMdInline` interface is the base interface for all inline elements. The following elements can be the child elements of a paragraph: + +- **Text**: Represented by an instance of `MdTextRange`. +- **Hyperlink**: Represented by an instance of `MdHyperlink`. +- **Image**: Represented by an instance of `MdPicture`. + + +## Adding a paragraph + +The following code example demonstrates how to create a new paragraph in a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new Markdown document +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Adds a text range to the paragraph +paragraph.AddTextRange().Text = "Adventure Works Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company."; +// Retrieves the Markdown document content +string mdContent = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", mdContent, Encoding.UTF8); +// Disposes the document to release all memory +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new Markdown document +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Adds a text range to the paragraph +paragraph.AddTextRange().Text = "Adventure Works Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company." +' Retrieves the Markdown document content +Dim mdContent As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", mdContent, Encoding.UTF8) +' Disposes the document to release all memory +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Modifying an existing paragraph + +Modify the content of an existing paragraph in a Markdown document by iterating over the `Blocks` collection and accessing the inline elements. The following code example demonstrates how to modify an existing paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + + // Opens an existing Markdown document + FileStream fileStream = new FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite); + MdImportSettings settings = new MdImportSettings(); + MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, settings); + // Iterates through the blocks of the document + foreach (IMdBlock block in markdownDocument.Blocks) + { + if (block is MdParagraph) + { + MdParagraph paragraph = block as MdParagraph; + // Iterates through the inline elements of the paragraph + foreach (IMdInline inline in paragraph.Inlines) + { + if (inline is MdTextRange) + { + MdTextRange textRange = inline as MdTextRange; + // Modifies the text content + textRange.Text = "Modified paragraph content."; + break; + } + } + break; + } + } + // Gets the Markdown text of the document + string markdownText = markdownDocument.GetMarkdownText(); + // Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8); + // Disposes the document + markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Opens an existing Markdown document +Dim fileStream As New FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite) +Dim settings As New MdImportSettings() +Dim markdownDocument As New MarkdownDocument(fileStream, settings) +' Iterates through the blocks of the document +For Each block As IMdBlock In markdownDocument.Blocks + If TypeOf block Is MdParagraph Then + Dim paragraph As MdParagraph = TryCast(block, MdParagraph) + ' Iterates through the inline elements of the paragraph + For Each inline As IMdInline In paragraph.Inlines + If TypeOf inline Is MdTextRange Then + Dim textRange As MdTextRange = TryCast(inline, MdTextRange) + ' Modifies the text content + textRange.Text = "Modified paragraph content." + Exit For + End If + Next + Exit For + End If +Next +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Removing an existing paragraph + +Remove the existing paragraph in a Markdown document by iterating over the `Blocks` collection and accessing the paragraph. The following code example demonstrates how to remove an existing paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Opens an existing Markdown document +FileStream fileStream = new FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite); +MdImportSettings settings = new MdImportSettings(); +MarkdownDocument markdownDocument = new MarkdownDocument(fileStream, settings); +// Iterates through the blocks of the document +foreach (IMdBlock block in markdownDocument.Blocks) +{ + // Retrieves the first paragraph of the Blocks + if (block is MdParagraph) + { + // Removes the first paragraph from the document + markdownDocument.Blocks.Remove(block); + break; + } +} +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Opens an existing Markdown document + Dim fileStream As New FileStream("Input.md", FileMode.Open, FileAccess.Read, FileShare.ReadWrite) + Dim settings As New MdImportSettings() + Dim markdownDocument As New MarkdownDocument(fileStream, settings) + ' Iterates through the blocks of the document + For Each block As IMdBlock In markdownDocument.Blocks + ' Retrieves the first paragraph of the Blocks + If TypeOf block Is MdParagraph Then + ' Removes the first paragraph from the document + markdownDocument.Blocks.Remove(block) + Exit For + End If + Next + ' Gets the Markdown text of the document + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + ' Disposes the document + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Applying paragraph styles + +Paragraph styles define the visual appearance of a paragraph in a Markdown document. The Syncfusion Markdown library supports heading styles (Heading 1 through Heading 6), blockquote style, and the default normal paragraph style. You can apply a style to a paragraph by using the `ApplyParagraphStyle` method of the `MdParagraph` class. + +The following are the supported paragraph styles in the Syncfusion Markdown library: + +| Style Name | `ApplyParagraphStyle` argument | Markdown output | +|---|---|---| +| Normal | `"None"` | Plain paragraph | +| Heading 1 | `"Heading 1"` | `# Heading` | +| Heading 2 | `"Heading 2"` | `## Heading` | +| Heading 3 | `"Heading 3"` | `### Heading` | +| Heading 4 | `"Heading 4"` | `#### Heading` | +| Heading 5 | `"Heading 5"` | `##### Heading` | +| Heading 6 | `"Heading 6"` | `###### Heading` | +| Blockquote | `"Quote"` | `> Quote text` | + +### Applying heading styles + +The following code example demonstrates how to apply heading styles (Heading 1 through Heading 6) to paragraphs in a Markdown document. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a paragraph and applies the Heading 1 style +MdParagraph heading1 = markdownDocument.AddParagraph(); +heading1.ApplyParagraphStyle("Heading 1"); +heading1.AddTextRange().Text = "Heading 1"; +// Adds a paragraph and applies the Heading 2 style +MdParagraph heading2 = markdownDocument.AddParagraph(); +heading2.ApplyParagraphStyle("Heading 2"); +heading2.AddTextRange().Text = "Heading 2"; +// Adds a paragraph and applies the Heading 3 style +MdParagraph heading3 = markdownDocument.AddParagraph(); +heading3.ApplyParagraphStyle("Heading 3"); +heading3.AddTextRange().Text = "Heading 3"; +// Adds a paragraph and applies the Heading 4 style +MdParagraph heading4 = markdownDocument.AddParagraph(); +heading4.ApplyParagraphStyle("Heading 4"); +heading4.AddTextRange().Text = "Heading 4"; +// Adds a paragraph and applies the Heading 5 style +MdParagraph heading5 = markdownDocument.AddParagraph(); +heading5.ApplyParagraphStyle("Heading 5"); +heading5.AddTextRange().Text = "Heading 5"; +// Adds a paragraph and applies the Heading 6 style +MdParagraph heading6 = markdownDocument.AddParagraph(); +heading6.ApplyParagraphStyle("Heading 6"); +heading6.AddTextRange().Text = "Heading 6"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a paragraph and applies the Heading 1 style +Dim heading1 As MdParagraph = markdownDocument.AddParagraph() +heading1.ApplyParagraphStyle("Heading 1") +heading1.AddTextRange().Text = "Heading 1" +' Adds a paragraph and applies the Heading 2 style +Dim heading2 As MdParagraph = markdownDocument.AddParagraph() +heading2.ApplyParagraphStyle("Heading 2") +heading2.AddTextRange().Text = "Heading 2" +' Adds a paragraph and applies the Heading 3 style +Dim heading3 As MdParagraph = markdownDocument.AddParagraph() +heading3.ApplyParagraphStyle("Heading 3") +heading3.AddTextRange().Text = "Heading 3" +' Adds a paragraph and applies the Heading 4 style +Dim heading4 As MdParagraph = markdownDocument.AddParagraph() +heading4.ApplyParagraphStyle("Heading 4") +heading4.AddTextRange().Text = "Heading 4" +' Adds a paragraph and applies the Heading 5 style +Dim heading5 As MdParagraph = markdownDocument.AddParagraph() +heading5.ApplyParagraphStyle("Heading 5") +heading5.AddTextRange().Text = "Heading 5" +' Adds a paragraph and applies the Heading 6 style +Dim heading6 As MdParagraph = markdownDocument.AddParagraph() +heading6.ApplyParagraphStyle("Heading 6") +heading6.AddTextRange().Text = "Heading 6" +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Working with text + +Text within a paragraph is represented by one or more instances of `MdTextRange`. Each `MdTextRange` instance can have its own text formatting applied through the `MdTextFormat` class. + +The following code example demonstrates how to add text with formatting to a paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Adds a bold text range +MdTextRange firstText = paragraph.AddTextRange(); +firstText.Text = "A new text is added to the paragraph"; +firstText.TextFormat.Bold = true; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + + ' Creates a new MarkdownDocument instance + Dim markdownDocument As New MarkdownDocument() + ' Adds a new paragraph to the document + Dim paragraph As MdParagraph = markdownDocument.AddParagraph() + ' Adds a bold text range + Dim firstText As MdTextRange = paragraph.AddTextRange() + firstText.Text = "A new text is added to the paragraph" + firstText.TextFormat.Bold = True + ' Gets the Markdown text of the document + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + ' Disposes the document + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +### Appending a line break + +The following code example demonstrates how to add a line break to a paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph paragraph = markdownDocument.AddParagraph(); +// Adds the first text range with bold formatting +MdTextRange firstText = paragraph.AddTextRange(); +firstText.Text = "A first text range is added to the paragraph"; +firstText.TextFormat.Bold = true; +// Adds the text range for line break and enable the line break +MdTextRange lineBreak = paragraph.AddTextRange(); +lineBreak.IsLineBreak = true; +MdTextRange secondText = paragraph.AddTextRange(); +secondText.Text = "A second text range is added to the paragraph"; +secondText.TextFormat.Bold = true; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim paragraph As MdParagraph = markdownDocument.AddParagraph() +' Adds the first text range with bold formatting +Dim firstText As MdTextRange = paragraph.AddTextRange() +firstText.Text = "A first text range is added to the paragraph" +firstText.TextFormat.Bold = True +' Adds the text range for line break and enable the line break +Dim lineBreak = paragraph.AddTextRange() +lineBreak.IsLineBreak = True +Dim secondText As MdTextRange = paragraph.AddTextRange() +secondText.Text = "A second text range is added to the paragraph" +secondText.TextFormat.Bold = True +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +## Applying text formatting + +Text formatting enhances the appearance of text in a Markdown document. The `MdTextFormat` class provides formatting options such as bold, italic, strikethrough, inline code, subscript, and superscript. + +The following code example demonstrates how to apply various text formatting options. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph firstParagraph = markdownDocument.AddParagraph(); +// Apply bold for the text range +MdTextRange firstTextRange = firstParagraph.AddTextRange(); +firstTextRange.Text = "This is the first text range"; +firstTextRange.TextFormat.Bold = true; +// Add line break +MdTextRange lineBreak = firstParagraph.AddTextRange(); +lineBreak.IsLineBreak = true; +// Apply strikethrough for the second text range +MdTextRange secondTextRange = firstParagraph.AddTextRange(); +secondTextRange.Text = "This is the second text range"; +secondTextRange.TextFormat.StrikeThrough = true; +lineBreak = firstParagraph.AddTextRange(); +lineBreak.IsLineBreak = true; +// Apply italic for the third text range +MdTextRange thirdTextRange = firstParagraph.AddTextRange(); +thirdTextRange.Text = "This is the third text range"; +thirdTextRange.TextFormat.Italic = true; +// Add a Second Paragraph +MdParagraph secondParagraph = markdownDocument.AddParagraph(); +// Add text to the second paragraph +MdTextRange fourthTextRange = secondParagraph.AddTextRange(); +fourthTextRange.Text = "X"; +MdTextRange fifthTextRange = secondParagraph.AddTextRange(); +fifthTextRange.Text = "2"; +// Apply super script formatting for fifth text range. +fifthTextRange.TextFormat.SubSuperScriptType = MdSubSuperScript.SuperScript; +// Add a third Paragraph +MdParagraph thirdParagraph = markdownDocument.AddParagraph(); +// Add text to the third Paragraph +MdTextRange sixthTextRange = thirdParagraph.AddTextRange(); +sixthTextRange.Text = "m"; +MdTextRange seventhTextRange = thirdParagraph.AddTextRange(); +seventhTextRange.Text = "3"; +// Apply sub script formatting for seventh text range +seventhTextRange.TextFormat.SubSuperScriptType = MdSubSuperScript.SubScript; +// Add a fourth paragraph +MdParagraph fourthParagraph = markdownDocument.AddParagraph(); +// Add a text to the fourth paragraph +MdTextRange eighthTextRange = fourthParagraph.AddTextRange(); +eighthTextRange.Text = "This is the last text range"; +// Apply code span for the eight text range +eighthTextRange.TextFormat.CodeSpan = true; +MdTextRange ninthTextRange = fourthParagraph.AddTextRange(); +ninthTextRange.Text = "It's a hidden text range"; +ninthTextRange.TextFormat.IsHidden = true; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim firstParagraph As MdParagraph = markdownDocument.AddParagraph() +' Apply bold for the text range +Dim firstTextRange As MdTextRange = firstParagraph.AddTextRange() +firstTextRange.Text = "This is the first text range" +firstTextRange.TextFormat.Bold = True +' Add line break +Dim lineBreak As MdTextRange = firstParagraph.AddTextRange() +lineBreak.IsLineBreak = True +' Apply strikethrough for the second text range +Dim secondTextRange As MdTextRange = firstParagraph.AddTextRange() +secondTextRange.Text = "This is the second text range" +secondTextRange.TextFormat.StrikeThrough = True +lineBreak = firstParagraph.AddTextRange() +lineBreak.IsLineBreak = True +' Apply italic for the third text range +Dim thirdTextRange As MdTextRange = firstParagraph.AddTextRange() +thirdTextRange.Text = "This is the third text range" +thirdTextRange.TextFormat.Italic = True +' Add a Second Paragraph +Dim secondParagraph As MdParagraph = markdownDocument.AddParagraph() +' Add text to the second paragraph +Dim fourthTextRange As MdTextRange = secondParagraph.AddTextRange() +fourthTextRange.Text = "X" +Dim fifthTextRange As MdTextRange = secondParagraph.AddTextRange() +fifthTextRange.Text = "2" +' Apply super script formatting for fifth text range. +fifthTextRange.TextFormat.SubSuperScriptType = MdSubSuperScript.SuperScript +' Add a third Paragraph +Dim thirdParagraph As MdParagraph = markdownDocument.AddParagraph() +' Add text to the third Paragraph +Dim sixthTextRange As MdTextRange = thirdParagraph.AddTextRange() +sixthTextRange.Text = "m" +Dim seventhTextRange As MdTextRange = thirdParagraph.AddTextRange() +seventhTextRange.Text = "3" +' Apply sub script formatting for seventh text range +seventhTextRange.TextFormat.SubSuperScriptType = MdSubSuperScript.SubScript +' Add a fourth paragraph +Dim fourthParagraph As MdParagraph = markdownDocument.AddParagraph() +' Add a text to the fourth paragraph +Dim eighthTextRange As MdTextRange = fourthParagraph.AddTextRange() +eighthTextRange.Text = "This is the last text range" +' Apply code span for the eight text range +eighthTextRange.TextFormat.CodeSpan = True +Dim ninthTextRange As MdTextRange = fourthParagraph.AddTextRange() +ninthTextRange.Text = "It's a hidden text range" +ninthTextRange.TextFormat.IsHidden = True +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + + +## Working with hyperlinks + +Hyperlink is a reference to data that can link to external content like images, files, webpage, and more. In a Markdown document, a hyperlink may target to any one of the following sources: + +... +* Webpage: Represents the web content. +* File: Represents the file in some location. +* Email: Represents an Email. + +The following code example demonstrates how to add a hyperlink to a paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph firstParagraph = markdownDocument.AddParagraph(); +// Adds a hyperlink to the paragraph +MdHyperlink hyperlink = firstParagraph.AddHyperlink(); +// Sets the display text of the hyperlink +hyperlink.DisplayText = "Syncfusion"; +// Sets the URL of the hyperlink +hyperlink.Url = "http://www.syncfusion.com"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim firstParagraph As MdParagraph = markdownDocument.AddParagraph() +' Adds a hyperlink to the paragraph +Dim hyperlink As MdHyperlink = firstParagraph.AddHyperlink() +' Sets the display text of the hyperlink +hyperlink.DisplayText = "Syncfusion" +' Sets the URL of the hyperlink +hyperlink.Url = "http://www.syncfusion.com" +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +### Link with screen tip + +The following code example demonstrates how to add a hyperlink with a screen tip to a paragraph. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph firstParagraph = markdownDocument.AddParagraph(); +// Adds a hyperlink to the paragraph +MdHyperlink hyperlink = firstParagraph.AddHyperlink(); +// Sets the display text of the hyperlink +hyperlink.DisplayText = "Syncfusion"; +// Sets the URL of the hyperlink +hyperlink.Url = "http://www.syncfusion.com"; +// Sets the screen tip of the hyperlink +hyperlink.ScreenTip = "Visit our site"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + +' Creates a new MarkdownDocument instance +Dim markdownDocument As New MarkdownDocument() +' Adds a new paragraph to the document +Dim firstParagraph As MdParagraph = markdownDocument.AddParagraph() +' Adds a hyperlink to the paragraph +Dim hyperlink As MdHyperlink = firstParagraph.AddHyperlink() +' Sets the display text of the hyperlink +hyperlink.DisplayText = "Syncfusion" +' Sets the URL of the hyperlink +hyperlink.Url = "http://www.syncfusion.com" +' Sets the screen tip of the hyperlink +hyperlink.ScreenTip = "Visit our site" +' Gets the Markdown text of the document +Dim markdownText As String = markdownDocument.GetMarkdownText() +' Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8) +' Disposes the document +markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub. + +### Applying formatting for the display text + +The following code example demonstrates how to apply formatting to the display text of a hyperlink. + +{% tabs %} + +{% highlight c# tabtitle="C#" %} + +// Creates a new MarkdownDocument instance +MarkdownDocument markdownDocument = new MarkdownDocument(); +// Adds a new paragraph to the document +MdParagraph firstParagraph = markdownDocument.AddParagraph(); +MdHyperlink boldHyperlink = firstParagraph.AddHyperlink(); +boldHyperlink.DisplayText = "**Syncfusion**"; +boldHyperlink.Url = "http://www.syncfusion.com"; +// Adds a new paragraph to the document +MdParagraph secondParagraph = markdownDocument.AddParagraph(); +MdHyperlink italicHyperlink = secondParagraph.AddHyperlink(); +italicHyperlink.DisplayText = "*Syncfusion*"; +italicHyperlink.Url = "http://www.syncfusion.com"; +// Gets the Markdown text of the document +string markdownText = markdownDocument.GetMarkdownText(); +// Saves the Markdown document to the file system +File.WriteAllText("Output.md", markdownText, Encoding.UTF8); +// Disposes the document +markdownDocument.Dispose(); + +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET" %} + + ' Creates a new MarkdownDocument instance + Dim markdownDocument As New MarkdownDocument() + ' Adds a new paragraph to the document + Dim firstParagraph As MdParagraph = markdownDocument.AddParagraph() + Dim boldHyperlink As MdHyperlink = firstParagraph.AddHyperlink() + boldHyperlink.DisplayText = "**Syncfusion**" + boldHyperlink.Url = "http://www.syncfusion.com" + ' Adds a new paragraph to the document + Dim secondParagraph As MdParagraph = markdownDocument.AddParagraph() + Dim italicHyperlink As MdHyperlink = secondParagraph.AddHyperlink() + italicHyperlink.DisplayText = "*Syncfusion*" + italicHyperlink.Url = "http://www.syncfusion.com" + ' Gets the Markdown text of the document + Dim markdownText As String = markdownDocument.GetMarkdownText() + ' Saves the Markdown document to the file system + File.WriteAllText("Output.md", markdownText, Encoding.UTF8) + ' Disposes the document + markdownDocument.Dispose() + +{% endhighlight %} + +{% endtabs %} + +You can download a complete working sample from GitHub.