Udostępnij za pośrednictwem

Metoda ITextTemplatingEngineHost.LoadIncludeText —

  • Artykuł

Nabywa tekstu, który odpowiada na żądanie, aby dołączyć plik szablonu fragment tekstu.

Przestrzeń nazw:  Microsoft.VisualStudio.TextTemplating
Zestaw:  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (w Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Składnia

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

Parametry

  • requestFileName
    Typ: System.String
    Nazwa pliku szablonu fragment tekstu do nabycia.
  • location
    Typ: System.String%
    A String zawierający lokalizację nabytych tekstu.Jeśli host przeszukuje rejestru dla lokalizacji plików dołączanych lub jeśli host przeszukuje wiele lokalizacji domyślnie, host może przywrócić ten parametr finalną ścieżką pliku dołączanego.Można ustawić host location do Empty , jeśli nie można odnaleźć pliku lub jeśli host nie jest system plików oparty.

Wartość zwracana

Typ: System.Boolean
true Aby wskazać, że host był w stanie nabyć tekstu; w przeciwnym razie false.

Uwagi

Jeśli użytkownik określił opcjonalna include dyrektywy w szablonie tekst silnika wywołuje tę metodę.0, 1 Lub wiele razy dla każdego transformacji można wywołać tej metody.Aby uzyskać więcej informacji, zobacz T4 Tekst szablonu dyrektyw.

Metoda ta również może zostać wywołana z niestandardowych procesora w dyrektywie.

Przykłady

Poniższy przykład kodu pokazuje możliwe wdrożenie niestandardowych hosta.Poniższy przykład kodu jest częścią większej przykład.Na przykład pełną, zobacz Instruktaż: Tworzenie hosta szablon niestandardowy tekst.

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

Zabezpieczenia programu .NET Framework

Zobacz też

Informacje

ITextTemplatingEngineHost Interfejs

Przestrzeń nazw Microsoft.VisualStudio.TextTemplating

Inne zasoby

Instruktaż: Tworzenie hosta szablon niestandardowy tekst