Working with Blockquotes in Markdown Library

2 Jul 202621 minutes to read

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.

NOTE

Refer to the appropriate tabs in the code snippets section: C# for ASP.NET Core, Blazor, ASP.NET MVC, UWP, .NET MAUI, WinUI, WinForms and WPF; VB.NET for VB.NET applications.

C#
VB.NET
// 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.";
 // Saves the Markdown document to the file system
 markdownDocument.Save("Output.md");
 // Disposes the document
 markdownDocument.Dispose();
' 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."
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

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.

C#
VB.NET
// 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.";
 // Saves the Markdown document to the file system
 markdownDocument.Save("Output.md");
 // Disposes the document
 markdownDocument.Dispose();
' 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."
 ' Saves the Markdown document to the file system
 markdownDocument.Save("Output.md")
 ' Disposes the document
 markdownDocument.Dispose()

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.

C#
VB.NET
// 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.";
// Saves the Markdown document to the file system
markdownDocument.Save("Output.md");
// Disposes the document
markdownDocument.Dispose();
' 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."
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

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.

C#
VB.NET
// 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.";
// Saves the Markdown document to the file system
markdownDocument.Save("Output.md");
// Disposes the document
markdownDocument.Dispose();
' 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."
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

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.

C#
VB.NET
// 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;
// Saves the Markdown document to the file system
markdownDocument.Save("Output.md");
// Disposes the document
markdownDocument.Dispose();
' 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
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

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.

C#
VB.NET
// Opens an existing Markdown document
 MarkdownDocument markdownDocument = new MarkdownDocument(Path.GetFullPath("Input.md"));
 // 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;
         }
     }
 }
 // Saves the Markdown document to the file system
 markdownDocument.Save("Output.md");
 // Disposes the document
 markdownDocument.Dispose();
' Opens an existing Markdown document
Dim markdownDocument As MarkdownDocument = New MarkdownDocument(Path.GetFullPath("Input.md"))
' 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
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

Removing a Blockquote

The following code example demonstrates how to remove blockquote from paragraphs.

C#
VB.NET
// Opens an existing Markdown document
 MarkdownDocument markdownDocument = new MarkdownDocument(Path.GetFullPath("Input.md"));
 // 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;
			 paragraph.ApplyParagraphStyle("");
             break;
         }                       
     }
 }
// Saves the Markdown document to the file system
markdownDocument.Save("Output.md");
// Disposes the document
markdownDocument.Dispose();
' Opens an existing Markdown document
Dim markdownDocument As MarkdownDocument = New MarkdownDocument(Path.GetFullPath("Input.md"))
' 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
			paragraph.ApplyParagraphStyle("")
            Exit For
        End If
    End If
Next
' Saves the Markdown document to the file system
markdownDocument.Save("Output.md")
' Disposes the document
markdownDocument.Dispose()

Search docs

Ask Syncfusion AI Assistant