ITextTemplatingEngineHost.SetOutputEncoding Method

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)

Syntax

'Declaration
Sub SetOutputEncoding ( _
    encoding As Encoding, _
    fromOutputDirective As Boolean _
)

'Usage
Dim instance As ITextTemplatingEngineHost 
Dim encoding As Encoding 
Dim fromOutputDirective As Boolean

instance.SetOutputEncoding(encoding, _
    fromOutputDirective)

void SetOutputEncoding(
    Encoding encoding,
    bool fromOutputDirective
)

void SetOutputEncoding(
    Encoding^ encoding, 
    bool fromOutputDirective
)

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.

Remarks

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).

Examples

The following code example shows a possible implementation for a custom host. This code example is part of a larger example. For the complete example, see Walkthrough: Creating a Custom Text Template Host.

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

public void SetOutputEncoding(System.Text.Encoding encoding, bool fromOutputDirective)
{
    fileEncodingValue = encoding;
}

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ITextTemplatingEngineHost Interface

ITextTemplatingEngineHost Members

Microsoft.VisualStudio.TextTemplating Namespace

Other Resources

Walkthrough: Creating a Custom Text Template Host