ColorMode Enumeration

CssSavingArgs Class

CssStyleSheetType Enumeration

DmlEffectsRenderingMode Enumeration

DmlRenderingMode Enumeration

DocSaveOptions Class

DocumentPartSavingArgs Class

DocumentSplitCriteria Enumeration

DownsampleOptions Class

EmfPlusDualRenderingMode Enumeration

ExportFontFormat Enumeration

ExportHeadersFootersMode Enumeration

ExportListLabels Enumeration

FixedPageSaveOptions Class

FontSavingArgs Class

GraphicsQualityOptions Class

HeaderFooterBookmarksExportMode Enumeration

HtmlElementSizeOutputMode Enumeration

HtmlFixedPageHorizontalAlignment Enumeration

HtmlFixedSaveOptions Class

HtmlMetafileFormat Enumeration

HtmlOfficeMathOutputMode Enumeration

HtmlSaveOptions Class

HtmlVersion Enumeration

ICssSavingCallback Interface

IDocumentPartSavingCallback Interface

IFontSavingCallback Interface

IImageSavingCallback Interface

ImageBinarizationMethod Enumeration

ImageColorMode Enumeration

ImagePixelFormat Enumeration

ImageSaveOptions Class

ImageSavingArgs Class

IPageSavingCallback Interface

IResourceSavingCallback Interface

MetafileRenderingMode Enumeration

MetafileRenderingOptions Class

NumeralFormat Enumeration

OdtSaveMeasureUnit Enumeration

OdtSaveOptions Class

OoxmlCompliance Enumeration

OoxmlSaveOptions Class

OutlineOptions Class

PageSavingArgs Class

PclSaveOptions Class

PdfCompliance Enumeration

PdfCustomPropertiesExport Enumeration

PdfDigitalSignatureDetails Class

PdfDigitalSignatureHashAlgorithm Enumeration

PdfDigitalSignatureTimestampSettings Class

PdfEncryptionAlgorithm Enumeration

PdfEncryptionDetails Class

PdfFontEmbeddingMode Enumeration

PdfImageColorSpaceExportMode Enumeration

PdfImageCompression Enumeration

PdfPageMode Enumeration

PdfPermissions Enumeration

PdfSaveOptions Class

PdfTextCompression Enumeration

PdfZoomBehavior Enumeration

PsSaveOptions Class

ResourceSavingArgs Class

RtfSaveOptions Class

SaveOptions Class

SaveOutputParameters Class

SvgSaveOptions Class

SvgTextOutputMode Enumeration

TiffCompression Enumeration

TxtExportHeadersFootersMode Enumeration

TxtListIndentation Class

TxtSaveOptions Class

TxtSaveOptionsBase Class

WordML2003SaveOptions Class

XamlFixedSaveOptions Class

XamlFlowSaveOptions Class

XpsSaveOptions Class

DocumentSplitCriteria Enumeration

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

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

[FlagsAttribute]
public enum DocumentSplitCriteria

<FlagsAttribute>
Public Enumeration DocumentSplitCriteria

[FlagsAttribute]
public enum class DocumentSplitCriteria

[<FlagsAttribute>]
type DocumentSplitCriteria

Members

Member 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

Converts a document to EPUB with save options specified.

// Open an existing document from disk
Document doc = new Document(MyDir + "Rendering.docx");

// Create a new instance of HtmlSaveOptions. This object allows us to set options that control
// how the output document is saved
HtmlSaveOptions saveOptions = new HtmlSaveOptions();

// Specify the desired encoding.
saveOptions.Encoding = Encoding.UTF8;

// Specify at what elements to split the internal HTML at. This creates a new HTML within the EPUB 
// which allows you to limit the size of each HTML part. This is useful for readers which cannot read 
// HTML files greater than a certain size e.g 300kb
saveOptions.DocumentSplitCriteria = DocumentSplitCriteria.HeadingParagraph;

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

// Specify that we want to save in EPUB format
saveOptions.SaveFormat = SaveFormat.Epub;

// Export the document as an EPUB file
doc.Save(ArtifactsDir + "Document.Doc2EpubSaveOptions.epub", saveOptions);

Reference

Aspose.Words.Saving Namespace

HtmlSaveOptionsDocumentSplitCriteria