EncodingProperties object

 

 

Prototype for EncodingProperties objects. Is a kind of ConfigurationObject.

Syntax

var encoding_props = new EncodingProperties();
encoding_props.encoding = "UTF-8";
encoding_props.use_signature = false; // do not search for a signature! we want to force UTF-8 usage.

Parameters

none.

Property Of

none.

Implemented In

ECMerge 2.1

Description

EncodingProperties give the necessary information to load or save text files. 

Properties

Property	Description
allow_approximations	Boolean. True if loosing some symbols during conversion is acceptable
encoding	Encoding String or empty string. If empty, default value should be used, else encoding in which text files should loaded or saved.
keep_coherent_signatures	Boolean. True if the encoding detected at load time should be kept when saving when this encoding was detected through a signature mechanism (Unicode has such signature), even if 'encoding' is specified
line_delimiter	Line Delimiter String or empty string. If not empty, indicates which line delimiter should be used when writing text. If empty, line delimiters are kept intact when writing.
use_signature	Boolean. When loading: True if Unicode signature should be searched. When writing: True if Unicode signature should be generated

 

Methods

 none specific.

Examples

Example 1.

This sample create an EncodingProperties object and then sets various members. 

var encoding_props = new EncodingProperties();
encoding_props.encoding = "UTF-8";
encoding_props.use_signature = false; // do not search for a signature! we want to force UTF-8 usage.
encoding_props.allow_approximations = false; //  do not accept approximations!

See Also 

 ConfigurationObject object,