CodeMemberField Class

.NET Framework (current version)

Other Versions

Represents a declaration for a field of a type.

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

Inheritance Hierarchy

System::Object
System.CodeDom::CodeObject
System.CodeDom::CodeTypeMember
System.CodeDom::CodeMemberField

Syntax

C++

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
public ref class CodeMemberField : CodeTypeMember

Constructors

	Name	Description
	CodeMemberField()	Initializes a new instance of the CodeMemberField class.
	CodeMemberField(CodeTypeReference^, String^)	Initializes a new instance of the CodeMemberField class using the specified field type and field name.
	CodeMemberField(String^, String^)	Initializes a new instance of the CodeMemberField class using the specified field type and field name.
	CodeMemberField(Type^, String^)	Initializes a new instance of the CodeMemberField class using the specified field type and field name.

Properties

	Name	Description
	Attributes	Gets or sets the attributes of the member.(Inherited from CodeTypeMember.)
	Comments	Gets the collection of comments for the type member.(Inherited from CodeTypeMember.)
	CustomAttributes	Gets or sets the custom attributes of the member.(Inherited from CodeTypeMember.)
	EndDirectives	Gets the end directives for the member.(Inherited from CodeTypeMember.)
	InitExpression	Gets or sets the initialization expression for the field.
	LinePragma	Gets or sets the line on which the type member statement occurs.(Inherited from CodeTypeMember.)
	Name	Gets or sets the name of the member.(Inherited from CodeTypeMember.)
	StartDirectives	Gets the start directives for the member.(Inherited from CodeTypeMember.)
	Type	Gets or sets the type of the field.
	UserData	Gets the user-definable data for the current object.(Inherited from CodeObject.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

CodeMemberField can be used to represent the declaration for a field of a type.

Examples

The following example demonstrates use of a CodeMemberField to declare a field of type string named testStringField.

C++

// Declares a type to contain a field and a constructor method.
CodeTypeDeclaration^ type1 = gcnew CodeTypeDeclaration( "FieldTest" );

// Declares a field of type String named testStringField.
CodeMemberField^ field1 = gcnew CodeMemberField( "System.String","TestStringField" );
type1->Members->Add( field1 );

// Declares an empty type constructor.
CodeConstructor^ constructor1 = gcnew CodeConstructor;
constructor1->Attributes = MemberAttributes::Public;
type1->Members->Add( constructor1 );

// A C# code generator produces the following source code for the preceeding example code:
//    public class FieldTest 
//    {
//      private string testStringField;
//        
//        public FieldTest() 
//        {
//        }                            
//    }

C++

// This example demonstrates declaring a public constant type member field.

// When declaring a public constant type member field, you must set a particular
// access and scope mask to the member attributes of the field in order for the
// code generator to properly generate the field as a constant field.

// Declares an integer field using a CodeMemberField
CodeMemberField^ constPublicField = gcnew CodeMemberField( int::typeid,"testConstPublicField" );

// Resets the access and scope mask bit flags of the member attributes of the field
// before setting the member attributes of the field to public and constant.
constPublicField->Attributes = (MemberAttributes)((constPublicField->Attributes &  ~MemberAttributes::AccessMask &  ~MemberAttributes::ScopeMask) | MemberAttributes::Public | MemberAttributes::Const);

Version Information

.NET Framework
Available since 1.1

Thread Safety

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