Class Processor

Namespace: Aspose.Words.LowCode
Assembly: Aspose.Words.dll (25.4.0)

Processor class for performing different document processing actions.

public class Processor

Inheritance

object ← Processor

Derived

Comparer , Converter , MailMerger , Merger , Replacer , ReportBuilder , Splitter , Watermarker

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Fields

mResultDocument

protected Document mResultDocument

Field Value

Document

Methods

CheckArgumentsSet()

protected virtual void CheckArgumentsSet()

Execute()

Execute the processor action.

public void Execute()

ExecuteCore()

protected virtual void ExecuteCore()

From(string, LoadOptions)

Specifies input document for processing.

public Processor From(string input, LoadOptions loadOptions = null)

Parameters

input string

Input document file name.

loadOptions LoadOptions

Optional load options used to load the document.

Returns

Processor

Returns processor with specified input file.

Remarks

If the processor accepts only one file as an input, only the last specified file will be processed. Aspose.Words.LowCode.Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Aspose.Words.LowCode.Converter processor accepts only one file as an input, so only the last specified file will be converted.

From(Stream, LoadOptions)

Specifies input document for processing.

public Processor From(Stream input, LoadOptions loadOptions = null)

Parameters

input Stream

Input document stream.

loadOptions LoadOptions

Optional load options used to load the document.

Returns

Processor

Returns processor with specified input file stream.

Remarks

If the processor accepts only one file as an input, only the last specified file will be processed. Aspose.Words.LowCode.Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Aspose.Words.LowCode.Converter processor accepts only one file as an input, so only the last specified file will be converted.

GetPartFileName(string, int, SaveFormat)

protected static string GetPartFileName(string fileName, int partIndex, SaveFormat saveFormat)

Parameters

fileName string

partIndex int

saveFormat SaveFormat

Returns

string

To(string, SaveOptions)

Specifies output file for the processor.

public Processor To(string output, SaveOptions saveOptions = null)

Parameters

output string

Output file name.

saveOptions SaveOptions

Optional save options. If not specified, save format is determined by the file extension.

Returns

Processor

Returns processor with specified output file.

Remarks

If the output consists of multiple files, the specified output file name is used to generate the file name for each part following the rule: ‘outputFile_partIndex.extension’.

To(string, SaveFormat)

Specifies output file for the processor.

public Processor To(string output, SaveFormat saveFormat)

Parameters

output string

Output file name.

saveFormat SaveFormat

Save format. If not specified, save format is determined by the file extension.

Returns

Processor

Returns processor with specified output file.

Remarks

If the output consists of multiple files, the specified output file name is used to generate the file name for each part following the rule: ‘outputFile_partIndex.extension’.

To(Stream, SaveOptions)

Specifies output stream for the processor.

public Processor To(Stream output, SaveOptions saveOptions)

Parameters

output Stream

Output stream.

saveOptions SaveOptions

Save options.

Returns

Processor

Returns processor with specified output stream.

Remarks

If the output consists of multiple files, only the first part will be saved to the specified stream.

To(Stream, SaveFormat)

Specifies output stream for the processor.

public Processor To(Stream output, SaveFormat saveFormat)

Parameters

output Stream

Output stream.

saveFormat SaveFormat

Save format.

Returns

Processor

Returns processor with specified output stream.

Remarks

If the output consists of multiple files, only the first part will be saved to the specified stream.

To(List<stream>, SaveOptions)

Specifies output Document streams list.

public Processor To(List<stream> output, SaveOptions saveOptions)

Parameters

output List < Stream &gt;

Output document streams list.

saveOptions SaveOptions

Save options.

Returns

Processor

Returns processor with specified output document streams list.

Remarks

If the output consists of multiple files (such as images or split document parts), a stream for each part is added to the specified list. If the output is a single file, only one stream is added to the list. It is the end user’s responsibility to dispose of the created streams.

To(List<stream>, SaveFormat)

Specifies output Document streams list.

public Processor To(List<stream> output, SaveFormat saveFormat)

Parameters

output List < Stream &gt;

Output document streams list.

saveFormat SaveFormat

Save format.

Returns

Processor

Returns processor with specified output document streams list.

Remarks

If the output consists of multiple files (such as images or split document parts), a stream for each part is added to the specified list. If the output is a single file, only one stream is added to the list. It is the end user’s responsibility to dispose of the created streams. </stream></stream>