Método ITextTemplatingEngineHost.ResolveParameterValue

Artigo
08/01/2011

Resolve o valor de um parâmetro para um processador de diretriz se o parâmetro não for especificado no texto do modelo.

Namespace: Microsoft.VisualStudio.TextTemplating
Assembly: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (em Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Sintaxe

'Declaração
Function ResolveParameterValue ( _
    directiveId As String, _
    processorName As String, _
    parameterName As String _
) As String

string ResolveParameterValue(
    string directiveId,
    string processorName,
    string parameterName
)

String^ ResolveParameterValue(
    String^ directiveId, 
    String^ processorName, 
    String^ parameterName
)

abstract ResolveParameterValue : 
        directiveId:string * 
        processorName:string * 
        parameterName:string -> string

function ResolveParameterValue(
    directiveId : String, 
    processorName : String, 
    parameterName : String
) : String

Parâmetros

directiveId
Tipo: System.String
A identificação da chamada diretiva ao qual o parâmetro pertence.Essa identificação retira a ambigüidade de chamadas repetidas para a mesma diretiva a partir do mesmo modelo de texto.

processorName
Tipo: System.String
O nome do processador de diretriz ao qual a diretiva pertence.

parameterName
Tipo: System.String
O nome do parâmetro seja resolvido.

Valor de retorno

Tipo: System.String
A String que representa o valor do parâmetro resolvido.

Comentários

Esse método pode ser chamado por um processador de diretriz ou do código de um modelo de texto para obter os valores do host do modelo de texto. Normalmente, o processador de diretriz chamará o método para obter um valor padrão para um parâmetro da diretiva.

Por exemplo, no host que executa o utilitário de linha de comando TextTransform.exe, este método recupera os valores a partir de –a opção de linha de comando. Para obter mais informações, consulte Gerando arquivos com o utilitário TextTransform.

Exemplos

O exemplo de código a seguir mostra uma implementação possível para um host personalizado. Este exemplo de código é parte de um exemplo maior. For the complete example, see Demonstra Passo a passo: A criação de um Host de modelo de texto personalizado.

public string ResolveParameterValue(string directiveId, string processorName, string parameterName)
{
    if (directiveId == null)
    {
        throw new ArgumentNullException("the directiveId cannot be null");
    }
    if (processorName == null)
    {
        throw new ArgumentNullException("the processorName cannot be null");
    }
    if (parameterName == null)
    {
        throw new ArgumentNullException("the parameterName cannot be null");
    }

    //code to provide "hard-coded" parameter values goes here
    //this code depends on the directive processors this host will interact with

    //if we cannot do better - return the empty string
    return String.Empty;
}

Public Function ResolveParameterValue(ByVal directiveId As String, ByVal processorName As String, ByVal parameterName As String) As String Implements Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost.ResolveParameterValue

    If directiveId Is Nothing Then
        Throw New ArgumentNullException("the directiveId cannot be null")
    End If
    If processorName Is Nothing Then
        Throw New ArgumentNullException("the processorName cannot be null")
    End If
    If parameterName Is Nothing Then
        Throw New ArgumentNullException("the parameterName cannot be null")
    End If

    'code to provide "hard-coded" parameter values goes here
    'this code depends on the directive processors this host will interact with

    'if we cannot do better - return the empty string
    Return String.Empty
End Function

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

ITextTemplatingEngineHost Interface

Namespace Microsoft.VisualStudio.TextTemplating

Outros recursos

Demonstra Passo a passo: A criação de um Host de modelo de texto personalizado

Compartilhar via