Click to Rate and Give Feedback
MSDN
MSDN Library
Visual Studio 2008
Visual Studio
Visual Studio SDK
 SetOutputEncoding Method
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
Domain-Specific Language Tools Reference
ITextTemplatingEngineHost..::.SetOutputEncoding Method

Updated: November 2007

Tells the host the encoding that is expected for the generated text output.

Namespace:  Microsoft.VisualStudio.TextTemplating
Assembly:  Microsoft.VisualStudio.TextTemplating (in Microsoft.VisualStudio.TextTemplating.dll)

Visual Basic (Declaration)
Sub SetOutputEncoding ( _
    encoding As Encoding, _
    fromOutputDirective As Boolean _
)
Visual Basic (Usage)
Dim instance As ITextTemplatingEngineHost
Dim encoding As Encoding
Dim fromOutputDirective As Boolean

instance.SetOutputEncoding(encoding, _
    fromOutputDirective)
C#
void SetOutputEncoding(
    Encoding encoding,
    bool fromOutputDirective
)
Visual C++
void SetOutputEncoding(
    Encoding^ encoding, 
    bool fromOutputDirective
)
JScript
function SetOutputEncoding(
    encoding : Encoding, 
    fromOutputDirective : boolean
)

Parameters

encoding
Type: System.Text..::.Encoding

The encoding for the generated text output.

fromOutputDirective
Type: System..::.Boolean

true to indicate that the user specified the encoding in the encoding parameter of the output directive.

The engine calls this method if the user has specified the optional encoding parameter of the template directive in a text template. For more information, see Directive Syntax (Domain-Specific Languages).

The following code example shows a possible implementation for a custom host. This code example is part of a larger example that is provided for the ITextTemplatingEngineHost interface.

C#
private Encoding fileEncodingValue = Encoding.UTF8;
public Encoding FileEncoding
{
    get { return fileEncodingValue; }
}

public void SetOutputEncoding(System.Text.Encoding encoding, bool fromOutputDirective)
{
    fileEncodingValue = encoding;
}
Visual Basic
Private fileEncodingValue As Encoding = Encoding.UTF8
Public ReadOnly Property fileEncoding() As Encoding
    Get
        Return fileEncodingValue
    End Get
End Property

Public Sub SetOutputEncoding(ByVal encoding As System.Text.Encoding, ByVal fromOutputDirective As Boolean) Implements ITextTemplatingEngineHost.SetOutputEncoding

    fileEncodingValue = encoding
End Sub
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker