Insert and Append Documents
Sometimes it is required to combine several documents into one. You can do this manually or you can use Aspose.Words insert or append feature. The insert operation allows you to insert the content of previously created documents into a new or existing one.
In turn, the append feature allows you to add a document only at the end of another document.
This article explains how to insert or append a document to another one in different ways and describes the common properties that you can apply while inserting or appending documents.
Insert a Document
As mentioned above, in Aspose.Words a document is represented as a tree of nodes, and the operation of inserting one document into another is copying nodes from the first document tree to the second one.
You can insert documents in a variety of locations in different ways. For example, you can insert a document through a replace operation, a merge field during a merge operation, or via a bookmark.
You can also use the InsertDocument method, which is similar to inserting a document in Microsoft Word, to insert a whole document at the current cursor position without any previous importing.
The following subsections describe the options during which you can insert one document into another.
Insert a Document During Find and Replace Operation
You can insert documents while performing find and replace operations. For example, a document can contain paragraphs with the text [INTRODUCTION] and [CONCLUSION]. But in the final document, you need to replace those paragraphs with the content obtained from another external document. To achieve that, you will need to create a handler for the replace event.
The following code example shows how to create a handler for the replacing event to use it later in the inserting process:
The following code example shows how insert content of one document into another during a find and replace operation:
Insert a Document During Mail Merge Operation
You can insert a document into a merge field during a mail merge operation. For example, a mail merge template can contain a merge field such as [Summary]. But in the final document, you need to insert content obtained from another external document into this merge field. To achieve that, you will need to create a handler for the merge event.
The following code example shows how to create a handler for the merging event to use it later in the inserting process:
The following code example shows how to insert a document into the merge field using the created handler:
Insert a Document at Bookmark
You can import a text file into a document and insert it right after a bookmark that you have defined in the document. To do this, create a bookmarked paragraph where you want the document to be inserted.
The following coding example shows how to insert the contents of one document to a bookmark in another document:
Append a Document
You may have a use case where you need to include additional pages from a document to the end of an existing document. To do this, you just need to call the AppendDocument method to add a document to the end of another one.
The following code example shows how to append a document to the end of another document:
Import and Insert Nodes Manually
Aspose.Words allows you to insert and append documents automatically without any previous importing requirements. However, if you need to insert or append a specific node of your document, such as a section or a paragraph, then first you need to import this node manually.
When you need to insert or append one section or paragraph to another, you essentially need to import the nodes of the first document node tree into the second one using the ImportNode method. After importing your nodes, you need to use the InsertAfter/InsertBefore method to insert a new node after/before the reference node. This allows you to customize the inserting process by importing nodes from a document and inserting it at given positions.
You can also use the AppendChild method to add a new specified node to the end of the list of child nodes, for example, if you want to append content at the paragraph level instead of at the section level.
The following code example shows how to insert document content into another document using the InsertDocument method:
The following code example shows how to manually import nodes and insert them after a specific node using the InsertAfter method:
Content is imported into the destination document section by section, which means that settings, such as page setup and headers or footers, are preserved during import. It is also useful to note that you can define formatting settings when you insert or append a document to specify how two documents are joined together.
Common Properties for Insert and Append Documents
Both InsertDocument and AppendDocument methods accept ImportFormatMode and ImportFormatOptions as input parameters. The ImportFormatMode allows you to control how document formatting is merged when you import content from one document into another by selecting different format modes such as UseDestinationStyles, KeepSourceFormatting, and KeepDifferentStyles. The ImportFormatOptions allows you to select different import options such as IgnoreHeaderFooter, IgnoreTextBoxes, KeepSourceNumbering and SmartStyleBehavior.
Aspose.Words allows you to adjust the visualization of a resulting document when two documents are added together in an insert or append operation by using the Section and PageSetup properties. The PageSetup property contains all the attributes of a section such as SectionStart, RestartPageNumbering, PageStartingNumber, Orientation, and others. The most common use case is to set the SectionStart property to define if the added content will appear on the same page or split into a new one.
The following code example shows how to append one document to another while keeping the content from splitting across two pages:
Common Problems and Solutions
The table below provides typical problems when performing append or insert operation via Aspose.Words, as well as their respective solutions.
|The appended document does not appear on the same page.||The append result appears on a separate page because of a difference in PageSetup settings for the sections where the documents are appended together.||Make identical PageSetup settings for the sections where the documents are appended together.|