Xceed Logo
Shop
Xceed Words for .NET v6.0 Documentation
[Root] / Xceed.Words.NET Assembly / Xceed.Words.NET Namespace / DocX Class / Split Method
The Document that will be split.
The SplitOptions that will be used to split the target Document.
Example


In This Topic
    Split Method (DocX)
    In This Topic
    Divides a Document into a list of new Documents.
    Syntax
    'Declaration
 

    Public Shared Function Split( _
   ByVal fileToSplit As Document, _
   ByVal options As SplitOptions _
) As List(Of DocX)
    'Usage
 

    Dim fileToSplit As Document
Dim options As SplitOptions
Dim value As List(Of DocX)
 
value = DocX.Split(fileToSplit, options)
    public static List<DocX> Split( 
   Document fileToSplit,
   SplitOptions options
)

    Parameters

    fileToSplit
    The Document that will be split.
    options
    The SplitOptions that will be used to split the target Document.

    Return Value

    Returns one Document per detected split point.

    May be empty if the source Document contains no matching split points & SkipEmptyDocuments is set to true.

    Exceptions
    ExceptionDescription
    System.ArgumentNullExceptionTriggers an ArgumentNullException if fileToSplit or options is null.
    System.ArgumentExceptionTriggers an ArgumentException if splitCriteria is not a recognized value.
    Remarks

    Once split, the content of the original Document will be divided into the newly created Documents.

     

    Example
    This example demonstrates how to split a Document named "MyDocument.docx" into multiple Documents. The original Document will be split based on its various sections & the resulting Documents will be saved to disk with a numbered suffix.
    // Loads a Document.
using (DocX document = DocX.Load("MyDocument.docx"))
{
  // Splits the Document into a list of new Documents; a split will occur each time a new section is encountered.
  List<DocX> documents = DocX.Split(document, SplitCriteria.Sections);

  // Saves each new Document to a file.
  for (int i = 0; i < documents.Count; i++)
  {
    documents[i].SaveAs($"MyDocument_Part_{i + 1}.docx");
    documents[i].Dispose();
  }
}
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    DocX Class
    DocX Members

    Send Feedback