DocumentSplitCriteria

DocumentSplitCriteria enumeration

Specifies how the document is split into parts when saving to Html, Epub or Azw3 format.

[Flags]
public enum DocumentSplitCriteria

Values

Name	Value	Description
None	`0`	The document is not split.
PageBreak	`1`	The document is split into parts at explicit page breaks. A page break can be specified by a `PageBreak` character, a section break specifying start of new section on a new page, or a paragraph that has its `PageBreakBefore` property set to `true`.
ColumnBreak	`2`	The document is split into parts at column breaks. A column break can be specified by a `ColumnBreak` character or a section break specifying start of new section in a new column.
SectionBreak	`4`	The document is split into parts at a section break of any type.
HeadingParagraph	`8`	The document is split into parts at a paragraph formatted using a heading style Heading 1, Heading 2 etc. Use together with `DocumentSplitHeadingLevel` to specify the heading levels (from 1 to the specified level) at which to split.

Remarks

DocumentSplitCriteria is a set of flags which can be combined. For instance you can split the document at page breaks and heading paragraphs in the same export operation.

Different criteria can partially overlap. For instance, Heading 1 style is frequently given PageBreakBefore property so it falls under two criteria: PageBreak and HeadingParagraph. Some section breaks can cause page breaks and so on. In typical cases specifying only one flag is the most practical option.

Examples

Shows how to use a specific encoding when saving a document to .epub.

Document doc = new Document(MyDir + "Rendering.docx");

// Use a SaveOptions object to specify the encoding for a document that we will save.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.SaveFormat = SaveFormat.Epub;
saveOptions.Encoding = Encoding.UTF8;

// By default, an output .epub document will have all its contents in one HTML part.
// A split criterion allows us to segment the document into several HTML parts.
// We will set the criteria to split the document into heading paragraphs.
// This is useful for readers who cannot read HTML files more significant than a specific size.
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

// Specify that we want to export document properties.
saveOptions.ExportDocumentProperties = true;

doc.Save(ArtifactsDir + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

DocumentSplitCriteria