ITextTemplatingEngineHost.ResolveParameterValue, méthode

Article
08/10/2011

Résout la valeur d'un paramètre de processeur de directive si ce paramètre n'est pas spécifié dans le texte du modèle.

Espace de noms : Microsoft.VisualStudio.TextTemplating
Assembly : Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (dans Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Syntaxe

'Déclaration
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

Paramètres

directiveId
Type : System.String
ID de l'appel de directive auquel appartient le paramètre.Cet ID lève l'ambiguïté entre des appels répétés à une même directive à partir du même modèle de texte.

processorName
Type : System.String
Nom du processeur de directive auquel appartient la directive.

parameterName
Type : System.String
Nom du paramètre à résoudre.

Valeur de retour

Type : System.String
String qui représente la valeur de paramètre résolue.

Notes

Cette méthode peut être appelée par un processeur de directive ou à partir du code d'un modèle de texte pour obtenir des valeurs de l'hôte de modèle de texte. En général, le processeur de directive appellera la méthode pour obtenir une valeur par défaut pour un paramètre de la directive.

Par exemple, dans l'hôte qui est exécuté dans l'utilitaire en ligne de commande TextTransform.exe, cette méthode extrait des valeurs de l'option de ligne de commande –a. Pour plus d'informations, consultez Génération de fichiers avec l'utilitaire TextTransform.

Exemples

L'exemple de code suivant montre une implémentation possible pour un hôte personnalisé. Cet exemple de code est extrait d'un exemple plus développé. Pour obtenir un exemple complet, consultez Procédure pas à pas : création d'un hôte de modèle de texte personnalisé.

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

ITextTemplatingEngineHost Interface

Microsoft.VisualStudio.TextTemplating, espace de noms

Autres ressources

Procédure pas à pas : création d'un hôte de modèle de texte personnalisé

Partager via