ITextTemplatingEngineHost.LoadIncludeText - метод

Статья
11/01/2012

Получает текст, соответствующий запросу на включение частичного файла текстового шаблона.

Пространство имен: Microsoft.VisualStudio.TextTemplating
Сборка: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (в Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Синтаксис

'Декларация
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

Параметры

requestFileName
Тип: System.String
Имя получаемого частичного файла текстового шаблона.

content
Тип: System.String%
Объект String, содержащий полученный текст (или значение Empty, если искомый файл не найден).

location
Тип: System.String%
Строка String, содержащая расположение полученного текста.Если узел выполняет поиск расположения включаемых файлов в реестре или по умолчанию выполняет поиск в нескольких расположениях, он может вернуть в этом параметре итоговый путь включаемого файла.Узел может присвоить параметру location значение Empty, если файл не обнаружен или узел не использует файловую систему.

Возвращаемое значение

Тип: System.Boolean
Значение true, если узлу удалось получить текст; в противном случае — значение false.

Заметки

Если пользователь указал необязательную директиву include в шаблоне текста, этот метод вызывается обработчиком.Этот метод может вызываться 0, 1 или несколько раз для каждого преобразования.Дополнительные сведения см. в разделе Директивы текстовых шаблонов T4.

Этот метод также может быть вызван из пользовательского процессора директив.

Примеры

В следующем примере кода показана возможная реализация пользовательского основного приложения.Данный пример кода является частью большего примера.Полный пример см. в разделе Пошаговое руководство. Создание пользовательского хост-класса для текстовых шаблонов.

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

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

ITextTemplatingEngineHost Интерфейс

Microsoft.VisualStudio.TextTemplating - пространство имен

Другие ресурсы

Пошаговое руководство. Создание пользовательского хост-класса для текстовых шаблонов

Поделиться через