Método ITextTemplatingEngineHost.LoadIncludeText

Artigo
10/26/2012

Adquire o texto que corresponde a uma solicitação para incluir um arquivo de modelo de partes do texto.

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

Sintaxe

'Declaração
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
O nome do arquivo de modelo de partes do texto para adquirir.

content
Tipo: System.String%
A String que contém o texto adquirido ou Empty se o arquivo não pôde ser encontrado.

location
Tipo: System.String%
A String que contém o local do texto adquirido.Se o host de pesquisar o registro para o local dos arquivos de inclusão ou se o host pesquisará a vários locais por padrão, o host pode retornar o caminho final do arquivo incluir neste parâmetro.O host pode definir o location para Empty se o arquivo não foi encontrado ou se o host não é um sistema de arquivos com base em.

Valor de retorno

Tipo: System.Boolean
true para indicar que o host foi capaz de adquirir o texto; Caso contrário, false.

Comentários

Se o usuário tiver especificado o opcional include chama o mecanismo de diretiva em um modelo de texto, esse método.Esse método pode ser chamado de 0, 1 ou várias vezes para cada transformação.Para obter mais informações, consulte T4 Diretivas de modelo de texto.

Esse método também pode ser chamado a partir de um processador de diretriz personalizado.

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 Passo a passo: Criando um Host de modelo de texto personalizado.

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

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

Passo a passo: Criando um Host de modelo de texto personalizado

Compartilhar via