SaveOptions(Stream) Method

Summary

Saves the options of this RasterCodecs to a stream.

Syntax

C++

public void SaveOptions( 
   Stream stream 
)

Public Overloads Sub SaveOptions( _ 
   ByVal stream As Stream _ 
)

public: 
void SaveOptions(  
   Stream^ stream 
)

Parameters

stream
A Stream that will contain the output data.

Remarks

The RasterCodecs options can be easily saved to a disk or stream using SaveOptions(string fileName) or SaveOptions(Stream stream) and then loaded back into the same or a different RasterCodecs object using LoadOptions(string fileName) or LoadOptions(Stream stream).

Saving and loading the options is handy for situations where a RasterCodecs with specialized options other than the default is used. For example, in a server application as demonstrated by the example.

The options are saved in a standard XML file (with UTF-8 encoding) in the following format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<leadtools_raster_codecs> 
  <options> 
     <option FullPropertyName="value" /> 
  </options> 
</leadtools_raster_codecs>

FullPropertyName is the exact .NET property name of the options as accessed by the RasterCodecs object, for example, if you have a RasterCodecs object called rasterCodecsInstance, then you can access the CodecsRasterizeDocumentLoadOptions.XResolution using:

rasterCodecsInstance.RasterizeDocument.Load.XResolution

And hence, the FullPropertyName if this option will be RasterizeDocument.Load.XResolution.

The LoadOptions(string fileName) and LoadOptions(Stream stream) methods will merge the content of the XML file with the current RasterCodecs options. Therefore, you can delete any option elements that do not override the default behavior from the file if desired.

Example

For an example, refer to LoadOptions(string fileName).

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies