Compartir a través de

ITextTemplatingEngineHost.LoadIncludeText (Método)

  • Artículo

Adquiere el texto que corresponde a una solicitud para incluir un archivo de plantilla de texto parcial.

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 LoadIncludeText ( _
    requestFileName As String, _
    <OutAttribute> ByRef content As String, _
    <OutAttribute> ByRef location As String _
) As Boolean

bool LoadIncludeText(
    string requestFileName,
    out string content,
    out string location
)

bool LoadIncludeText(
    String^ requestFileName, 
    [OutAttribute] String^% content, 
    [OutAttribute] String^% location
)

abstract LoadIncludeText : 
        requestFileName:string * 
        content:string byref * 
        location:string byref -> bool 

function LoadIncludeText(
    requestFileName : String, 
    content : String, 
    location : String
) : boolean

Parámetros

  • requestFileName
    Tipo: System.String
    El nombre del archivo de plantilla de texto parcial que se va a adquirir.
  • content
    Tipo: System.String%
    Un valor de tipo String que contiene el texto adquirido o Empty si no se puede encontrar el archivo.
  • location
    Tipo: System.String%
    Un valor de tipo String que contiene la ubicación del texto adquirido.Si el host busca en el Registro la ubicación de los archivos de inclusión o si busca varias ubicaciones de forma predeterminada, puede devolver la ruta de acceso final del archivo de inclusión en este parámetro.El host puede establecer el valor de location en Empty si no se pudo encontrar el archivo o si el host no está basado en sistemas de archivos.

Valor devuelto

Tipo: System.Boolean
Es true para indicar que el host pudo adquirir el texto; de lo contrario, es false.

Comentarios

Si el usuario ha especificado la directiva include opcional en una plantilla de texto, el motor llama a este método. Se puede llamar a este método 0, 1 o varias veces para cada transformación. Para obtener más información, vea Directivas de plantilla de texto T4.

También se puede llamar a este método desde un procesador de directivas personalizado.

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 bool LoadIncludeText(string requestFileName, out string content, out string location)
{
    content = System.String.Empty;
    location = System.String.Empty;
    
    //If the argument is the fully qualified path of an existing file,
    //then we are done.
    //----------------------------------------------------------------
    if (File.Exists(requestFileName))
    {
        content = File.ReadAllText(requestFileName);
        return true;
    }

    //This can be customized to search specific paths for the file.
    //This can be customized to accept paths to search as command line
    //arguments.
    //----------------------------------------------------------------
    else
    {
        return false;
    }
}

Public Function LoadIncludeText(ByVal requestFileName As String, ByRef content As String, ByRef location As String) As Boolean Implements ITextTemplatingEngineHost.LoadIncludeText

    content = System.String.Empty
    location = System.String.Empty

    'If the argument is the fully qualified path of an existing file,
    'then we are done.
    '----------------------------------------------------------------
    If File.Exists(requestFileName) Then

        content = File.ReadAllText(requestFileName)
        Return True

    'This can be customized to search specific paths for the file.
    'This can be customized to accept paths to search as command line
    'arguments.
    '----------------------------------------------------------------
    Else
        Return False
    End If
End Function

Seguridad de .NET Framework

Vea también

Referencia

ITextTemplatingEngineHost Interfaz

Microsoft.VisualStudio.TextTemplating (Espacio de nombres)

Otros recursos

Tutorial: Crear un host de plantillas de texto personalizadas