Range.replace with footnote

Aspose.Words Product Family
1

I need to be able to do a Range.Replace (or the functional equivalent) but instead of replacing one string with another, I need to:

- find the string
- blank out the string
- insert a footnote at that point in the document

I looked at the IReplacingCallback overload but I don’t see how I can use that.

I also looked at the DocumentVisitor, but I’m not sure what would be the best way to use it for what I want.

Suggestions please.

2

Hi Jim,

Thanks for your inquiry. You can achieve your requirements by implementing IReplacingCallback. Please use following code example to find the text and replace it with footnote. Hope this helps you.

public class FindandInsertFootnote : IReplacingCallback
{
    ReplaceAction IReplacingCallback.Replacing(ReplacingArgs e)
    {
        // This is a Run node that contains either the beginning or the complete match.
        Node currentNode = e.MatchNode;
        // The first (and may be the only) run can contain text before the match,
        // in this case it is necessary to split the run.
        if (e.MatchOffset > 0)
            currentNode = SplitRun((Run)currentNode, e.MatchOffset);
        // This array is used to store all nodes of the match for further removing.
        ArrayList runs = new ArrayList();
        // Find all runs that contain parts of the match string.
        int remainingLength = e.Match.Value.Length;
        while (
        (remainingLength > 0) &&
        (currentNode != null) &&
        (currentNode.GetText().Length <= remainingLength))
        {
            runs.Add(currentNode);
            remainingLength = remainingLength - currentNode.GetText().Length;
            // Select the next Run node.
            // Have to loop because there could be other nodes such as BookmarkStart etc.
            do
            {
                currentNode = currentNode.NextSibling;
            }
            while ((currentNode != null) && (currentNode.NodeType != NodeType.Run));
        }
        // Split the last run that contains the match if there is any text left.
        if ((currentNode != null) && (remainingLength > 0))
        {
            SplitRun((Run)currentNode, remainingLength);
            runs.Add(currentNode);
        }
        // Create Document Buidler 
        DocumentBuilder builder = new DocumentBuilder(e.MatchNode.Document as Document);
        builder.MoveTo((Run)runs[runs.Count - 1]);
        builder.Write("Some text");
        builder.InsertFootnote(FootnoteType.Footnote, "Footnote text.");
        // Now remove all runs in the sequence.
        foreach (Run run in runs)
            run.Remove();
        // Signal to the replace engine to do nothing because we have already done all what we wanted.
        return ReplaceAction.Skip;
    }
    private static Run SplitRun(Run run, int position)
    {
        Run afterRun = (Run)run.Clone(true);
        afterRun.Text = run.Text.Substring(position);
        run.Text = run.Text.Substring(0, position);
        run.ParentNode.InsertAfter(afterRun, run);
        return afterRun;
    }
}

Document mainDoc = new Document(MyDir + "in.docx");
mainDoc.Range.Replace(new Regex("Replace me with footnote"), new FindandInsertFootnote(), false);
mainDoc.Save(MyDir + "Out.docx");
3

Thank you. I actually needed to create a footnote with some text other than “Footnote text”.

The goal is to find a formatted tag such as “<>” and create a footnote at that point (this works), but then supply actual content to the paragraph in the footnote.

I modified your class to take a constructor to supply the replacement value, and then supplied when the class is created:

doc.Range.Replace(new Regex(searchString), new FindandInsertFootnote( t.ReferenceTitle), false);
4

Hi Jim,

Thanks for your inquiry. Could you please attach your input and expected output Word documents here for our reference? We will investigate how you want your final Word output be generated like. We will then provide you more information on this along with code.

5

I guess I wasn’t clear. I got it working using your code. I just explained that I needed to be able to supply the replacement value, so I modified your code to accept a constructor with the value. Everything is working now.

6

Hi Jim,

Thanks for your feedback. It is nice to hear from you that your problem has been solved. Please feel free to ask if you have any question about Aspose.Words, we will be happy to help you.