Article
11/18/2011

DataMemberAttribute.Name Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets a data member name.

Namespace: System.Runtime.Serialization
Assembly: System.Runtime.Serialization (in System.Runtime.Serialization.dll)

Syntax

'Declaration
Public Property Name As String

public string Name { get; set; }

Property Value

Type: System.String
The name of the data member. The default name of a data contract for a given type of data member is the CLR member name of that type.

Remarks

This property is used to override the default name of the data member that is derived from the name of the member annotated with the DataMemberAttribute.

The Name property enables you to use names that are not permitted as common language runtime (CLR) identifiers. In addition, this property enables the type author to define a data member name separate from the CLR member name. This separate definition helps in versioning scenarios (changing the CLR member name without breaking the data contract) and allows a different naming convention for data contact members and CLR members.

Examples

        ' Define the data contract.
        <DataContract(Name := "Customer", Namespace := "https://www.contoso.com")> _
        Public Class User
            Private privateName As String
            <DataMember(Name := "Last", EmitDefaultValue := True, IsRequired := True, Order := 2)> _
            Public Property Name() As String
                Get
                    Return privateName
                End Get
                Set(ByVal value As String)
                    privateName = value
                End Set
            End Property

            Private privateAge As Integer
            <DataMember(Order := 1)> _
            Public Property Age() As Integer
                Get
                    Return privateAge
                End Get
                Set(ByVal value As Integer)
                    privateAge = value
                End Set
            End Property

            Public Sub New()
            End Sub

            Public Sub New(ByVal newName As String, ByVal newAge As Integer)
                    Name = newName
                    Age = newAge
            End Sub
        End Class

        // Define the data contract.
        [DataContract(Name = "Customer" , Namespace = "https://www.contoso.com" ) ]
        public class User
        {
            [DataMember(Name = "Last" , EmitDefaultValue = true , IsRequired = true , Order = 2 )]
            public string Name { get; set; }

            [DataMember(Order = 1)]
            public int Age { get; set; }

            public User() { }

            public User(string newName, int newAge)
            {
                    Name = newName;
                    Age = newAge;
            }
        }

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Partager via