ModelBusEnabledTextTransformation - класс
Чтобы обратиться к Visual Studio ModelBus в коде текстового шаблона, укажите этот класс в атрибуте inherits директивы template шаблона и задайте атрибуту hostspecific значение true.В коде шаблона можно получить службы SModelBus и SComponentModel.
Иерархия наследования
System.Object
Microsoft.VisualStudio.TextTemplating.TextTransformation
Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation
Пространство имен: Microsoft.VisualStudio.TextTemplating.Modeling
Сборка: Microsoft.VisualStudio.TextTemplating.Modeling.11.0 (в Microsoft.VisualStudio.TextTemplating.Modeling.11.0.dll)
Синтаксис
'Декларация
Public MustInherit Class ModelBusEnabledTextTransformation _
Inherits ModelingTextTransformation
public abstract class ModelBusEnabledTextTransformation : ModelingTextTransformation
public ref class ModelBusEnabledTextTransformation abstract : public ModelingTextTransformation
[<AbstractClass>]
type ModelBusEnabledTextTransformation =
class
inherit ModelingTextTransformation
end
public abstract class ModelBusEnabledTextTransformation extends ModelingTextTransformation
Тип ModelBusEnabledTextTransformation предоставляет следующие члены.
Конструкторы
| Имя | Описание | |
|---|---|---|
.gif "Защищенный метод") |
ModelBusEnabledTextTransformation |
В начало страницы
Свойства
| Имя | Описание | |
|---|---|---|
.gif "Открытое свойство") |
CurrentIndent | Получает текущий текст отступа, добавляемый в начало каждой строки генерируемого выходного текста. (Унаследовано от TextTransformation.) |
|
Errors | Инфраструктура. Получает коллекцию ошибок для процесса преобразования текстового шаблона. (Унаследовано от TextTransformation.) |
.gif "Защищенное свойство") |
GenerationEnvironment | Получает или задает строку, используемую процессом преобразования текстового шаблона для создания выходного текста. (Унаследовано от TextTransformation.) |
|
ModelBus | Получает службу Visual Studio ModelBus, предоставляемую этим базовым классом. |
|
ServiceProvider | Возвращает поставщика служб, содержащего Visual Studio ModelBus.Не следует использовать поставщик услуг из основного приложения. (Переопределяет ModelingTextTransformation.ServiceProvider.) |
|
Session | (Унаследовано от ModelingTextTransformation.) |
|
SkipValidation | Если это свойство имеет значение true, метод ValidateStore() не выполняет проверку и возвращает значение false.По умолчанию используется значение false. (Унаследовано от ModelingTextTransformation.) |
|
Store | Получает хранилище моделей. (Унаследовано от ModelingTextTransformation.) |
В начало страницы
Методы
| Имя | Описание | |
|---|---|---|
|
AddDomainModel | Добавляет тип модели домена, загружаемый в хранилище.Этот метод необходимо вызвать для каждой модели домена, прежде чем вызывать метод Initialize(). (Унаследовано от ModelingTextTransformation.) |
.gif "Открытый метод") |
ClearIndent | Очищает строку CurrentIndent. (Унаследовано от TextTransformation.) |
|
Dispose() | Освобождает все ресурсы, используемые объектом TextTransformation. (Унаследовано от TextTransformation.) |
|
Dispose(Boolean) | (Унаследовано от ModelingTextTransformation.) |
|
Equals | Определяет, равен ли заданный объект текущему объекту. (Унаследовано от Object.) |
|
Error | Создает новую ошибку для хранения информации об ошибках, возникших в процессе преобразования текстового шаблона. (Унаследовано от TextTransformation.) |
|
Finalize | Позволяет объекту Object попытаться освободить ресурсы и выполнить другие операции очистки, прежде чем объект утилизируется сборщиком мусора.Вызывается сборщиком мусора. (Унаследовано от TextTransformation.) |
|
GetHashCode | Играет роль хэш-функции для определенного типа. (Унаследовано от Object.) |
|
GetType | Возвращает объект Type для текущего экземпляра. (Унаследовано от Object.) |
|
Initialize | Загружает модели, указанные с помощью метода AddModel(), и подготавливает узел к обработке шаблона. (Унаследовано от ModelingTextTransformation.) |
|
MemberwiseClone | Создает неполную копию текущего объекта Object. (Унаследовано от Object.) |
|
OnSessionChanged | Вызывается каждый раз, когда предоставленный сеанс не совпадает с последним запомненным сеансом.Очищает статичный экземпляр modelbus для подготовки к чтению нового моментального снимка файлов модели. (Переопределяет ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession).) |
|
PopIndent | Удаляет из свойства CurrentIndent текст, добавленный последним. (Унаследовано от TextTransformation.) |
|
PushIndent | Добавляет текст в строку CurrentIndent, добавляемую в начало каждой строки генерируемого выходного текста. (Унаследовано от TextTransformation.) |
|
ReportError | Преобразует ошибки ModelBus в ошибки текстового шаблона.Вызывает this.Error или this.Warning в зависимости от значения категории. |
|
ToString | Возвращает строку, которая представляет текущий объект. (Унаследовано от Object.) |
|
TransformText | При переопределении в производном классе создает выходной текст преобразования. (Унаследовано от TextTransformation.) |
|
ValidateStore | Проверяет хранилище, используя указанные категории проверки.При отсутствии ошибок возвращает значение true. (Унаследовано от ModelingTextTransformation.) |
|
Warning | Создает новое предупреждение для хранения информации об ошибках, возникших в процессе преобразования текстового шаблона. (Унаследовано от TextTransformation.) |
|
Write(String) | Добавляет копию указанной строки в конце созданного выходного текста. (Унаследовано от TextTransformation.) |
|
Write(String, array<Object[]) | Добавляет в создаваемый выходной текст форматированную строку, содержащую нуль или несколько спецификаций формата.Каждая спецификация формата заменяется строковым представлением соответствующего объекта-аргумента. (Унаследовано от TextTransformation.) |
|
WriteLine(String) | Добавляет копию указанной строки и знак завершения строки по умолчанию в конце созданного выходного текста. (Унаследовано от TextTransformation.) |
|
WriteLine(String, array<Object[]) | Добавляет в создаваемый выходной текст форматированную строку, содержащую нуль или несколько спецификаций формата, и знак завершения строки по умолчанию.Каждая спецификация формата заменяется строковым представлением соответствующего объекта-аргумента. (Унаследовано от TextTransformation.) |
В начало страницы
Заметки
Чтобы использовать это преобразование текста в шаблоне, необходимо задать атрибуту hostspecific значение true в директиве template.
Примеры
<#@ template debug="false" hostspecific="true" language="C#" inherits="Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation" #>
<#@ assembly name="Microsoft.VisualStudio.TextTemplating.Modeling.11.0.dll" #>
<#@ assembly name="Microsoft.VisualStudio.Modeling.Sdk.Integration.11.0.dll" #>
<#@ import namespace="Microsoft.VisualStudio.Modeling.Integration" #>
<#@ output extension=".txt" #>
<# IModelBus modelbus = this.ServiceProvider.GetService(typeof(SModelBus)) as IModelBus;
...
#>
Потокобезопасность
Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.
См. также
Ссылки
Microsoft.VisualStudio.TextTemplating.Modeling - пространство имен