ITextTemplatingEngineHost.ResolveParameterValue (Método)

Artículo
11/02/2012

Resuelve el valor de un parámetro para un procesador de directivas si el parámetro no se especifica en el texto de la plantilla.

Espacio de nombres: Microsoft.VisualStudio.TextTemplating
Ensamblado: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (en Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Sintaxis

'Declaración
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
El identificador de la llamada de directiva a que pertenece el parámetro.Este identificador elimina la ambigüedad de llamadas repetidas a la misma directiva desde la misma plantilla de texto.

processorName
Tipo: System.String
El nombre del procesador de directivas al que pertenece la directiva.

parameterName
Tipo: System.String
Nombre del parámetro que se va a resolver.

Valor devuelto

Tipo: System.String
Valor de tipo String que representa el valor del parámetro resuelto.

Comentarios

Se puede llamar a este método mediante un procesador de directivas o desde el código de una plantilla de texto para obtener los valores del host de dicha plantilla.El procesador de directivas suele llamar al método para obtener un valor predeterminado para un parámetro de la directiva.

Por ejemplo, en el host que se ejecuta en la utilidad de línea de comandos TextTransform.exe, este método recupera valores de la opción de línea de comandos –a.Para obtener más información, vea Generar archivos con la utilidad TextTransform.

Ejemplos

El ejemplo de código siguiente muestra una posible implementación para un host personalizado.Este ejemplo de código forma parte de un ejemplo más extenso.Para obtener el ejemplo completo, vea Tutorial: Crear un host de plantillas de texto personalizadas.

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

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

ITextTemplatingEngineHost Interfaz

Microsoft.VisualStudio.TextTemplating (Espacio de nombres)

Otros recursos

Tutorial: Crear un host de plantillas de texto personalizadas

Share via