This documentation is archived and is not being maintained.

CodeSnippetCompileUnit Class

Represents a literal code fragment that can be compiled.


Namespace:  System.CodeDom
Assembly:  System (in System.dll)

public class CodeSnippetCompileUnit : CodeCompileUnit

The CodeSnippetCompileUnit type exposes the following members.

Public methodCodeSnippetCompileUnit()Initializes a new instance of the CodeSnippetCompileUnit class.
Public methodCodeSnippetCompileUnit(String)Initializes a new instance of the CodeSnippetCompileUnit class.

Public propertyAssemblyCustomAttributesGets a collection of custom attributes for the generated assembly. (Inherited from CodeCompileUnit.)
Public propertyEndDirectivesGets a CodeDirectiveCollection object containing end directives. (Inherited from CodeCompileUnit.)
Public propertyLinePragmaGets or sets the line and file information about where the code is located in a source code document.
Public propertyNamespacesGets the collection of namespaces. (Inherited from CodeCompileUnit.)
Public propertyReferencedAssembliesGets the referenced assemblies. (Inherited from CodeCompileUnit.)
Public propertyStartDirectivesGets a CodeDirectiveCollection object containing start directives. (Inherited from CodeCompileUnit.)
Public propertyUserDataGets the user-definable data for the current object. (Inherited from CodeObject.)
Public propertyValueGets or sets the literal code fragment to represent.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

CodeSnippetCompileUnit can represent a literal block of code that is included directly in the source without modification.

A CodeSnippetCompileUnit stores a section of code, exactly in its original format, as a string. The CodeDOM does not translate literal code fragments. Literal code fragments are stored and output in their original format. CodeDOM objects that contain literal code are provided so developers can encapsulate code that is already in the target language.

The Value property contains the literal code fragment as a string. The LinePragma property is optional and specifies the position of the code within a source code document.

The following code example demonstrates how to create a new instance of the CodeSnippetCompileUnit class by using a string that represents literal code.

// Creates a compile unit using a literal sring;
string literalCode;
literalCode = "using System; namespace TestLiteralCode " + 
    "{ public class TestClass { public TestClass() {} } }";
CodeSnippetCompileUnit csu = new CodeSnippetCompileUnit( literalCode );            

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.