Metodo ITextTemplatingEngineHost.ResolveParameterValue

Articolo
08/11/2011

Risolve il valore di un parametro di un processore di direttiva se il parametro non è specificato nel testo del modello.

Spazio dei nomi: Microsoft.VisualStudio.TextTemplating
Assembly: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (in Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Sintassi

'Dichiarazione
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

Parametri

directiveId
Tipo: System.String
ID della chiamata di direttiva a cui appartiene il parametro.Questo ID consente di distinguere più chiamate ripetute alla stessa direttiva dallo stesso modello di testo.

processorName
Tipo: System.String
Nome del processore di direttiva a cui appartiene la direttiva.

parameterName
Tipo: System.String
Nome del parametro da risolvere.

Valore restituito

Tipo: System.String
Oggetto String che rappresenta il valore del parametro risolto.

Note

Questo metodo può essere chiamato da un processore di direttiva o dal codice di un modello di testo per ottenere i valori dall'host del modello di testo. In genere il processore di direttiva chiamerà il metodo per ottenere un valore predefinito per un parametro della direttiva.

Ad esempio, nell'host che viene eseguito nell'utilità della riga di comando TextTransform.exe, questo metodo consente di recuperare i valori dall'opzione della riga di comando –a. Per ulteriori informazioni, vedere Generating Files with the TextTransform Utility.

Esempi

Nell'esempio di codice seguente viene illustrata una possibile implementazione di un host personalizzato. Questo esempio di codice fa parte di un esempio più esaustivo. Per l'esempio completo, vedere Walkthrough: Creating a Custom Text Template Host.

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

Sicurezza di .NET Framework

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.

Vedere anche

Riferimenti

ITextTemplatingEngineHost Interfaccia

Spazio dei nomi Microsoft.VisualStudio.TextTemplating

Altre risorse

Walkthrough: Creating a Custom Text Template Host

Condividi tramite