ITextTemplatingEngineHost.LoadIncludeText-Methode

Artikel
07/20/2011

Erfasst den zugehörigen Text einer Anforderung, eine partielle Textvorlagendatei einzufügen.

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

Syntax

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

Parameter

requestFileName
Typ: System.String
Der Name der partiellen Textvorlagendatei, die abgerufen werden soll.

content
Typ: System.String%
Ein String, der den erfassten Text enthält, oder Empty, wenn die Datei nicht gefunden wurde.

location
Typ: System.String%
Ein String-Wert, der den Speicherort des erfassten Textes enthält.Wenn der Host die Registrierung nach den Speicherorten von Includedateien durchsucht oder wenn er standardmäßig mehrere Speicherorte durchsucht, kann der Host den endgültigen Pfad der Includedatei in diesem Parameter zurückgeben.Der Host kann die location auf Empty festlegen, wenn die Datei nicht gefunden werden konnte oder der Host nicht dateisystembasiert ist.

Rückgabewert

Typ: System.Boolean
true, um anzugeben, dass der Text vom Host abgerufen werden konnte, andernfalls false.

Hinweise

Wenn der Benutzer die optionale include-Direktive in einer Textvorlage angegeben hat, ruft das Modul diese Methode auf. Diese Methode kann als 0-mal, 1-mal oder mehrmals für jede Transformation aufgerufen werden. Weitere Informationen finden Sie unter T4-Textvorlagendirektiven.

Diese Methode kann auch von einem benutzerdefinierte Direktivenprozessor aufgerufen werden.

Beispiele

Im folgenden Codebeispiel wird eine mögliche Implementierung für einen benutzerdefinierten Host veranschaulicht. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels. Das vollständige Beispiel finden Sie unter Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts.

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

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

ITextTemplatingEngineHost Schnittstelle

Microsoft.VisualStudio.TextTemplating-Namespace

Weitere Ressourcen

Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts

Freigeben über