Return to previous page Explore PDF Extractor SDK

DocumentSplitter2SplitCOM Method

Free Trial Web API version Licensing Request A Quote

HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM

Splits PDF or TIFF document by found text. The COM/ActiveX-compatible version of the method Split(String, String, Boolean, Boolean, Boolean, String). Returns a string with the file names of the generated PDF documents delimited by the line feed '\n'.

Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master

Syntax

C++

Copy

public Object SplitCOM(
	string sourceDocument,
	string searchString,
	bool caseSensitive,
	bool useRegex,
	bool excludePageWithFoundText,
	string outputFolder = null
)

Public Function SplitCOM ( 
	sourceDocument As String,
	searchString As String,
	caseSensitive As Boolean,
	useRegex As Boolean,
	excludePageWithFoundText As Boolean,
	Optional outputFolder As String = Nothing
) As Object

public:
virtual Object^ SplitCOM(
	String^ sourceDocument, 
	String^ searchString, 
	bool caseSensitive, 
	bool useRegex, 
	bool excludePageWithFoundText, 
	String^ outputFolder = nullptr
) sealed

abstract SplitCOM : 
        sourceDocument : string * 
        searchString : string * 
        caseSensitive : bool * 
        useRegex : bool * 
        excludePageWithFoundText : bool * 
        ?outputFolder : string 
(* Defaults:
        let _outputFolder = defaultArg outputFolder null
*)
-> Object 
override SplitCOM : 
        sourceDocument : string * 
        searchString : string * 
        caseSensitive : bool * 
        useRegex : bool * 
        excludePageWithFoundText : bool * 
        ?outputFolder : string 
(* Defaults:
        let _outputFolder = defaultArg outputFolder null
*)
-> Object

Parameters

sourceDocument: Type: SystemString
File name of the source document.
searchString: Type: SystemString
Search string.
caseSensitive: Type: SystemBoolean
Case sensitivity.
useRegex: Type: SystemBoolean
Set true if the [!:searchString] contains a regular expression.
excludePageWithFoundText: Type: SystemBoolean
Whether to exclude the page with found search string from split parts.
outputFolder (Optional): Type: SystemString
Output folder for generated files. Default is null that means the user temporary folder.

Return Value

Type: Object
Array of file names of generated PDF documents or null (Nothing) if the search string is not found.

Implements

IDocumentSplitter2SplitCOM(String, String, Boolean, Boolean, Boolean, String)

Reference

DocumentSplitter2 Class

Bytescout.PDFExtractor Namespace