DocumentSplitter.SplitToVariant Method

DocumentSplitterSplitToVariant Method

ByteScout PDF Extractor SDK

Free Trial Web API version Licensing Request A Quote

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

Splits PDF or TIFF document to multiple documents according to the specified ranges and returns the result PDF documents as array of bytes. This is COM/ActiveX-compatible version of the method Split(Stream, String) for in-memory processing of PDF files.

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

Syntax

C++

Copy

public Object SplitToVariant(
	Object sourceDocument,
	string ranges
)

Public Function SplitToVariant ( 
	sourceDocument As Object,
	ranges As String
) As Object

public:
virtual Object^ SplitToVariant(
	Object^ sourceDocument, 
	String^ ranges
) sealed

abstract SplitToVariant : 
        sourceDocument : Object * 
        ranges : string -> Object 
override SplitToVariant : 
        sourceDocument : Object * 
        ranges : string -> Object

Parameters

sourceDocument: Type: SystemObject
Byte array of the source document as 'Variant()'.
ranges: Type: SystemString
Comma-separated list of page ranges in form "1-4,5,7,8-15,16-". Page numbers are 1-based. Ending "-" means "to the last page". You can also use inverted page numbers adding '!' before the number. E.g. "!1" means "the last page", "2-!2" means "from the second to the penultimate page", "!2-" - last two pages". Also, you can also use single asterisk "*" character as the range to split the document into separate pages. Double asterisk "**" will split document into pairs of pages.

Return Value

Type: Object
Array of byte arrays containing splitted parts which are presented as 'Variant()'.

Implements

IDocumentSplitterSplitToVariant(Object, String)

Reference

DocumentSplitter Class

Bytescout.PDFExtractor Namespace