CodeMemberProperty Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Package:

System.CodeDom v9.0.0-rc.2.24473.5

Source:

CodeMemberProperty.cs

Represents a declaration for a property of a type.

public ref class CodeMemberProperty : System::CodeDom::CodeTypeMember

public class CodeMemberProperty : System.CodeDom.CodeTypeMember

type CodeMemberProperty = class
    inherit CodeTypeMember

Public Class CodeMemberProperty
Inherits CodeTypeMember

Inheritance

Object

CodeObject

CodeTypeMember

CodeMemberProperty

Examples

The following example code demonstrates use of a CodeMemberProperty to define a string property with get and set accessors.

// Declares a property of type String named StringProperty.
CodeMemberProperty^ property1 = gcnew CodeMemberProperty;
property1->Name = "StringProperty";
property1->Type = gcnew CodeTypeReference( "System.String" );
property1->Attributes = MemberAttributes::Public;
property1->GetStatements->Add( gcnew CodeMethodReturnStatement( gcnew CodeFieldReferenceExpression( gcnew CodeThisReferenceExpression,"testStringField" ) ) );
property1->SetStatements->Add( gcnew CodeAssignStatement( gcnew CodeFieldReferenceExpression( gcnew CodeThisReferenceExpression,"testStringField" ),gcnew CodePropertySetValueReferenceExpression ) );

// A C# code generator produces the following source code for the preceeding example code:
//       public virtual string StringProperty
//       {
//              get
//            {
//                return this.testStringField;
//            }
//            set
//            {
//                this.testStringField = value;
//            }
//       }

// Declares a property of type String named StringProperty.
CodeMemberProperty property1 = new CodeMemberProperty();
property1.Name = "StringProperty";
property1.Type = new CodeTypeReference("System.String");
property1.Attributes = MemberAttributes.Public;
property1.GetStatements.Add( new CodeMethodReturnStatement( new CodeFieldReferenceExpression(new CodeThisReferenceExpression(), "testStringField") ) );
property1.SetStatements.Add( new CodeAssignStatement( new CodeFieldReferenceExpression(new CodeThisReferenceExpression(), "testStringField"), new CodePropertySetValueReferenceExpression()));

// A C# code generator produces the following source code for the preceeding example code:

//       public virtual string StringProperty
//       {
//              get
//            {
//                return this.testStringField;
//            }
//            set
//            {
//                this.testStringField = value;
//            }
//       }

' Declares a property of type String named StringProperty.
Dim property1 As New CodeMemberProperty()
property1.Name = "StringProperty"
property1.Type = New CodeTypeReference("System.String")
property1.Attributes = MemberAttributes.Public
property1.GetStatements.Add(New CodeMethodReturnStatement(New CodeFieldReferenceExpression(New CodeThisReferenceExpression(), "testStringField")))
property1.SetStatements.Add(New CodeAssignStatement(New CodeFieldReferenceExpression(New CodeThisReferenceExpression(), "testStringField"), New CodePropertySetValueReferenceExpression()))

' A Visual Basic code generator produces the following source code for the preceeding example code:

'     Public Overridable Property StringProperty() As String
'         Get
'             Return Me.testStringField
'         End Get
'         Set(ByVal Value As String)
'             Me.testStringField = value
'         End Set
'     End Property

Remarks

CodeMemberProperty can be used to represent the declaration for a property of a type.

The Type property specifies the data type of the property. The GetStatements property contains any get statement methods for the property. The SetStatements property contains any set statement methods for the property. The Parameters property specifies any parameters for the property, such as are required for an indexer property.

Constructors

CodeMemberProperty()

Initializes a new instance of the CodeMemberProperty class.

Properties

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)
GetStatements	Gets the collection of get statements for the property.
HasGet	Gets or sets a value indicating whether the property has a get method accessor.
HasSet	Gets or sets a value indicating whether the property has a set method accessor.
ImplementationTypes	Gets the data types of any interfaces that the property implements.
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)
Parameters	Gets the collection of declaration expressions for the property.
PrivateImplementationType	Gets or sets the data type of the interface, if any, this property, if private, implements.
SetStatements	Gets the collection of set statements for the property.
StartDirectives	Gets the start directives for the member. (Inherited from CodeTypeMember)
Type	Gets or sets the data type of the property.
UserData	Gets the user-definable data for the current object. (Inherited from CodeObject)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (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)