TextTransformation - класс

  • Статья

Абстрактный базовый класс для всех создаваемых классов преобразования. Этот класс также предоставляет вспомогательные методы и свойства, используемые в коде текстового шаблона.

Иерархия наследования

System.Object
  Microsoft.VisualStudio.TextTemplating.TextTransformation
    Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation

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

Синтаксис

'Декларация
Public MustInherit Class TextTransformation _
    Implements IDisposable

public abstract class TextTransformation : IDisposable

public ref class TextTransformation abstract : IDisposable

[<AbstractClass>]
type TextTransformation =  
    class
        interface IDisposable
    end

public abstract class TextTransformation implements IDisposable

Тип TextTransformation предоставляет следующие члены.

Конструкторы

  Имя Описание
Защищенный метод TextTransformation Инициализирует новый экземпляр класса TextTransformation.

В начало страницы

Свойства

  Имя Описание
Открытое свойство CurrentIndent Получает текущий текст отступа, добавляемый в начало каждой строки генерируемого выходного текста.
Открытое свойство Errors Инфраструктура. Получает коллекцию ошибок для процесса преобразования текстового шаблона.
Защищенное свойство GenerationEnvironment Получает или задает строку, используемую процессом преобразования текстового шаблона для создания выходного текста.
Открытое свойство Session Получает или задает текущий сеанс.Сеанс представляет серию преобразований, выполняемых в рамках одной команды пользователя.Объект сеанса можно использовать для передачи информации в код текстового шаблона.

В начало страницы

Методы

  Имя Описание
Открытый метод ClearIndent Очищает строку CurrentIndent.
Открытый метод Dispose() Освобождает все ресурсы, используемые объектом TextTransformation.
Защищенный метод Dispose(Boolean) Освобождает неуправляемые ресурсы, используемые объектом TextTransformation, а при необходимости освобождает также управляемые ресурсы.
Открытый метод Equals Определяет, равен ли заданный объект Object текущему объекту Object. (Унаследовано от Object.)
Открытый метод Error Создает новую ошибку для хранения информации об ошибках, возникших в процессе преобразования текстового шаблона.
Защищенный метод Finalize Позволяет объекту Object попытаться освободить ресурсы и выполнить другие операции очистки, прежде чем объект утилизируется сборщиком мусора.Вызывается сборщиком мусора. (Переопределяет Object.Finalize().)
Открытый метод GetHashCode Играет роль хэш-функции для определенного типа. (Унаследовано от Object.)
Открытый метод GetType Возвращает объект Type для текущего экземпляра. (Унаследовано от Object.)
Открытый метод Initialize Инфраструктура. Инициализирует класс TextTransformation.
Защищенный метод MemberwiseClone Создает неполную копию текущего объекта Object. (Унаследовано от Object.)
Открытый метод PopIndent Удаляет из свойства CurrentIndent текст, добавленный последним.
Открытый метод PushIndent Добавляет текст в строку CurrentIndent, добавляемую в начало каждой строки генерируемого выходного текста.
Открытый метод ToString Возвращение строки, представляющей текущий объект. (Унаследовано от Object.)
Открытый метод TransformText При переопределении в производном классе создает выходной текст преобразования.
Открытый метод Warning Создает новое предупреждение для хранения информации об ошибках, возникших в процессе преобразования текстового шаблона.
Открытый метод Write(String) Добавляет копию указанной строки в конце созданного выходного текста.
Открытый метод Write(String, array<Object[]) Добавляет в создаваемый выходной текст форматированную строку, содержащую нуль или несколько спецификаций формата.Каждая спецификация формата заменяется строковым представлением соответствующего объекта-аргумента.
Открытый метод WriteLine(String) Добавляет копию указанной строки и знак завершения строки по умолчанию в конце созданного выходного текста.
Открытый метод WriteLine(String, array<Object[]) Добавляет в создаваемый выходной текст форматированную строку, содержащую нуль или несколько спецификаций формата, и знак завершения строки по умолчанию.Каждая спецификация формата заменяется строковым представлением соответствующего объекта-аргумента.

В начало страницы

Заметки

Процесс преобразования текстового шаблона состоит из двух шагов. На первом шаге обработчик преобразования текстового шаблона создает класс, обращение к которому производится как к генерируемому классу преобразования. На втором этапе ядро компилирует и выполняет сгенерированный класс преобразования, чтобы выдать сгенерированный выходной текст. Созданный класс преобразования наследует от TextTransformation.

Любой класс, указанный в директиве inherits текстового шаблона, должен сам наследовать от TextTransformation. TransformText является единственным abstract членом этого класса.

Потокобезопасность

Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.

См. также

Ссылки

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

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

Создание кода и текстовые шаблоны T4