RequiresProvidesDirectiveProcessor 类

定义和实施所调用设计模式需要/提供的指令处理器的抽象基类。

继承层次结构

System.Object
  Microsoft.VisualStudio.TextTemplating.DirectiveProcessor
    Microsoft.VisualStudio.TextTemplating.RequiresProvidesDirectiveProcessor

命名空间：  Microsoft.VisualStudio.TextTemplating
程序集：  Microsoft.VisualStudio.TextTemplating.11.0（在 Microsoft.VisualStudio.TextTemplating.11.0.dll 中）

语法

声明
Public MustInherit Class RequiresProvidesDirectiveProcessor _
    Inherits DirectiveProcessor

public abstract class RequiresProvidesDirectiveProcessor : DirectiveProcessor

public ref class RequiresProvidesDirectiveProcessor abstract : public DirectiveProcessor

[<AbstractClass>]
type RequiresProvidesDirectiveProcessor =  
    class
        inherit DirectiveProcessor
    end

public abstract class RequiresProvidesDirectiveProcessor extends DirectiveProcessor

RequiresProvidesDirectiveProcessor 类型公开以下成员。

构造函数

	名称	说明
	RequiresProvidesDirectiveProcessor	在派生类中重写时，初始化 RequiresProvidesDirectiveProcessor 类的新实例。

页首

属性

	名称	说明
	Errors	让生成，在处理指令时的错误。 （继承自 DirectiveProcessor。）
	FriendlyName	在派生类中重写时，获取指令处理器的友好名称。
	Host	获取与此指令处理器相关联的主机。

页首

方法

	名称	说明
	Equals	确定指定的对象是否等于当前对象。 （继承自 Object。）
	Finalize	允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
	FinishProcessingRun	完成一轮指令处理。 （重写 DirectiveProcessor.FinishProcessingRun()。）
	GeneratePostInitializationCode	在派生类中重写时，向已生成转换类的初始化代码中添加代码。此代码将在初始化基类之后添加。
	GeneratePreInitializationCode	在派生类中重写时，向已生成转换类的初始化代码中添加代码。此代码将在初始化基类之前添加。
	GenerateTransformCode	在派生类中重写时，向已生成转换类中添加代码。
	GetClassCodeForProcessingRun	获取要添加到所生成转换类的代码。 （重写 DirectiveProcessor.GetClassCodeForProcessingRun()。）
	GetHashCode	用作特定类型的哈希函数。 （继承自 Object。）
	GetImportsForProcessingRun	获取要导入到所生成转换类的命名空间。 （重写 DirectiveProcessor.GetImportsForProcessingRun()。）
	GetPostInitializationCodeForProcessingRun	获取要在初始化所生成转换类时初始化的代码，作为最近处理运行的结果。 （重写 DirectiveProcessor.GetPostInitializationCodeForProcessingRun()。）
	GetPreInitializationCodeForProcessingRun	获取要在初始化所生成转换类时初始化的代码，作为最近处理运行的结果。 （重写 DirectiveProcessor.GetPreInitializationCodeForProcessingRun()。）
	GetReferencesForProcessingRun	获取要传递到所生成转换类的编译器的引用。 （重写 DirectiveProcessor.GetReferencesForProcessingRun()。）
	GetTemplateClassCustomAttributes	获取将模板选件类的任何自定义属性。 （继承自 DirectiveProcessor。）
	GetType	获取当前实例的 Type。 （继承自 Object。）
	Initialize	初始化指令处理器的实例。 （重写 DirectiveProcessor.Initialize(ITextTemplatingEngineHost)。）
	InitializeProvidesDictionary	在派生类中重写时，指定各个指令的“provides”参数。
	InitializeRequiresDictionary	在派生类中重写时，指定各个指令的“requires”参数。
	IsDirectiveSupported	当重写在派生类中，确定指令处理器是否支持指定的指令。 （继承自 DirectiveProcessor。）
	MemberwiseClone	创建当前 Object 的浅表副本。 （继承自 Object。）
	PostProcessArguments	在派生类中重写时，允许派生类对其提供和需要的参数进行任意修改。
	ProcessDirective	根据文本模板文件处理单个指令。 （重写 DirectiveProcessor.ProcessDirective(String, IDictionary<String, String>)。）
	ProvideUniqueId	提供标识对指令处理器的调用的 ID。
	StartProcessingRun	启动指令处理器。 （重写 DirectiveProcessor.StartProcessingRun(CodeDomProvider, String, CompilerErrorCollection)。）
	ToString	返回表示当前对象的字符串。 （继承自 Object。）

页首

显式接口实现

	名称	说明
	IDirectiveProcessor.Errors	（继承自 DirectiveProcessor。）
	IDirectiveProcessor.RequiresProcessingRunIsHostSpecific	（继承自 DirectiveProcessor。）
	IDirectiveProcessor.SetProcessingRunIsHostSpecific	（继承自 DirectiveProcessor。）

页首

备注

若要创建自定义指令处理器，需要创建一个从 DirectiveProcessor 或 RequiresProvidesDirectiveProcessor 继承的类。

DirectiveProcessor 实现从用户捕获参数所需的接口，提供生成的转换类所需的功能。 RequiresProvidesDirectiveProcessor RequiresProvidesDirectiveProcessor 为您的指令处理器实现设计模式，即需要/提供。 RequiresProvidesDirectiveProcessor 实现从用户捕获参数所需的接口，提供生成的转换类所需的功能。

有关更多信息，请参见 创建自定义 T4 文本模板指令处理器。

转换引擎保存任何所需 RequiresProvidesDirectiveProcessor 类的单一实例。

RequiresProvidesDirectiveProcessor 实现状态机。

例如，如果文本模板具有同一指令处理器的三个指令调用，则引擎会按顺序调用以下方法：

• StartProcessingRun

• ProcessDirective

• ProcessDirective

• ProcessDirective

• FinishProcessingRun

• GetClassCodeForProcessingRun

• GetPreInitializationCodeForProcessingRun

• GetPostInitializationCodeForProcessingRun

示例

下面的示例演示如何使用 RequiresProvidesDirectiveProcessor。

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.VisualStudio.TextTemplating;
using System.Xml;
using System.IO;
using System.Globalization;

namespace Microsoft.Samples.VisualStudio.TextTemplating.DirectiveProcessors
{
public class DomDirectiveProcessor : RequiresProvidesDirectiveProcessor
{

// Name of the tag that this directive processor supports.
private const string DomDirectiveTag = "dom";

//Name of the parameter that must be provided for this directive processor to load an XML file
private const string XmlFileRequiredParameterName = "XmlFile";

// Default name of the property that this provider adds to the generated transform class.
private const string DomProvidedParameterName = "Dom";

// Set up the dictionary of items that this directive processor will provide.
protected override void InitializeProvidesDictionary(string directiveName, IDictionary<string, string> providesDictionary)
{
if (StringComparer.InvariantCultureIgnoreCase.Compare(directiveName, DomDirectiveTag) == 0)
{
// Populate the dictionary with defualt names.
providesDictionary[DomProvidedParameterName] = DomProvidedParameterName;
}
}

// Set up the dictionary of items that this directive processor requires to complete.
protected override void InitializeRequiresDictionary(string directiveName, IDictionary<string, string> requiresDictionary)
{
if (StringComparer.InvariantCultureIgnoreCase.Compare(directiveName, DomDirectiveTag) == 0)
{
// Initialize the dictionary with nulls for each required parameter.
requiresDictionary[XmlFileRequiredParameterName] = null;
}
}
}
}

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.TextTemplating 命名空间

DirectiveProcessor

其他资源

创建自定义 T4 文本模板指令处理器