Xceed Logo
Shop
Xceed Words for .NET v5.2 Documentation
Xceed.Words.NET Assembly / Xceed.Words.NET Namespace / DocX Class / Split Method
The Document that will be split.
The SplitCriteria used to determine where the various splits will occur.
Example


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

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

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

    Parameters

    fileToSplit
    The Document that will be split.
    splitCriteria
    The SplitCriteria used to determine where the various splits will occur.

    Return Value

    A List<DocX> containing the newly created Documents.
    Remarks

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

    Note that more information on how a Document can be split can be found in the SplitCriteria enumeration.

     

    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