ImportFormatOptions

djsomers1000 · July 8, 2024, 11:26am

Hello,

I need help understanding the impact of setting a specific parameter on two merged Word documents with numbering.

When I run the following code, the output document remains unchanged whether I set KeepSourceNumbering to true or false. My expectation is that setting KeepSourceNumbering to false would result in the destination document pages being numbered sequentially (1, 2, 3, 4, …, 12), followed by the source document pages restarting at 1 (1, 2, 3, 4). Instead, the pages are numbered continuously (1, 2, 3, 4, …, 12, 13, 14, 15).

What is the code setting supposed to do?

Document srcDoc = new Document("\\srcDoc.docx");
Document dstDoc = new Document("\\destDoc.docx");
// Specify that if numbering clashes in source and destination documents,
// then numbering from the source document will be used.
ImportFormatOptions options = new ImportFormatOptions { KeepSourceNumbering = false};
dstDoc.AppendDocument(srcDoc, ImportFormatMode.UseDestinationStyles, options);

// Save the final document.
string outputFilePath = "JoinAndAppendDocuments.InsertDocument.docx";
dstDoc.Save(outputFilePath);

I have included my input and output test documents so that you can see what I mean.

Kind regards,
djs
Aspose Support Issue.zip (71.8 KB)

vyacheslav.deryushev · July 8, 2024, 2:06pm

@djsomers1000 KeepSourceNumbering requires to lists in the different documents. If we set the “KeepSourceNumbering” flag to “false”, then the list from the document clone that we append to the original will carry on the numbering of the list we append it to. This will effectively merge the two lists into one. If we set the “KeepSourceNumbering” flag to “true”, then the document clone list will preserve its original numbering, making the two lists appear as separate lists.

Your document has a PageNumber field that always displays the current page number. To get the desired result, you need to use the following code after adding a document:

dstDoc.Sections[1].PageSetup.RestartPageNumbering = true;

djsomers1000 · July 10, 2024, 9:41am

Hi,

Thanks for getting back to me.

A senior developer and I have been trying to understand the impact of the ImportFormatOptions class on inserted and appended documents. Despite setting various properties within this class while creating test documents, we haven’t observed any changes in the outputted document.

The only exception is the AdjustSentenceAndWordSpacing property, which shows a visible effect on the output DOCX file.

These are the properties that we are setting:
ImportFormatOptions Class | Aspose.Words for .NET

Could you provide some sample documents to verify that the save options are working correctly? We’re unable to see any differences in our tests.

Kind regards,
djs

vyacheslav.deryushev · July 10, 2024, 11:02am

@djsomers1000 Please check our GitHub examples for those properties:

github.com

aspose-words/Aspose.Words-for-.NET/blob/12e1e571d8e80506e71c5e96bf375f3f7fb8dcf4/Examples/ApiExamples/ApiExamples/ExDocument.cs#L745


      
          
                  // Unlink all headers/footers in this section from the previous section headers/footers
                  // if this is the second document or above being appended.
                  if (i > 1)
                      Assert.Throws<NullReferenceException>(() => doc.Sections[i].HeadersFooters.LinkToPrevious(false));
              }
          }
          
          [TestCase(true)]
          [TestCase(false)]
          public void ImportList(bool isKeepSourceNumbering)
          {
              //ExStart
              //ExFor:ImportFormatOptions.KeepSourceNumbering
              //ExSummary:Shows how to import a document with numbered lists.
              Document srcDoc = new Document(MyDir + "List source.docx");
              Document dstDoc = new Document(MyDir + "List destination.docx");
          
              Assert.AreEqual(4, dstDoc.Lists.Count);
          
              ImportFormatOptions options = new ImportFormatOptions();

github.com

aspose-words/Aspose.Words-for-.NET/blob/12e1e571d8e80506e71c5e96bf375f3f7fb8dcf4/Examples/ApiExamples/ApiExamples/ExDocument.cs#L771


      
              options.KeepSourceNumbering = isKeepSourceNumbering;
          
              dstDoc.AppendDocument(srcDoc, ImportFormatMode.KeepSourceFormatting, options);
              dstDoc.UpdateListLabels();
          
              Assert.AreEqual(isKeepSourceNumbering ? 5 : 4, dstDoc.Lists.Count);
              //ExEnd
          }
          
          [Test]
          public void KeepSourceNumberingSameListIds()
          {
              //ExStart
              //ExFor:ImportFormatOptions.KeepSourceNumbering
              //ExFor:NodeImporter.#ctor(DocumentBase, DocumentBase, ImportFormatMode, ImportFormatOptions)
              //ExSummary:Shows how resolve a clash when importing documents that have lists with the same list definition identifier.
              Document srcDoc = new Document(MyDir + "List with the same definition identifier - source.docx");
              Document dstDoc = new Document(MyDir + "List with the same definition identifier - destination.docx");
          
              // Set the "KeepSourceNumbering" property to "true" to apply a different list definition ID
              // to identical styles as Aspose.Words imports them into destination documents.

github.com

aspose-words/Aspose.Words-for-.NET/blob/12e1e571d8e80506e71c5e96bf375f3f7fb8dcf4/Examples/ApiExamples/ApiExamples/ExDocument.cs#L795


      
              dstDoc.UpdateListLabels();
              //ExEnd
          
              string paraText = dstDoc.Sections[1].Body.LastParagraph.GetText();
          
              Assert.IsTrue(paraText.StartsWith("13->13"), paraText);
              Assert.AreEqual("1.", dstDoc.Sections[1].Body.LastParagraph.ListLabel.LabelString);
          }
          
          [Test]
          public void MergePastedLists()
          {
              //ExStart
              //ExFor:ImportFormatOptions.MergePastedLists
              //ExSummary:Shows how to merge lists from a documents.
              Document srcDoc = new Document(MyDir + "List item.docx");
              Document dstDoc = new Document(MyDir + "List destination.docx");
          
              ImportFormatOptions options = new ImportFormatOptions { MergePastedLists = true };
          
              // Set the "MergePastedLists" property to "true" pasted lists will be merged with surrounding lists.

github.com

aspose-words/Aspose.Words-for-.NET/blob/12e1e571d8e80506e71c5e96bf375f3f7fb8dcf4/Examples/ApiExamples/ApiExamples/ExDocument.cs#L813


      
              ImportFormatOptions options = new ImportFormatOptions { MergePastedLists = true };
          
              // Set the "MergePastedLists" property to "true" pasted lists will be merged with surrounding lists.
              dstDoc.AppendDocument(srcDoc, ImportFormatMode.UseDestinationStyles, options);
          
              dstDoc.Save(ArtifactsDir + "Document.MergePastedLists.docx");
              //ExEnd
          }
          
          [Test]
          public void ForceCopyStyles()
          {
              //ExStart
              //ExFor:ImportFormatOptions.ForceCopyStyles
              //ExSummary:Shows how to copy source styles with unique names forcibly.
              // Both documents contain MyStyle1 and MyStyle2, MyStyle3 exists only in a source document.
              Document srcDoc = new Document(MyDir + "Styles source.docx");
              Document dstDoc = new Document(MyDir + "Styles destination.docx");
          
              ImportFormatOptions options = new ImportFormatOptions { ForceCopyStyles = true };
              dstDoc.AppendDocument(srcDoc, ImportFormatMode.KeepSourceFormatting, options);

github.com

aspose-words/Aspose.Words-for-.NET/blob/12e1e571d8e80506e71c5e96bf375f3f7fb8dcf4/Examples/ApiExamples/ApiExamples/ExDocument.cs#L834


      
          
              ParagraphCollection paras = dstDoc.Sections[1].Body.Paragraphs;
          
              Assert.AreEqual(paras[0].ParagraphFormat.Style.Name, "MyStyle1_0");
              Assert.AreEqual(paras[1].ParagraphFormat.Style.Name, "MyStyle2_0");
              Assert.AreEqual(paras[2].ParagraphFormat.Style.Name, "MyStyle3");
              //ExEnd
          }
          
          [Test]
          public void AdjustSentenceAndWordSpacing()
          {
              //ExStart
              //ExFor:ImportFormatOptions.AdjustSentenceAndWordSpacing
              //ExSummary:Shows how to adjust sentence and word spacing automatically.
              Document srcDoc = new Document();
              Document dstDoc = new Document();
          
              DocumentBuilder builder = new DocumentBuilder(srcDoc);
              builder.Write("Dolor sit amet.");

github.com

aspose-words/Aspose.Words-for-.NET/blob/99ba2a2d8b5d650deb40106225f383376b8b4bc6/Examples/ApiExamples/ApiExamples/ExDocumentBuilder.cs#L3028


      
              doc.Save(ArtifactsDir + "DocumentBuilder.EmphasesWarningSourceMarkdown.md");
           
              foreach (WarningInfo warningInfo in warnings)
              {
                  if (warningInfo.Source == WarningSource.Markdown)
                      Assert.AreEqual("The (*, 0:11) cannot be properly written into Markdown.", warningInfo.Description);
              }
          }
          
          [Test]
          public void DoNotIgnoreHeaderFooter()
          {
              //ExStart
              //ExFor:ImportFormatOptions.IgnoreHeaderFooter
              //ExSummary:Shows how to specifies ignoring or not source formatting of headers/footers content.
              Document dstDoc = new Document(MyDir + "Document.docx");
              Document srcDoc = new Document(MyDir + "Header and footer types.docx");
           
              ImportFormatOptions importFormatOptions = new ImportFormatOptions();
              importFormatOptions.IgnoreHeaderFooter = false;

github.com

aspose-words/Aspose.Words-for-.NET/blob/99ba2a2d8b5d650deb40106225f383376b8b4bc6/Examples/ApiExamples/ApiExamples/ExDocumentBuilder.cs#L2966


      
              builder.InsertDocument(docToInsert, ImportFormatMode.KeepSourceFormatting);
              builder.Document.Save(ArtifactsDir + "DocumentBuilder.InsertDocument.docx");
              //ExEnd
          
              Assert.AreEqual(29, doc.Styles.Count);
              Assert.IsTrue(DocumentHelper.CompareDocs(ArtifactsDir + "DocumentBuilder.InsertDocument.docx",
                  GoldsDir + "DocumentBuilder.InsertDocument Gold.docx"));
          }
          
          [Test]
          public void SmartStyleBehavior()
          {
              //ExStart
              //ExFor:ImportFormatOptions
              //ExFor:ImportFormatOptions.SmartStyleBehavior
              //ExFor:DocumentBuilder.InsertDocument(Document, ImportFormatMode, ImportFormatOptions)
              //ExSummary:Shows how to resolve duplicate styles while inserting documents.
              Document dstDoc = new Document();
              DocumentBuilder builder = new DocumentBuilder(dstDoc);
          
              Style myStyle = builder.Document.Styles.Add(StyleType.Paragraph, "MyStyle");

github.com

aspose-words/Aspose.Words-for-.NET/blob/99ba2a2d8b5d650deb40106225f383376b8b4bc6/Examples/ApiExamples/ApiExamples/ExDocumentBuilder.cs#L2388


      
              ImportFormatOptions options = new ImportFormatOptions();
              options.KeepSourceNumbering = keepSourceNumbering;
              builder.InsertDocument(srcDoc, ImportFormatMode.KeepSourceFormatting, options);
          
              dstDoc.UpdateListLabels();
              //ExEnd
          }
          
          [TestCase(true)]
          [TestCase(false)]
          public void IgnoreTextBoxes(bool ignoreTextBoxes)
          {
              //ExStart
              //ExFor:ImportFormatOptions.IgnoreTextBoxes
              //ExSummary:Shows how to manage text box formatting while appending a document.
              // Create a document that will have nodes from another document inserted into it.
              Document dstDoc = new Document();
              DocumentBuilder builder = new DocumentBuilder(dstDoc);
          
              builder.Writeln("Hello world!");

djsomers1000 · July 11, 2024, 10:03am

Thanks, I will take a look ASAP.