Removing Bookmark or Bookmark Content causing unexpected format changes

[Chris Reddick]

As suggested by Syncfusion support in another thread, (https://www.syncfusion.com/forums/172575/replacesingleline-doesnt-replace-embedded-tables ) I am trying to use Bookmarks to conditionally replace content in a document. While using the bookmarks does solve the problem in that thread it does create a new problem.

When using bookmarks to conditionally remove content in a document the paragraph formatting of document unexpectedly changes.

Here is a screenshot of a sample document.

If my goal is to be able to conditionally replace the content in the paragraph denoted by the starting tag "1@" and the ending tag "@1" then I would expect to get the screenshot below if the paragraph should not be removed.

And I would expect this if the paragraph was removed.

However, this is what I get if the paragraph is not removed.

And this is what I get if the paragraph is removed.

As you can see, in both cases, after the paragraph to be replaced the paragraph formatting changes from double-space to single-space. What is going on and how can I fix this? This seems like a bug to me.

I am attaching the template document and here is my code.

var document = new WordDocument(Server.MapPath("Template2.docx"), FormatType.Docx);
var bookmarkNavigator = new BookmarksNavigator(document);
document.ReplaceFirst = true;

var bookmarkName = "ConditionalParagraph";

var startTagTextBodyPart = new TextBodyPart(document);
var startTagPlaceholder = new WParagraph(document);
startTagPlaceholder.AppendBookmarkStart(bookmarkName);
startTagTextBodyPart.BodyItems.Add(startTagPlaceholder);
document.ReplaceSingleLine(new Regex(@"@1"), startTagTextBodyPart);

var endTagTextBodyPart = new TextBodyPart(document);
var endTagPlaceholder = new WParagraph(document);
endTagPlaceholder.AppendBookmarkEnd(bookmarkName);
endTagTextBodyPart.BodyItems.Add(endTagPlaceholder);
document.ReplaceSingleLine(new Regex(@"1@"), endTagTextBodyPart);

var bookmark = document.Bookmarks.FindByName(bookmarkName);

var deleteParagraph = true;

if (deleteParagraph)
{
    bookmarkNavigator.MoveToBookmark(bookmarkName);
    bookmarkNavigator.DeleteBookmarkContent(false);
}

document.Bookmarks.Remove(bookmark);

document.ReplaceFirst = false;
document.Save("Sample.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment);
document.Close();

Thanks

Attachment: Template2_7a7a5836.zip

[Manikandan Ravichandran]

Hi Chirs,

On further checking the input document, we have found that the paragraph in the Word document has some formatting which are applied inline to the paragraph. In code example, you have created a new paragraph without any formatting and replaced the needed paragraph with this new paragraph. So that, the formatting lost in the output document.

To maintain same formatting, you can clone that needed paragraph and clear exiting items so that, it maintains the formatting only. Then you can add necessary text in the cloned paragraph and replace with needed paragraph.

Based on this, we have modified the code example and attached below.

Code example: 

var document = new WordDocument(Server.MapPath("Template2.docx"), FormatType.Docx);
var bookmarkNavigator = new BookmarksNavigator(document);
document.ReplaceFirst = true;

var bookmarkName = "ConditionalParagraph";
TextSelection textSelection = document.Find(new Regex(@"@1"));
//Gets the found text as single text range
WTextRange textRange = textSelection.GetAsOneRange();
WParagraph paragraph = textRange.OwnerParagraph;


var startTagTextBodyPart = new TextBodyPart(document);
var startTagPlaceholder = paragraph.Clone() as WParagraph;
startTagPlaceholder.ChildEntities.Clear();
startTagPlaceholder.AppendBookmarkStart(bookmarkName);
startTagTextBodyPart.BodyItems.Add(startTagPlaceholder);
document.ReplaceSingleLine(new Regex(@"@1"), startTagTextBodyPart);

textSelection = document.Find(new Regex(@"1@"));
//Gets the found text as single text range
textRange = textSelection.GetAsOneRange();
paragraph = textRange.OwnerParagraph;


var endTagTextBodyPart = new TextBodyPart(document);
var endTagPlaceholder = paragraph.Clone() as WParagraph;
endTagPlaceholder.ChildEntities.Clear();
endTagPlaceholder.AppendBookmarkEnd(bookmarkName);
endTagTextBodyPart.BodyItems.Add(endTagPlaceholder);
document.ReplaceSingleLine(new Regex(@"1@"), endTagTextBodyPart);

var bookmark = document.Bookmarks.FindByName(bookmarkName);

var deleteParagraph = true;

if (deleteParagraph)
{
    bookmarkNavigator.MoveToBookmark(bookmarkName);
    bookmarkNavigator.DeleteBookmarkContent(false);
}

document.Bookmarks.Remove(bookmark);

document.ReplaceFirst = false;
document.Save("Sample.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment);
document.Close(); 

Regards,
Manikandan Ravichandran 

[Chris Reddick]

Yes, that seems to have done the trick. Thanks.