Metodo ITextTemplatingEngineHost.LoadIncludeText

Articolo
08/11/2011

Acquisisce il testo che corrisponde a una richiesta di inclusione di 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
Nome del file modello di testo parziale da acquisire.

content
Tipo: System.String%
Oggetto String che contiene il testo acquisito oppure Empty se non è stato possibile trovare il file.

location
Tipo: System.String%
Oggetto String che contiene la posizione del testo acquisito.Se l'host cerca nel Registro di sistema il percorso dei file di inclusione o se per impostazione predefinita l'host cerca in più percorsi, l'host può restituire il percorso finale del file di inclusione in questo parametro.L'host può impostare location su Empty se non è stato possibile trovare il file o se l'host non è basato sul file system.

Valore restituito

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

Note

Se l'utente ha specificato la direttiva include facoltativa in un 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 T4 Text Template Directives.

È possibile chiamare questo metodo anche da un processore di direttiva personalizzato.

Esempi

Nell'esempio di codice seguente viene illustrata una possibile implementazione di un host personalizzato. Questo esempio di codice fa parte di un esempio più esaustivo. Per l'esempio completo, vedere Walkthrough: Creating a Custom Text Template Host.

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

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.

Vedere anche

Riferimenti

ITextTemplatingEngineHost Interfaccia

Spazio dei nomi Microsoft.VisualStudio.TextTemplating

Altre risorse

Walkthrough: Creating a Custom Text Template Host

Condividi tramite