ITextTemplatingEngineHost.LoadIncludeText, méthode

Article
11/15/2012

Acquiert le texte correspondant à une requête d'inclusion d'un fichier de modèle de texte partiel.

Espace de noms : Microsoft.VisualStudio.TextTemplating
Assembly : Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (dans Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Syntaxe

'Déclaration
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

Paramètres

requestFileName
Type : System.String
Nom du fichier de modèle de texte partiel à acquérir.

content
Type : System.String%
String qui contient l'objet acquis ou Empty si l'objet est introuvable.

location
Type : System.String%
String qui contient l'emplacement du texte acquis.Si l'hôte recherche dans le Registre l'emplacement de fichiers Include ou s'il recherche plusieurs emplacements par défaut, l'hôte peut retourner le chemin d'accès final du fichier Include dans ce paramètre.L'hôte peut affecter la valeur Empty à location si le fichier est introuvable ou si l'hôte n'utilise pas le système de fichiers.

Valeur de retour

Type : System.Boolean
true pour indiquer que l'hôte a pu acquérir le texte ; sinon, false.

Notes

Si l'utilisateur a spécifié la directive include facultative dans un modèle de texte, le moteur appelle cette méthode.Cette méthode peut être appelée plusieurs fois, 1 fois ou 0 fois pour chaque transformation.Pour plus d'informations, consultez Directives de modèles de texte T4.

Cette méthode peut également être appelée à partir d'un processeur de directive personnalisé.

Exemples

L'exemple de code suivant montre une implémentation possible pour un hôte personnalisé.Cet exemple de code est extrait d'un exemple plus développé.Pour obtenir un exemple complet, consultez Procédure pas à pas : création d'un hôte de modèle de texte personnalisé.

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

ITextTemplatingEngineHost Interface

Microsoft.VisualStudio.TextTemplating, espace de noms

Autres ressources

Procédure pas à pas : création d'un hôte de modèle de texte personnalisé

Partager via