Partager via


ModelBusEnabledTextTransformation, classe

Pour accéder au ModelBus Visual Studio dans le code d'un modèle de texte, spécifiez cette classe dans l'attribut inherits de la directive template du modèle, puis affectez à l'attribut hostspecific la valeur true. Dans le code du modèle, vous pouvez obtenir les services SModelBus et SComponentModel.

Hiérarchie d'héritage

Object
  Microsoft.VisualStudio.TextTemplating.TextTransformation
    Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
      Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation

Espace de noms :  Microsoft.VisualStudio.TextTemplating.Modeling
Assembly :  Microsoft.VisualStudio.TextTemplating.Modeling.12.0 (dans Microsoft.VisualStudio.TextTemplating.Modeling.12.0.dll)

Syntaxe

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

Le type ModelBusEnabledTextTransformation expose les membres suivants.

Constructeurs

  Nom Description
Méthode protégée ModelBusEnabledTextTransformation

Début

Propriétés

  Nom Description
Propriété publique CurrentIndent Obtient le texte de retrait actuel, ajouté au début de chaque ligne de la sortie de texte générée. (Hérité de TextTransformation.)
Propriété publique Errors Infrastructure. Obtient la collection d'erreurs pour le processus de transformation de modèle de texte. (Hérité de TextTransformation.)
Propriété protégée GenerationEnvironment Obtient ou définit la chaîne utilisée par le processus de transformation de modèle de texte pour assembler la sortie de texte générée. (Hérité de TextTransformation.)
Propriété protégée ModelBus Obtient le service ModelBus de Visual Studio fourni par cette classe de base.
Propriété protégée ServiceProvider Retourne un fournisseur de services qui contient le ModelBus de Visual Studio.N'utilisez pas le fournisseur de services de l'hôte. (Substitue ModelingTextTransformation.ServiceProvider.)
Propriété publique Session (Hérité de ModelingTextTransformation.)
Propriété protégée SkipValidation Si true, ValidateStore() n'exécute pas de validation et retourne la valeur false.La valeur par défaut est false. (Hérité de ModelingTextTransformation.)
Propriété protégée Store Obtient le magasin de modélisations. (Hérité de ModelingTextTransformation.)

Début

Méthodes

  Nom Description
Méthode protégée AddDomainModel Ajoute un type de modèle de domaine à charger par le magasin.Appelle cette méthode pour chaque modèle de domaine avant d'appeler Initialize(). (Hérité de ModelingTextTransformation.)
Méthode publique ClearIndent Remplace le CurrentIndent par une chaîne vide. (Hérité de TextTransformation.)
Méthode publique Dispose() Libère toutes les ressources utilisées par TextTransformation. (Hérité de TextTransformation.)
Méthode protégée Dispose(Boolean) (Hérité de ModelingTextTransformation.)
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode publique Error Crée une erreur pour consigner des informations à propos des erreurs qui se produisent pendant le processus de transformation de modèle de texte. (Hérité de TextTransformation.)
Méthode protégée Finalize Autorise Object à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il soit récupéré par le garbage collector.Appelé par le garbage collector. (Hérité de TextTransformation.)
Méthode publique GetHashCode Sert de fonction de hachage par défaut. (Hérité de Object.)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique Initialize Charge les modèles spécifiés à l'aide d'AddModel() et prépare l'hôte pour le traitement du modèle. (Hérité de ModelingTextTransformation.)
Méthode protégée MemberwiseClone Crée une copie superficielle du Object actuel. (Hérité de Object.)
Méthode protégée OnSessionChanged appelée chaque fois qu'une session fournie est différente de la dernière session mémorisée.Efface l'instance de ModelBus statique à préparer pour un nouvel instantané des fichiers de modèles à lire. (Substitue ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession).)
Méthode publique PopIndent Supprime le dernier texte ajouté à partir de CurrentIndent. (Hérité de TextTransformation.)
Méthode publique PushIndent Ajoute le texte à CurrentIndent, lequel est placé au début de chaque ligne dans la sortie de texte générée. (Hérité de TextTransformation.)
Méthode protégée ReportError Convertit des erreurs de ModelBus en erreurs de modèle de texte.Appelle this.Error ou this.Warning selon la valeur de la catégorie.
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
Méthode publique TransformText En cas de substitution dans une classe dérivée, génère la sortie de texte de la transformation. (Hérité de TextTransformation.)
Méthode protégée ValidateStore Valide le magasin avec les catégories de validation données.Retourne la valeur true s'il y a des erreurs. (Hérité de ModelingTextTransformation.)
Méthode publique Warning Crée un avertissement pour consigner des informations à propos des erreurs qui se produisent pendant le processus de transformation de modèle de texte. (Hérité de TextTransformation.)
Méthode publique Write(String) Ajoute une copie de la chaîne spécifiée à la sortie de texte générée. (Hérité de TextTransformation.)
Méthode publique Write(String, array<Object[]) Ajoute, à la sortie de texte générée, une chaîne mise en forme qui contient zéro, une ou plusieurs spécifications de format.Chaque spécification de format est remplacée par la représentation sous forme de chaîne d'un argument objet correspondant. (Hérité de TextTransformation.)
Méthode publique WriteLine(String) Ajoute, à la sortie de texte générée, une copie de la chaîne spécifiée et la marque de fin de ligne par défaut. (Hérité de TextTransformation.)
Méthode publique WriteLine(String, array<Object[]) Ajoute, à la sortie de texte générée, une chaîne mise en forme qui contient zéro, une ou plusieurs spécifications de format et la marque de fin de ligne par défaut.Chaque spécification de format est remplacée par la représentation sous forme de chaîne d'un argument objet correspondant. (Hérité de TextTransformation.)

Début

Notes

Pour utiliser cette transformation de texte dans un modèle, vous devez affecter à l'attribut hostspecific la valeur true dans la directive template.

Exemples

<#@ 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; 
...
#>

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.TextTemplating.Modeling, espace de noms