Edit

DataContractAttribute.Name Property

  • Reference

Definition

Namespace:
System.Runtime.Serialization
Assembly:
System.Runtime.Serialization.Primitives.dll
Assembly:
System.Runtime.Serialization.dll
Assembly:
netstandard.dll
Source:
DataContractAttribute.cs
Source:
DataContractAttribute.cs
Source:
DataContractAttribute.cs

Gets or sets the name of the data contract for the type.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };
public string Name { get; set; }
public string? Name { get; set; }
member this.Name : string with get, set
Public Property Name As String

Property Value

String

The local name of a data contract. The default is the name of the class that the attribute is applied to.

Remarks

The Name property is used to give a name to a data contract, which is the name of the type in XML schema. For more information, see Data Contract Names.

By default, the name of a data contract is the name of the type that the DataContractAttribute is applied to. However, there may be reasons to change this default name. One reason is to allow an existing type to process data that must conform to an existing data contract. For example, there exists a type named Person but the data contract, embodied in an XML schema, requires that the name be Customer. The contract can be satisfied by setting the property value to Customer.

A second reason is to allow the generation of names that are invalid as type names. For example, if a data contract demands a name that is not allowable as a type name, set the property value to that disallowed name. For instance, the string "$value" is disallowed as a type name but is allowed as a Name property value.

Applies to