TxtExportHeadersFootersMode
Contents
[
Hide
]TxtExportHeadersFootersMode enumeration
Specifies the way headers and footers are exported to plain text format.
public enum TxtExportHeadersFootersMode
Values
Name | Value | Description |
---|---|---|
None | 0 | No headers and footers are exported. |
PrimaryOnly | 1 | Only primary headers and footers are exported at the beginning and end of each section. |
AllAtEnd | 2 | All headers and footers are placed after all section bodies at the very end of a document. |
Examples
Shows how to specify how to export headers and footers to plain text format.
Document doc = new Document();
// Insert even and primary headers/footers into the document.
// The primary header/footers will override the even headers/footers.
doc.FirstSection.HeadersFooters.Add(new HeaderFooter(doc, HeaderFooterType.HeaderEven));
doc.FirstSection.HeadersFooters[HeaderFooterType.HeaderEven].AppendParagraph("Even header");
doc.FirstSection.HeadersFooters.Add(new HeaderFooter(doc, HeaderFooterType.FooterEven));
doc.FirstSection.HeadersFooters[HeaderFooterType.FooterEven].AppendParagraph("Even footer");
doc.FirstSection.HeadersFooters.Add(new HeaderFooter(doc, HeaderFooterType.HeaderPrimary));
doc.FirstSection.HeadersFooters[HeaderFooterType.HeaderPrimary].AppendParagraph("Primary header");
doc.FirstSection.HeadersFooters.Add(new HeaderFooter(doc, HeaderFooterType.FooterPrimary));
doc.FirstSection.HeadersFooters[HeaderFooterType.FooterPrimary].AppendParagraph("Primary footer");
// Insert pages to display these headers and footers.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Writeln("Page 1");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page 2");
builder.InsertBreak(BreakType.PageBreak);
builder.Write("Page 3");
// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
TxtSaveOptions saveOptions = new TxtSaveOptions();
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.None"
// to not export any headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.PrimaryOnly"
// to only export primary headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.AllAtEnd"
// to place all headers and footers for all section bodies at the end of the document.
saveOptions.ExportHeadersFootersMode = txtExportHeadersFootersMode;
doc.Save(ArtifactsDir + "TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);
string docText = File.ReadAllText(ArtifactsDir + "TxtSaveOptions.ExportHeadersFooters.txt");
switch (txtExportHeadersFootersMode)
{
case TxtExportHeadersFootersMode.AllAtEnd:
Assert.AreEqual("Page 1\r\n" +
"Page 2\r\n" +
"Page 3\r\n" +
"Even header\r\n\r\n" +
"Primary header\r\n\r\n" +
"Even footer\r\n\r\n" +
"Primary footer\r\n\r\n", docText);
break;
case TxtExportHeadersFootersMode.PrimaryOnly:
Assert.AreEqual("Primary header\r\n" +
"Page 1\r\n" +
"Page 2\r\n" +
"Page 3\r\n" +
"Primary footer\r\n", docText);
break;
case TxtExportHeadersFootersMode.None:
Assert.AreEqual("Page 1\r\n" +
"Page 2\r\n" +
"Page 3\r\n", docText);
break;
}
See Also
- namespace Aspose.Words.Saving
- assembly Aspose.Words