System.CodeDom.CodeMemberMethod Class

Summary

Represents a declaration for a method of a class.

C# Syntax:

[Serializable] public class CodeMemberMethod : CodeTypeMember

CodeMemberMethod can be used to represent the declaration of a method of a class.

System.CodeDom Namespace

System.CodeDom.CodeMemberMethod Member List:

Public Constructors

ctor #1

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

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.
ImplementationTypes	Read-only Gets the data types of the interfaces implemented by this method, unless it is a private method implementation, which is indicated by the CodeMemberMethod.PrivateImplementationType property.
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.
Parameters	Read-only Gets the parameter declarations for the method.
PrivateImplementationType	Read-write Gets or sets the data type of the interface this method, if private, implements a method of, if any.
ReturnType	Read-write Gets or sets the data type of the return value of the method.
ReturnTypeCustomAttributes	Read-only Gets the custom attributes of the return type of the method.
Statements	Read-only Gets the statements within the method.
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.

Public Events

PopulateImplementationTypes	An event that will be raised the first time the CodeMemberMethod.ImplementationTypes collection is accessed.
PopulateParameters	An event that will be raised the first time the CodeMemberMethod.Parameters collection is accessed.
PopulateStatements	An event that will be raised the first time the CodeMemberMethod.Statements collection is accessed.

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.CodeMemberMethod
  • System.CodeDom.CodeConstructor
  • System.CodeDom.CodeEntryPointMethod
  • System.CodeDom.CodeTypeConstructor

System.CodeDom.CodeMemberMethod Member Details

Summary:

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

C# Syntax:

public CodeMemberMethod();

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

Summary

Gets the data types of the interfaces implemented by this method, unless it is a private method implementation, which is indicated by the CodeMemberMethod.PrivateImplementationType property.

C# Syntax:

public CodeTypeReferenceCollection ImplementationTypes {get;}

The types referenced by this collection must consist of interfaces.

If this CodeMemberMethod represents a declaration for a public method, and this method implements a method on an interface, the interface or interfaces this method implements a method of should be referenced in this collection.

The method should still have the same name as the method of the interface that is implemented by this method. For some languages, like C#, this has no effect on the syntax. For others, like Visual Basic, there is a special syntax for implementing interfaces. If the method is privately implementing a single interface, the CodeMemberMethod.PrivateImplementationType property should be used instead.

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 the parameter declarations for the method.

C# Syntax:

public CodeParameterDeclarationExpressionCollection Parameters {get;}

Return to top

Summary

Gets or sets the data type of the interface this method, if private, implements a method of, if any.

C# Syntax:

public CodeTypeReference PrivateImplementationType {get; set;}

If this CodeMemberMethod represents the declaration of a private method and the method implements a method of an interface, this property should indicate the interface type that the method is implementing a method of.

The type referenced by this property must be an interface.

Return to top

Summary

Gets or sets the data type of the return value of the method.

C# Syntax:

public CodeTypeReference ReturnType {get; set;}

Return to top

Summary

Gets the custom attributes of the return type of the method.

C# Syntax:

public CodeAttributeDeclarationCollection ReturnTypeCustomAttributes {get;}

Return to top

Summary

Gets the statements within the method.

C# Syntax:

public CodeStatementCollection Statements {get;}

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:

~CodeMemberMethod();

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

Summary

An event that will be raised the first time the CodeMemberMethod.ImplementationTypes collection is accessed.

C# Syntax:

public event EventHandler PopulateImplementationTypes;

Return to top

Summary

An event that will be raised the first time the CodeMemberMethod.Parameters collection is accessed.

C# Syntax:

public event EventHandler PopulateParameters;

Return to top

Summary

An event that will be raised the first time the CodeMemberMethod.Statements collection is accessed.

C# Syntax:

public event EventHandler PopulateStatements;

Return to top

Top of page