Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip.ReaderWriter Namespace / ZipWriter Class / TextEncoding Property


In This Topic
    TextEncoding Property (ZipWriter)
    In This Topic
    Gets or sets the text encoding that will be applied to files that are added to the zip archive.
    Syntax
    'Declaration
     
    Public Property TextEncoding As TextEncoding
    'Usage
     
    Dim instance As ZipWriter
    Dim value As TextEncoding
     
    instance.TextEncoding = value
     
    value = instance.TextEncoding
    public TextEncoding TextEncoding {get; set;}

    Property Value

    A TextEncoding value representing the text encoding that will be applied to files that are added to the zip archive. By default, TextEncoding.Standard.
    Remarks

    This property only specifies what text encoding is to be used in the main zip headers, not the Unicode, UTF8Filename and UTF8Comment extra headers.

    Note that for each item written, the property's value is only used if non-ASCII characters are detected in the filename or comment.

    In most cases, the default value is sufficient. Using any value other than TextEncoding.Standard breaks backward compatibility with Zip utilities and libraries that do not support different text encodings in the standard zip headers. In practice, these 3rd party utilities might display a filename differently than expected and the behavior might change depending on the native language of the target machine.

    For this reason, the UTF8Filename and UTF8Comment extra headers that are always enabled provide a much better solution, as they are simply ignored by zip tools and libraries
    that do not support them.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also