TextTransformation 类

所有生成的转换类的抽象基类。 此类还提供用于文本模板代码的实用工具方法和属性。

继承层次结构

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

命名空间：  Microsoft.VisualStudio.TextTemplating
程序集：  Microsoft.VisualStudio.TextTemplating.11.0（在 Microsoft.VisualStudio.TextTemplating.11.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。）
	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（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.TextTemplating 命名空间

其他资源

代码生成和 T4 文本模板