• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class DocumentSplitter

Splits a document into independent structural parts without modifying the source document.

Inheritance
object
DocumentSplitter
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: DRIT.Document
Assembly: DRIT.Document.dll
Syntax
public sealed class DocumentSplitter

Constructors

DocumentSplitter(Document, DocumentSplitOptions)

Initializes a splitter for the specified document and options.

Declaration
public DocumentSplitter(Document sourceDocument, DocumentSplitOptions options = null)
Parameters
Type Name Description
Document sourceDocument

The document to split.

DocumentSplitOptions options

The structural split options.

Methods

Split()

Splits the source document according to the configured structural criteria.

Declaration
public IReadOnlyList<DocumentSplitPart> Split()
Returns
Type Description
IReadOnlyList<DocumentSplitPart>

Independent document parts in source order.

SplitToHtml(HtmlSplitOptions)

Splits the source document into structural topics and writes each topic as an HTML file.

Declaration
public HtmlSplitResult SplitToHtml(HtmlSplitOptions options)
Parameters
Type Name Description
HtmlSplitOptions options

The structural and HTML output options.

Returns
Type Description
HtmlSplitResult

The generated topic and contents file metadata.

Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX