Processor.To
To(string, SaveOptions)
Specifies output file for the processor.
public Processor To(string output, SaveOptions saveOptions = null)
| Parameter | Type | Description |
|---|---|---|
| output | String | Output file name. |
| saveOptions | SaveOptions | Optional save options. If not specified, save format is determined by the file extension. |
Return Value
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’.
Examples
Shows how to convert DOCX document to PDF using Fluent API.
Converter.Create()
.From(MyDir + "Simple.docx")
.To(ArtifactsDir + "Converter.ConvertToPdf.pdf")
.Execute();
See Also
- class SaveOptions
- class Processor
- namespace Wordize
- assembly Wordize
To(string, SaveFormat)
Specifies output file for the processor.
public Processor To(string output, SaveFormat saveFormat)
| Parameter | Type | Description |
|---|---|---|
| output | String | Output file name. |
| saveFormat | SaveFormat | Save format. If not specified, save format is determined by the file extension. |
Return Value
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’.
See Also
- enum SaveFormat
- class Processor
- namespace Wordize
- assembly Wordize
To(Stream, SaveOptions)
Specifies output stream for the processor.
public Processor To(Stream output, SaveOptions saveOptions)
| Parameter | Type | Description |
|---|---|---|
| output | Stream | Output stream. |
| saveOptions | SaveOptions | Save options. |
Return Value
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.
See Also
- class SaveOptions
- class Processor
- namespace Wordize
- assembly Wordize
To(Stream, SaveFormat)
Specifies output stream for the processor.
public Processor To(Stream output, SaveFormat saveFormat)
| Parameter | Type | Description |
|---|---|---|
| output | Stream | Output stream. |
| saveFormat | SaveFormat | Save format. |
Return Value
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.
See Also
- enum SaveFormat
- class Processor
- namespace Wordize
- assembly Wordize
To(List<Stream>, SaveOptions)
Specifies output Document streams list.
public Processor To(List<Stream> output, SaveOptions saveOptions)
| Parameter | Type | Description |
|---|---|---|
| output | List`1 | Output document streams list. |
| saveOptions | SaveOptions | Save options. |
Return Value
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.
Examples
Shows how to split document into pages using fluent Api.
SplitterContext context = new SplitterContext();
context.SplitOptions.SplitCriteria = SplitCriteria.Page;
List<Stream> pages = new List<Stream>();
Splitter.Create(context)
.From(MyDir + "TestSpliter.docx")
.To(pages, SaveFormat.Docx)
.Execute();
See Also
- class SaveOptions
- class Processor
- namespace Wordize
- assembly Wordize
To(List<Stream>, SaveFormat)
Specifies output Document streams list.
public Processor To(List<Stream> output, SaveFormat saveFormat)
| Parameter | Type | Description |
|---|---|---|
| output | List`1 | Output document streams list. |
| saveFormat | SaveFormat | Save format. |
Return Value
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.
See Also
- enum SaveFormat
- class Processor
- namespace Wordize
- assembly Wordize