System.CodeDom.CodeSnippetTypeMember Class

Summary

Represents a member of a class using a literal code fragment.

C# Syntax:

[Serializable] public class CodeSnippetTypeMember : CodeTypeMember

CodeSnippetTypeMember can represent a member of a class using a literal code fragment that is included directly in the source without modification. This code can be included in the class declaration.

A CodeSnippetTypeMember 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.

System.CodeDom Namespace

System.CodeDom.CodeSnippetTypeMember Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the CodeSnippetTypeMember class.
ctor #2	Overloaded: .ctor(string text) Initializes a new instance of the CodeSnippetTypeMember class using the specified text.

Public Properties

Attributes (inherited from System.CodeDom.CodeTypeMember)	Read-write See base class member description: System.CodeDom.CodeTypeMember.Attributes Gets or sets the attributes of the member.
Comments (inherited from System.CodeDom.CodeTypeMember)	Read-only See base class member description: System.CodeDom.CodeTypeMember.Comments Gets the comment collection for the type member.
CustomAttributes (inherited from System.CodeDom.CodeTypeMember)	Read-write See base class member description: System.CodeDom.CodeTypeMember.CustomAttributes Gets or sets the custom attributes of the member.
LinePragma (inherited from System.CodeDom.CodeTypeMember)	Read-write See base class member description: System.CodeDom.CodeTypeMember.LinePragma Gets or sets the line the statement occurs on.
Name (inherited from System.CodeDom.CodeTypeMember)	Read-write See base class member description: System.CodeDom.CodeTypeMember.Name Gets or sets the name of the member.
Text	Read-write Gets or sets the literal code fragment for the class member.
UserData (inherited from System.CodeDom.CodeObject)	Read-only See base class member description: System.CodeDom.CodeObject.UserData Gets or sets the user-definable data for the current object.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.CodeDom.CodeObject
• System.CodeDom.CodeTypeMember
• System.CodeDom.CodeSnippetTypeMember

System.CodeDom.CodeSnippetTypeMember Member Details

Summary

Initializes a new instance of the CodeSnippetTypeMember class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public CodeSnippetTypeMember();

Return to top

Summary

Initializes a new instance of the CodeSnippetTypeMember class using the specified text.

C# Syntax:

public CodeSnippetTypeMember(    string text );

text

The literal code fragment for the class member.

Return to top

Inherited
See base class member description: System.CodeDom.CodeTypeMember.Attributes

Summary

Gets or sets the attributes of the member.

C# Syntax:

public MemberAttributes Attributes {get; set;}

This property is used to specify attributes of the type member. Some types of attributes are Access (Public/Private) and Scope (Final/Override).

Return to top

Inherited
See base class member description: System.CodeDom.CodeTypeMember.Comments

Summary

Gets the comment collection for the type member.

C# Syntax:

public CodeCommentStatementCollection Comments {get;}

Any comments in this collection will be written to the generated source file just before the declaration of the member.

Return to top

Inherited
See base class member description: System.CodeDom.CodeTypeMember.CustomAttributes

Summary

Gets or sets the custom attributes of the member.

C# Syntax:

public CodeAttributeDeclarationCollection CustomAttributes {get; set;}

This property can be used to add metadata attributes to the declaration of the member. This property is null by default and should be checked before referencing.

Return to top

Inherited
See base class member description: System.CodeDom.CodeTypeMember.LinePragma

Summary

Gets or sets the line the statement occurs on.

C# Syntax:

public CodeLinePragma LinePragma {get; set;}

This property indicates the location of the type member declaration. This property can be used for purposes of error reporting and debugging. This can be useful when code is generated based on a template file. This value is null by default and should be checked before referencing.

Return to top

Inherited
See base class member description: System.CodeDom.CodeTypeMember.Name

Summary

Gets or sets the name of the member.

C# Syntax:

public string Name {get; set;}

Return to top

Summary

Gets or sets the literal code fragment for the class member.

C# Syntax:

public string Text {get; set;}

Return to top

Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary

Gets or sets the user-definable data for the current object.

C# Syntax:

public IDictionary UserData {get;}

Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~CodeSnippetTypeMember();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page