VisualBasicCompilation Class

The Compilation object is an immutable representation of a single invocation of the compiler. Although immutable, a Compilation is also on-demand, in that a compilation can be created quickly, but will that compiler parts or all of the code in order to respond to method or properties. Also, a compilation can produce a new compilation with a small change from the current compilation. This is, in many cases, more efficient than creating a new compilation from scratch, as the new compilation can share information from the old compilation.

Inheritance Hierarchy

SystemObject
Microsoft.CodeAnalysisCompilation
Microsoft.CodeAnalysis.VisualBasicVisualBasicCompilation

Namespace: Microsoft.CodeAnalysis.VisualBasic
Assembly: Microsoft.CodeAnalysis.VisualBasic (in Microsoft.CodeAnalysis.VisualBasic.dll) Version: 2.3.0-dev-56735-00. Commit Hash: <developer build>

Syntax

Copy

public sealed class VisualBasicCompilation : Compilation

Public NotInheritable Class VisualBasicCompilation
	Inherits Compilation

The VisualBasicCompilation type exposes the following members.

Properties

	Name	Description
	Assembly	The IAssemblySymbol that represents the assembly being created. (Inherited from Compilation.)
	AssemblyName	Simple assembly name, or null if not specified. (Inherited from Compilation.)
	DirectiveReferences	(Overrides CompilationDirectiveReferences.)
	DynamicType	The TypeSymbol for the type 'dynamic' in this Compilation. (Inherited from Compilation.)
	ExternalReferences	Metadata references passed to the compilation constructor. (Inherited from Compilation.)
	GlobalNamespace	The root namespace that contains all namespaces and types defined in source code or in referenced metadata, merged into a single namespace hierarchy. (Inherited from Compilation.)
	IsCaseSensitive	(Overrides CompilationIsCaseSensitive.)
	Language	(Overrides CompilationLanguage.)
	LanguageVersion	The language version that was used to parse the syntax trees of this compilation.
	ObjectType	The INamedTypeSymbol for the .NET System.Object type, which could have a TypeKind of Error if there was no COR Library in this Compilation. (Inherited from Compilation.)
	Options
	ReferencedAssemblyNames	(Overrides CompilationReferencedAssemblyNames.)
	References	All metadata references -- references passed to the compilation constructor as well as references specified via #r directives. (Inherited from Compilation.)
	ScriptClass	A symbol representing the implicit Script class. This is null if the class is not defined in the compilation. (Inherited from Compilation.)
	ScriptCompilationInfo	(Inherited from Compilation.)
	SourceModule	Gets the IModuleSymbol for the module being created by compiling all of the source code. (Inherited from Compilation.)
	SyntaxTrees	Get a read-only list of the syntax trees that this compilation was created with.

Top

Methods

	Name	Description
	AddReferences(IEnumerableT)	(Inherited from Compilation.)
	AddReferences(IEnumerableT)
	AddReferences(MetadataReference)
	AddSyntaxTrees(IEnumerableT)	(Inherited from Compilation.)
	AddSyntaxTrees(IEnumerableT)
	AddSyntaxTrees(SyntaxTree)
	ClassifyConversion	Determine what kind of conversion, if any, there is between the types "source" and "destination".
	Clone	Create a duplicate of this compilation with different symbol instances
	ContainsSymbolsWithName(FuncT, TResult, Boolean, String)	(Inherited from Compilation.)
	ContainsSymbolsWithName(FuncT, TResult, Boolean, String)
	ContainsSyntaxTree	Is the passed in syntax tree in this compilation?
	Create
	CreateAnonymousTypeSymbol	Returns a new anonymous type symbol with the given member types member names. Anonymous type members will be readonly by default. Writable properties are supported in VB and can be created by passing in Copy false in the appropriate locations in memberIsReadOnly. Source locations can also be provided through memberLocations (Inherited from Compilation.)
	CreateArrayTypeSymbol	Returns a new ArrayTypeSymbol representing an array type tied to the base types of the COR Library in this Compilation. (Inherited from Compilation.)
	CreateDefaultWin32Resources	Create a stream filled with default win32 resources. (Inherited from Compilation.)
	CreateErrorNamespaceSymbol	Returns a new INamespaceSymbol representing an error (missing) namespace with the given name. (Inherited from Compilation.)
	CreateErrorTypeSymbol	Returns a new INamedTypeSymbol representing an error type with the given name and arity in the given optional container. (Inherited from Compilation.)
	CreatePointerTypeSymbol	Returns a new PointerTypeSymbol representing a pointer type tied to a type in this Compilation. (Inherited from Compilation.)
	CreateTupleTypeSymbol(INamedTypeSymbol, ImmutableArrayString, ImmutableArrayLocation)	Returns a new INamedTypeSymbol with the given underlying type and (optional) element names. (Inherited from Compilation.)
	CreateTupleTypeSymbol(ImmutableArrayITypeSymbol, ImmutableArrayString, ImmutableArrayLocation)	Returns a new INamedTypeSymbol with the given element types and (optional) element names. (Inherited from Compilation.)
	Emit(Stream, Stream, Stream, Stream, IEnumerableT, Void, ResourceDescription)	(Inherited from Compilation.)
	Emit(Stream, Stream, Stream, Stream, IEnumerableT, Void, ResourceDescription, EmitOptions)	(Inherited from Compilation.)
	Emit(Stream, Stream, Stream, Stream, IEnumerableT, Void, ResourceDescription, EmitOptions, IMethodSymbol, Stream)	(Inherited from Compilation.)
	EmitDifference(EmitBaseline, IEnumerableT, Void, SemanticEdit, Stream, Stream, Stream)	(Inherited from Compilation.)
	EmitDifference(EmitBaseline, IEnumerableT, Void, SemanticEdit, FuncT, TResult, Boolean, ISymbol, Boolean)	(Inherited from Compilation.)
	GetAssemblyOrModuleSymbol	Gets the IAssemblySymbol or IModuleSymbol for a metadata reference used to create this compilation. (Inherited from Compilation.)
	GetCompilationNamespace	Gets the corresponding compilation namespace for the specified module or assembly namespace. (Inherited from Compilation.)
	GetDeclarationDiagnostics(CancellationToken)	Gets the diagnostics produced during symbol declaration. (Inherited from Compilation.)
	GetDeclarationDiagnostics(CancellationToken)	Get declarations diagnostics for the entire compilation. This includes diagnostics from declarations, BUT NOT the bodies of methods or initializers. The set of declaration diagnostics is cached, so calling this method a second time should be fast.
	GetDiagnostics(CancellationToken)	Gets all the diagnostics for the compilation, including syntax, declaration, and binding. Does not include any diagnostics that might be produced during emit, see EmitResult. (Inherited from Compilation.)
	GetDiagnostics(CancellationToken)	Get all diagnostics for the entire compilation. This includes diagnostics from parsing, declarations, and the bodies of methods. Getting all the diagnostics is potentially a length operations, as it requires parsing and compiling all the code. The set of diagnostics is not caches, so each call to this method will recompile all methods.
	GetEntryPoint	Returns the Main method that will serves as the entry point of the assembly, if it is executable (and not a script). (Inherited from Compilation.)
	GetMetadataReference	Gets the MetadataReference that corresponds to the assembly symbol. (Inherited from Compilation.)
	GetMethodBodyDiagnostics(CancellationToken)	Gets the diagnostics produced during the analysis of method bodies and field initializers. (Inherited from Compilation.)
	GetMethodBodyDiagnostics(CancellationToken)	Get method body diagnostics for the entire compilation. This includes diagnostics only from the bodies of methods and initializers. These diagnostics are NOT cached, so calling this method a second time repeats significant work.
	GetParseDiagnostics(CancellationToken)	Gets the diagnostics produced during the parsing stage. (Inherited from Compilation.)
	GetParseDiagnostics(CancellationToken)	Get parse diagnostics for the entire compilation. This includes diagnostics from parsing BUT NOT from declarations and the bodies of methods or initializers. The set of parse diagnostics is cached, so calling this method a second time should be fast.
	GetSemanticModel	Get a fresh SemanticModel. Note that each invocation gets a fresh SemanticModel, each of which has a cache. Therefore, one effectively clears the cache by discarding the SemanticModel.
	GetSpecialType	Get the symbol for the predefined type from the Cor Library referenced by this compilation. (Inherited from Compilation.)
	GetSymbolsWithName(Void, ISymbol, FuncT, TResult)	(Inherited from Compilation.)
	GetSymbolsWithName(Void, ISymbol, FuncT, TResult)
	GetTypeByMetadataName	Gets the type within the compilation's assembly and all referenced assemblies (other than those that can only be referenced via an extern alias) using its canonical CLR metadata name. (Inherited from Compilation.)
	GetUnreferencedAssemblyIdentities	Given a Diagnostic reporting unreferenced AssemblyIdentitys, returns the actual AssemblyIdentity instances that were not referenced. (Inherited from Compilation.)
	RemoveAllReferences
	RemoveAllSyntaxTrees
	RemoveReferences(IEnumerableT)	(Inherited from Compilation.)
	RemoveReferences(IEnumerableT)
	RemoveReferences(MetadataReference)
	RemoveSyntaxTrees(IEnumerableT)	(Inherited from Compilation.)
	RemoveSyntaxTrees(IEnumerableT)
	RemoveSyntaxTrees(SyntaxTree)
	ReplaceReference
	ReplaceSyntaxTree
	ToMetadataReference(ImmutableArrayString, Boolean)	Creates a metadata reference for this compilation. (Inherited from Compilation.)
	ToMetadataReference(ImmutableArrayString, Boolean)
	WithAssemblyName	Creates a new compilation with the specified name.
	WithOptions(CompilationOptions)	Creates a new compilation with the specified compilation options. (Inherited from Compilation.)
	WithOptions(VisualBasicCompilationOptions)
	WithReferences(IEnumerableT)	(Inherited from Compilation.)
	WithReferences(IEnumerableT)
	WithReferences(MetadataReference)
	WithScriptCompilationInfo	(Inherited from Compilation.)

Top

Extension Methods

	Name	Description
	AliasImports	Gets the compilation AliasImports property. (Defined by VisualBasicExtensions.)
	ClassifyConversion(ITypeSymbol, ITypeSymbol)	Overloaded. Determines what kind of conversion there is between the specified types. (Defined by VisualBasicExtensions.)
	ClassifyConversion(ITypeSymbol, ITypeSymbol)	Overloaded. (Defined by CSharpExtensions.)
	Emit	(Defined by FileSystemExtensions.)
	GetSpecialType	Gets the special type symbol in current compilation. (Defined by VisualBasicExtensions.)
	MemberImports	Gets the compilation MemberImports property. (Defined by VisualBasicExtensions.)
	RootNamespace	Gets the compilation RootNamespace property. (Defined by VisualBasicExtensions.)
	WithAnalyzers(ImmutableArrayDiagnosticAnalyzer, CompilationWithAnalyzersOptions)	Overloaded. Returns a new compilation with attached diagnostic analyzers. (Defined by DiagnosticAnalyzerExtensions.)
	WithAnalyzers(ImmutableArrayDiagnosticAnalyzer, AnalyzerOptions, CancellationToken)	Overloaded. Returns a new compilation with attached diagnostic analyzers. (Defined by DiagnosticAnalyzerExtensions.)

Top

Reference

Microsoft.CodeAnalysis.VisualBasic Namespace