RequiresProvidesDirectiveProcessor – třída

Abstraktní základní třída pro směrnice procesoru, který definuje a implementuje návrhového vzoru jen vyžaduje nebo nabízí.

Hierarchie dědičnosti

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

Obor názvů:  Microsoft.VisualStudio.TextTemplating
Sestavení:  Microsoft.VisualStudio.TextTemplating.12.0 (v Microsoft.VisualStudio.TextTemplating.12.0.dll)

Syntaxe

'Deklarace
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

Typ RequiresProvidesDirectiveProcessor zveřejňuje následující členy.

Konstruktory

	Název	Popis
	RequiresProvidesDirectiveProcessor	Při přepsání v odvozené třídě inicializuje novou instanci RequiresProvidesDirectiveProcessor třídy.

Nahoru

Vlastnosti

	Název	Popis
	Errors	Získá chyby, ke kterým došlo při zpracování direktivy. (Zděděno z DirectiveProcessor.)
	FriendlyName	Při přepsání v odvozené třídě získá popisný název směrnice procesoru.
	Host	Získá hostitele, který je přidružen k této směrnice procesoru.

Nahoru

Metody

	Název	Popis
	Equals	Určuje, zda je zadaný objekt rovna aktuální objekt. (Zděděno z Object.)
	Finalize	Umožňuje objektu k pokusu uvolnit prostředky a provádět další operace vyčištění před je zažádáno systémem uvolňování paměti. (Zděděno z Object.)
	FinishProcessingRun	Dokončení zpracování směrnice kolo. (Přepisuje DirectiveProcessor.FinishProcessingRun().)
	GeneratePostInitializationCode	Při přepsání v odvozené třídě přidá kód kódem inicializace třídy vygenerované transformace.Tento kód je přidán po inicializaci základní třídy.
	GeneratePreInitializationCode	Při přepsání v odvozené třídě přidá kód kódem inicializace třídy vygenerované transformace.Tento kód je přidán před základní třída je inicializována.
	GenerateTransformCode	Při přepsání v odvozené třídě přidá kód třídy vygenerované transformace.
	GetClassCodeForProcessingRun	Získá kód, chcete-li přidat třídy vygenerované transformace. (Přepisuje DirectiveProcessor.GetClassCodeForProcessingRun().)
	GetHashCode	Slouží jako výchozí funkce hash. (Zděděno z Object.)
	GetImportsForProcessingRun	Získá-li obory názvů, které chcete importovat do třídy vygenerované transformace. (Přepisuje DirectiveProcessor.GetImportsForProcessingRun().)
	GetPostInitializationCodeForProcessingRun	Získá kód inicializace při inicializaci třídy vygenerované transformace v důsledku poslední spuštění zpracování. (Přepisuje DirectiveProcessor.GetPostInitializationCodeForProcessingRun().)
	GetPreInitializationCodeForProcessingRun	Získá kód inicializace při inicializaci třídy vygenerované transformace v důsledku poslední spuštění zpracování. (Přepisuje DirectiveProcessor.GetPreInitializationCodeForProcessingRun().)
	GetReferencesForProcessingRun	Získá odkazy předat kompilátor třídy vygenerované transformace. (Přepisuje DirectiveProcessor.GetReferencesForProcessingRun().)
	GetTemplateClassCustomAttributes	Získáte všechny vlastní atributy do třídy šablony. (Zděděno z DirectiveProcessor.)
	GetType	Získá Type aktuální instance. (Zděděno z Object.)
	Initialize	Inicializuje novou instanci směrnice procesoru. (Přepisuje DirectiveProcessor.Initialize(ITextTemplatingEngineHost).)
	InitializeProvidesDictionary	Při přepsání v odvozené třídě Určuje poskytuje parametry pro jednotlivé směrnice.
	InitializeRequiresDictionary	Při přepsání v odvozené třídě Určuje vyžaduje parametry pro jednotlivé směrnice.
	IsDirectiveSupported	Při přepsání v odvozené třídě, určí, zda směrnice procesoru podporuje určené směrnicí. (Zděděno z DirectiveProcessor.)
	MemberwiseClone	Vytvoří mělká kopie aktuálního Object. (Zděděno z Object.)
	PostProcessArguments	Při přepsání v odvozené třídě umožňuje provádět změny parametrů, které poskytují a vyžadují odvozené třídy.
	ProcessDirective	Zpracovává jediné směrnice z textového souboru šablony. (Přepisuje DirectiveProcessor.ProcessDirective(String, IDictionary<String, String>).)
	ProvideUniqueId	Poskytuje Identifikátor, který identifikuje volání směrnice procesoru.
	StartProcessingRun	Spustí směrnice procesoru. (Přepisuje DirectiveProcessor.StartProcessingRun(CodeDomProvider, String, CompilerErrorCollection).)
	ToString	Vrátí řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Explicitní implementace rozhraní

	Název	Popis
	IDirectiveProcessor.Errors	(Zděděno z DirectiveProcessor.)
	IDirectiveProcessor.RequiresProcessingRunIsHostSpecific	(Zděděno z DirectiveProcessor.)
	IDirectiveProcessor.SetProcessingRunIsHostSpecific	(Zděděno z DirectiveProcessor.)

Nahoru

Poznámky

Chcete-li vytvořit vlastní směrnice procesoru, vytvoříte třídu, která dědí z buď DirectiveProcessor nebo RequiresProvidesDirectiveProcessor.

DirectiveProcessorimplementuje rozhraní, který je nutný k zachycení parametry uživatele a poskytuje funkce pro třídy vygenerované transformace.RequiresProvidesDirectiveProcessorRequiresProvidesDirectiveProcessorimplementuje návrhového vzoru vyžaduje poskytnutís pro směrnice procesoru.RequiresProvidesDirectiveProcessorposkytuje další funkce pro zachycení parametry uživatele a poskytuje určitou vlastnost názvy funkcí třídy vygenerované transformace.

Další informace naleznete v tématu Vytváření vlastních procesorů pro direktivy textových šablon T4.

Modul transformace platí pro všechny požadované jedináček RequiresProvidesDirectiveProcessor třídy.

RequiresProvidesDirectiveProcessorimplementuje stavový stroj.

Pokud text šablony obsahuje tři volání směrnice procesoru stejné směrnice, modul volá následující metody v pořadí:

• StartProcessingRun

• ProcessDirective

• ProcessDirective

• ProcessDirective

• FinishProcessingRun

• GetClassCodeForProcessingRun

• GetPreInitializationCodeForProcessingRun

• GetPostInitializationCodeForProcessingRun

Příklady

Následující příklad ukazuje, jak použít 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;
}
}
}
}

Bezpečný přístup z více vláken

Všechny veřejné členy static (Shared v jazyce Visual Basic) tohoto typu jsou bezpečné pro přístup z více vláken. Není zaručeno, že členy instancí jsou bezpečné pro přístup z více vláken.

Viz také

Referenční dokumentace

Microsoft.VisualStudio.TextTemplating – obor názvů

DirectiveProcessor

Další zdroje

Vytváření vlastních procesorů pro direktivy textových šablon T4