Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ParameterDirectiveProcessor Class

Definition

Namespace:
Microsoft.VisualStudio.TextTemplating
Assembly:
Microsoft.VisualStudio.TextTemplating.14.0.dll
Assembly:
Microsoft.VisualStudio.TextTemplating.15.0.dll
Assembly:
Microsoft.VisualStudio.TextTemplating.dll
Package:
Microsoft.VisualStudio.TextTemplating v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Directive processor to route simple serializable parameters from callers or the host to the template.

public ref class ParameterDirectiveProcessor sealed : Microsoft::VisualStudio::TextTemplating::DirectiveProcessor, Microsoft::VisualStudio::TextTemplating::IRecognizeHostSpecific
public ref class ParameterDirectiveProcessor sealed : Microsoft::VisualStudio::TextTemplating::DirectiveProcessor, Microsoft::VisualStudio::TextTemplating::IRecognizeHostSpecific
class ParameterDirectiveProcessor sealed : Microsoft::VisualStudio::TextTemplating::DirectiveProcessor, Microsoft::VisualStudio::TextTemplating::IRecognizeHostSpecific
public sealed class ParameterDirectiveProcessor : Microsoft.VisualStudio.TextTemplating.DirectiveProcessor, Microsoft.VisualStudio.TextTemplating.IRecognizeHostSpecific
type ParameterDirectiveProcessor = class
 inherit DirectiveProcessor
 interface IRecognizeHostSpecific
Public NotInheritable Class ParameterDirectiveProcessor
Inherits DirectiveProcessor
Implements IRecognizeHostSpecific
Inheritance
ParameterDirectiveProcessor
Implements

Constructors

Name Description
ParameterDirectiveProcessor()

Properties

Name Description
Errors

Error collection for DirectiveProcessor to add Errors/Warnings to.

(Inherited from DirectiveProcessor)
RequiresProcessingRunIsHostSpecific

This processor does not require a host-specific template.

Methods

Name Description
FinishProcessingRun()

Nothing to do as we complete our run.

GetClassCodeForProcessingRun()

Gets generated class code.

GetImportsForProcessingRun()

Get any namespaces to import as a consequence of the most recent run.

GetPostInitializationCodeForProcessingRun()

Get the code to contribute to the body of the initialize method of the generated template processing class as a consequence of the most recent run. This code will run after the base class' Initialize method

GetPreInitializationCodeForProcessingRun()

Get the code to contribute to the body of the initialize method of the generated template processing class as a consequence of the most recent run. This code will run before the base class' Initialize method

GetReferencesForProcessingRun()

Get any references to pass to the compiler as a consequence of the most recent run.

GetTemplateClassCustomAttributes()

Get any custom attributes to place on the template class.

(Inherited from DirectiveProcessor)
Initialize(ITextTemplatingEngineHost)

Initialize the processor instance

(Inherited from DirectiveProcessor)
IsDirectiveSupported(String)

Denote which properties are supported.

ProcessDirective(String, IDictionary<String,String>)

Process a directive from a template file

StartProcessingRun(CodeDomProvider, String, CompilerErrorCollection)

Starts processing run.

Explicit Interface Implementations

Name Description
IDirectiveProcessor.Errors (Inherited from DirectiveProcessor)
IDirectiveProcessor.RequiresProcessingRunIsHostSpecific (Inherited from DirectiveProcessor)
IDirectiveProcessor.SetProcessingRunIsHostSpecific(Boolean) (Inherited from DirectiveProcessor)
IRecognizeHostSpecific.SetProcessingRunIsHostSpecific(Boolean)

Accept the host-specific value of the current processing run from the engine

Applies to