Condividi tramite

Metodo ITextTemplatingEngineHost.LoadIncludeText

  • Articolo

Acquisisce il testo che corrisponde a una richiesta di includere un file modello di testo parziale.

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

Sintassi

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

Parametri

  • requestFileName
    Tipo: System.String
    Il nome del file modello di testo parziale da acquistare.
  • location
    Tipo: System.String%
    In String contenente la posizione del testo acquisito.Se l'host cerca il Registro di sistema il percorso dei file di inclusione o se l'host trova più percorsi per impostazione predefinita, l'host può restituire il percorso finale del file di inclusione in questo parametro.l'host può impostare location in Empty se il file non può essere trovato o se l'host non viene file system base.

Valore restituito

Tipo: System.Boolean
true per indicare che l'host è stato possibile acquisire il testo; in caso contrario, false.

Note

se l'utente ha specificato il facoltativo include la direttiva nel modello di testo, il motore chiama questo metodo.Questo metodo può essere chiamato 0, 1, o più volte per ogni trasformazione.Per ulteriori informazioni, vedere Direttive di modello di testo T4.

Questo metodo può essere chiamato da un processore di direttiva personalizzato.

Esempi

Nell'esempio di codice seguente viene illustrata un'implementazione anche un host personalizzato.Questo esempio di codice fa parte di un esempio più esaustivo.per l'esempio completo, vedere Procedura dettagliata: creazione di un host del modello di testo personalizzato.

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

Sicurezza di .NET Framework

Vedere anche

Riferimenti

ITextTemplatingEngineHost Interfaccia

Spazio dei nomi Microsoft.VisualStudio.TextTemplating

Altre risorse

Procedura dettagliata: creazione di un host del modello di testo personalizzato