 | StringEnumConverter Class |
Converts an Enum to and from its name string value.
Inheritance HierarchyNamespace: Newtonsoft.Json.Converters
Assembly: Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db
SyntaxC#
public class StringEnumConverter : JsonConverter
The StringEnumConverter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StringEnumConverter |
Initializes a new instance of the StringEnumConverter class.
|
| StringEnumConverter(Boolean) | Obsolete.
Initializes a new instance of the StringEnumConverter class.
|
| StringEnumConverter(Type) |
Initializes a new instance of the StringEnumConverter class.
|
| StringEnumConverter(Type, Object) |
Initializes a new instance of the StringEnumConverter class.
|
| StringEnumConverter(NamingStrategy, Boolean) |
Initializes a new instance of the StringEnumConverter class.
|
| StringEnumConverter(Type, Object, Boolean) |
Initializes a new instance of the StringEnumConverter class.
|
Properties| Name | Description | |
|---|---|---|
 | AllowIntegerValues |
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
The default value is true.
|
| CamelCaseText | Obsolete.
Gets or sets a value indicating whether the written enum text should be camel case.
The default value is false.
|
| CanRead |
Gets a value indicating whether this JsonConverter can read JSON.
(Inherited from JsonConverter.) |
| CanWrite |
Gets a value indicating whether this JsonConverter can write JSON.
(Inherited from JsonConverter.) |
| NamingStrategy |
Gets or sets the naming strategy used to resolve how enum text is written.
|
Methods| Name | Description | |
|---|---|---|
| CanConvert |
Determines whether this instance can convert the specified object type.
(Overrides JsonConverterCanConvert(Type).) |
| Equals | 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.) |
| ReadJson |
Reads the JSON representation of the object.
(Overrides JsonConverterReadJson(JsonReader, Type, Object, JsonSerializer).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteJson |
Writes the JSON representation of the object.
(Overrides JsonConverterWriteJson(JsonWriter, Object, JsonSerializer).) |
See Also