com.aspose.words

com.aspose.words

Class DocumentSplitCriteria

  • java.lang.Object
    • com.aspose.words.DocumentSplitCriteria
public class DocumentSplitCriteria 
extends java.lang.Object

Utility class containing constants. Specifies how the document is split into parts when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format.

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 ParagraphFormat.PageBreakBefore property so it falls under two criteria: PAGE_BREAK and HEADING_PARAGRAPH. Some section breaks can cause page breaks and so on. In typical cases specifying only one flag is the most practical option.

Example:

Shows how to use a specific encoding when saving a document to .epub.
Document doc = new Document(getMyDir() + "Rendering.docx");

// Use a SaveOptions object to specify the encoding for a document that we will save.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setSaveFormat(SaveFormat.EPUB);
saveOptions.setEncoding(StandardCharsets.UTF_8);

// By default, an output .epub document will have all of 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.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);

// Specify that we want to export document properties.
saveOptions.setExportDocumentProperties(true);

doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);
See Also:
HtmlSaveOptions.DocumentSplitCriteria

Field Summary
static final intNONE = 0
The document is not split.
static final intPAGE_BREAK = 1
The document is split into parts at explicit page breaks. A page break can be specified by a ControlChar.PAGE_BREAK character, a section break specifying start of new section on a new page, or a paragraph that has its ParagraphFormat.PageBreakBefore property set to true.
static final intCOLUMN_BREAK = 2
The document is split into parts at column breaks. A column break can be specified by a ControlChar.COLUMN_BREAK character or a section break specifying start of new section in a new column.
static final intSECTION_BREAK = 4
The document is split into parts at a section break of any type.
static final intHEADING_PARAGRAPH = 8
The document is split into parts at a paragraph formatted using a heading style Heading 1, Heading 2 etc. Use together with HtmlSaveOptions.DocumentSplitHeadingLevel to specify the heading levels (from 1 to the specified level) at which to split.
 

    • Field Detail

      • NONE = 0

        public static final int NONE
        The document is not split.

      • PAGE_BREAK = 1

        public static final int PAGE_BREAK
        The document is split into parts at explicit page breaks. A page break can be specified by a ControlChar.PAGE_BREAK character, a section break specifying start of new section on a new page, or a paragraph that has its ParagraphFormat.PageBreakBefore property set to true.

      • COLUMN_BREAK = 2

        public static final int COLUMN_BREAK
        The document is split into parts at column breaks. A column break can be specified by a ControlChar.COLUMN_BREAK character or a section break specifying start of new section in a new column.

      • SECTION_BREAK = 4

        public static final int SECTION_BREAK
        The document is split into parts at a section break of any type.

      • HEADING_PARAGRAPH = 8

        public static final int HEADING_PARAGRAPH
        The document is split into parts at a paragraph formatted using a heading style Heading 1, Heading 2 etc. Use together with HtmlSaveOptions.DocumentSplitHeadingLevel to specify the heading levels (from 1 to the specified level) at which to split.