Json.NET

https://www.newtonsoft.com/json/help
Admin
Json.NET is a high-performance JSON serialization framework for .NET that provides flexible...
Tokens:525,108
Snippets:5,028
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### DynamicContractResolver Example

Source: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Serialization_IContractResolver.htm

Example of a custom contract resolver that filters properties based on a starting character, along with usage examples.

```APIDOC
## DynamicContractResolver Class

### Description
A custom contract resolver that only serializes properties starting with a specified character.

### Syntax
```csharp
public class DynamicContractResolver : DefaultContractResolver
{
    private readonly char _startingWithChar;

    public DynamicContractResolver(char startingWithChar)
    {
        _startingWithChar = startingWithChar;
    }

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> properties = base.CreateProperties(type, memberSerialization);

        // only serializer properties that start with the specified character
        properties =
            properties.Where(p => p.PropertyName.StartsWith(_startingWithChar.ToString())).ToList();

        return properties;
    }
}
```

### Example Usage
```csharp
Book book = new Book
{
    BookName = "The Gathering Storm",
    BookPrice = 16.19m,
    AuthorName = "Brandon Sanderson",
    AuthorAge = 34,
    AuthorCountry = "United States of America"
};

string startingWithA = JsonConvert.SerializeObject(book, Formatting.Indented,
    new JsonSerializerSettings { ContractResolver = new DynamicContractResolver('A') });

// {
//   "AuthorName": "Brandon Sanderson",
//   "AuthorAge": 34,
//   "AuthorCountry": "United States of America"
// }

string startingWithB = JsonConvert.SerializeObject(book, Formatting.Indented,
    new JsonSerializerSettings { ContractResolver = new DynamicContractResolver('B') });

// {
//   "BookName": "The Gathering Storm",
//   "BookPrice": 16.19
// }
```
```

--------------------------------

### IContractResolver serialization example

Source: https://www.newtonsoft.com/json/help/html/ReducingSerializedJSONSize.htm

Shows how to use DynamicContractResolver to serialize only properties starting with 'A' or 'B'. The output for 'A' includes author properties, while 'B' includes book properties, demonstrating runtime property filtering.

```csharp
Book book = new Book
{
    BookName = "The Gathering Storm",
    BookPrice = 16.19m,
    AuthorName = "Brandon Sanderson",
    AuthorAge = 34,
    AuthorCountry = "United States of America"
};

string startingWithA = JsonConvert.SerializeObject(book, Formatting.Indented,
    new JsonSerializerSettings { ContractResolver = new DynamicContractResolver('A') });

// {
//   "AuthorName": "Brandon Sanderson",
//   "AuthorAge": 34,
//   "AuthorCountry": "United States of America"
// }

string startingWithB = JsonConvert.SerializeObject(book, Formatting.Indented,
    new JsonSerializerSettings { ContractResolver = new DynamicContractResolver('B') });

// {
//   "BookName": "The Gathering Storm",
//   "BookPrice": 16.19
// }
```

--------------------------------

### Query JSON with regex JSON Path using SelectTokens

Source: https://www.newtonsoft.com/json/help/html/RegexQuery.htm

Loads a JSON array of packages and uses SelectTokens with a regex JSON Path to find packages whose PackageId starts with 'Newtonsoft.' The example outputs 'Newtonsoft.Json'.

```csharp
JArray packages = JArray.Parse(@"[
  {
    'PackageId': 'Newtonsoft.Json',
    'Version': '11.0.1',
    'ReleaseDate': '2018-02-17T00:00:00'
  },
  {
    'PackageId': 'NUnit',
    'Version': '3.9.0',
    'ReleaseDate': '2017-11-10T00:00:00'
  }
]");

// Find Newtonsoft packages
List<JToken> newtonsoftPackages = packages.SelectTokens(@"$.[?(@.PackageId =~ /^Newtonsoft\.(.*)$/)]").ToList();

foreach (JToken item in newtonsoftPackages)
{
    Console.WriteLine((string) item["PackageId"]);
}
// Newtonsoft.Json
```

--------------------------------

### DateTime JsonConverters Example

Source: https://www.newtonsoft.com/json/help/html/DatesInJSON.htm

Shows how to serialize a DateTime with Json.NET using the default ISO 8601 format, the Microsoft date format, and the JavaScriptDateTimeConverter. The example defines a LogEntry class and a test method that serializes an entry with each approach, demonstrating the resulting JSON strings.

```csharp
public class LogEntry
{
    public string Details { get; set; }
    public DateTime LogDate { get; set; }
}

[Test]
public void WriteJsonDates()
{
    LogEntry entry = new LogEntry
    {
        LogDate = new DateTime(2009, 2, 15, 0, 0, 0, DateTimeKind.Utc),
        Details = "Application started."
    };

    // default as of Json.NET 4.5
    string isoJson = JsonConvert.SerializeObject(entry);
    // {"Details":"Application started.","LogDate":"2009-02-15T00:00:00Z"}

    JsonSerializerSettings microsoftDateFormatSettings = new JsonSerializerSettings
    {
        DateFormatHandling = DateFormatHandling.MicrosoftDateFormat
    };
    string microsoftJson = JsonConvert.SerializeObject(entry, microsoftDateFormatSettings);
    // {"Details":"Application started.","LogDate":"\/Date(1234656000000)\/"}

    string javascriptJson = JsonConvert.SerializeObject(entry, new JavaScriptDateTimeConverter());
    // {"Details":"Application started.","LogDate":new Date(1234656000000)}
}
```

--------------------------------

### CustomCreationConverter usage example with JSON and deserialization

Source: https://www.newtonsoft.com/json/help/html/CustomCreationConverter.htm

Shows a JSON array of person objects and C# code that deserializes it into a List<IPerson> using the PersonConverter. The example then accesses the first person, prints its type and FirstName, and casts to Employee to access JobTitle.

```json
//[
//  {
//    "FirstName": "Maurice",
//    "LastName": "Moss",
//    "BirthDate": "1981-03-08T00:00Z",
//    "Department": "IT",
//    "JobTitle": "Support"
//  },
//  {
//    "FirstName": "Jen",
//    "LastName": "Barber",
//    "BirthDate": "1985-12-10T00:00Z",
//    "Department": "IT",
//    "JobTitle": "Manager"
//  }
//]
```

```csharp
List<IPerson> people = JsonConvert.DeserializeObject<List<IPerson>>(json, new PersonConverter());

IPerson person = people[0];

Console.WriteLine(person.GetType());
// Newtonsoft.Json.Tests.Employee

Console.WriteLine(person.FirstName);
// Maurice

Employee employee = (Employee)person;

Console.WriteLine(employee.JobTitle);
// Support
```

--------------------------------

### Define Directory and File classes

Source: https://www.newtonsoft.com/json/help/html/PreserveReferencesHandlingObject.htm

Defines the Directory and File classes used in the examples. Directory has a Name, Parent, and Files collection; File has Name and Parent.

```csharp
public class Directory
{
    public string Name { get; set; }
    public Directory Parent { get; set; }
    public IList<File> Files { get; set; }
}

public class File
{
    public string Name { get; set; }
    public Directory Parent { get; set; }
}
```

--------------------------------

### OnAddingNew

Source: https://www.newtonsoft.com/json/help/html/Methods_T_Newtonsoft_Json_Linq_JContainer.htm

Raises the AddingNew event.

```APIDOC
## OnAddingNew

### Description
Raises the AddingNew event.

### Method
OnAddingNew

### Signature
`protected virtual void OnAddingNew(AddingNewEventArgs e)`

### Parameters
- **e** (AddingNewEventArgs) - The event arguments.

### Remarks
This method is specific to JContainer and is used to raise the AddingNew event.
```

--------------------------------

### Create DynamicContractResolver filtering properties by starting character

Source: https://www.newtonsoft.com/json/help/html/CustomContractResolver.htm

Defines a custom IContractResolver that filters properties to only those starting with a specified character. The Person class is used in the usage example.

```csharp
public class DynamicContractResolver : DefaultContractResolver
{
    private readonly char _startingWithChar;

    public DynamicContractResolver(char startingWithChar)
    {
        _startingWithChar = startingWithChar;
    }

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> properties = base.CreateProperties(type, memberSerialization);

        // only serializer properties that start with the specified character
        properties =
            properties.Where(p => p.PropertyName.StartsWith(_startingWithChar.ToString())).ToList();

        return properties;
    }
}

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    public string FullName
    {
        get { return FirstName + " " + LastName; }
    }
}
```

--------------------------------

### WriteValueAsync(Nullable<Guid>, CancellationToken)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonTextWriter_WriteValueAsync_19.htm

Asynchronously writes a Nullable<Guid> value. The method returns a Task representing the asynchronous operation. Derived classes must override this method to get asynchronous behavior; otherwise it executes synchronously.

```APIDOC
## WriteValueAsync(Nullable<Guid>, CancellationToken)

### Description
Asynchronously writes a Nullable<Guid> value.

### Method
WriteValueAsync

### Signature
public override Task WriteValueAsync(
    Nullable<Guid> value,
    CancellationToken cancellationToken = null
)

### Parameters
- **value** (System.Nullable<Guid>) - Required - The Nullable<Guid> value to write.
- **cancellationToken** (System.Threading.CancellationToken) - Optional - The token to monitor for cancellation requests. The default value is None.

### Return Value
Type: Task
A Task that represents the asynchronous operation.

### Remarks
Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.

### Reference
JsonTextWriter Class
WriteValueAsync Overload
Newtonsoft.Json Namespace
```

--------------------------------

### SelectToken With LINQ Example

Source: https://www.newtonsoft.com/json/help/html/SelectToken.htm

Combines SelectToken with LINQ methods to extract store names, first product names, and total price. Shows null results and computed totals.

```csharp
IList<string> storeNames = o.SelectToken("Stores").Select(s => (string)s).ToList();
// Lambton Quay
// Willis Street

IList<string> firstProductNames = o["Manufacturers"].Select(m => (string)m.SelectToken("Products[1].Name")).ToList();
// null
// Headlight Fluid

decimal totalPrice = o["Manufacturers"].Sum(m => (decimal)m.SelectToken("Products[0].Price"));
// 149.95
```

--------------------------------

### ITraceWriter.LevelFilter

Source: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Serialization_ITraceWriter.htm

Gets the TraceLevel that will be used to filter the trace messages passed to the writer. For example a filter level of Info will exclude Verbose messages and include Info, Warning and Error messages.

```APIDOC
## ITraceWriter.LevelFilter

### Description
Gets the TraceLevel that will be used to filter the trace messages passed to the writer. For example a filter level of Info will exclude Verbose messages and include Info, Warning and Error messages.

### Property
LevelFilter

### Returns
TraceLevel
```

--------------------------------

### Opt-in Serialization Example - Computer class with DataContract and DataMember

Source: https://www.newtonsoft.com/json/help/html/ReducingSerializedJSONSize.htm

Shows a Computer class using DataContract and DataMember attributes to opt in only the Name and SalePrice properties for serialization. Other public properties are ignored.

```csharp
[DataContract]
public class Computer
{
    // included in JSON
    [DataMember]
    public string Name { get; set; }

    [DataMember]
    public decimal SalePrice { get; set; }

    // ignored
    public string Manufacture { get; set; }
    public int StockCount { get; set; }
    public decimal WholeSalePrice { get; set; }
    public DateTime NextShipmentDate { get; set; }
}
```

--------------------------------

### Populate existing Account instance with JsonConvert.PopulateObject

Source: https://www.newtonsoft.com/json/help/html/PopulateObject.htm

Creates an Account instance, defines JSON with updated values, and calls JsonConvert.PopulateObject to merge the JSON into the existing object. Properties not present in the JSON (like Email and CreatedDate) remain unchanged, while Active and Roles are updated. The output shows the resulting values.

```csharp
Account account = new Account
{
    Email = "james@example.com",
    Active = true,
    CreatedDate = new DateTime(2013, 1, 20, 0, 0, 0, DateTimeKind.Utc),
    Roles = new List<string>
    {
        "User",
        "Admin"
    }
};

string json = @"{
  'Active': false,
  'Roles': [
    'Expired'
  ]
}";

JsonConvert.PopulateObject(json, account);

Console.WriteLine(account.Email);
// james@example.com

Console.WriteLine(account.Active);
// false

Console.WriteLine(string.Join(", ", account.Roles.ToArray()));
// User, Admin, Expired
```

--------------------------------

### DiagnosticsTraceWriter.LevelFilter Property

Source: https://www.newtonsoft.com/json/help/html/P_Newtonsoft_Json_Serialization_DiagnosticsTraceWriter_LevelFilter.htm

Gets the TraceLevel that will be used to filter the trace messages passed to the writer. For example a filter level of Info will exclude Verbose messages and include Info, Warning and Error messages.

```APIDOC
## DiagnosticsTraceWriter.LevelFilter Property

### Description
Gets the TraceLevel that will be used to filter the trace messages passed to the writer. For example a filter level of Info will exclude Verbose messages and include Info, Warning and Error messages.

### Namespace
Newtonsoft.Json.Serialization

### Assembly
Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db

### Syntax
```csharp
public TraceLevel LevelFilter { get; set; }
```

### Property Value
Type: TraceLevel
The TraceLevel that will be used to filter the trace messages passed to the writer.

### Implements
ITraceWriter.LevelFilter

### Reference
DiagnosticsTraceWriter Class
Newtonsoft.Json.Serialization Namespace
Json.NET Home
```

--------------------------------

### CustomCreationConverter implementation with IPerson and Employee

Source: https://www.newtonsoft.com/json/help/html/CustomCreationConverter.htm

Defines an IPerson interface, an Employee class implementing it, and a PersonConverter that overrides Create to return a new Employee. This is a simple example; more complex scenarios could use an object factory or service locator.

```csharp
public interface IPerson
{
    string FirstName { get; set; }
    string LastName { get; set; }
    DateTime BirthDate { get; set; }
}

public class Employee : IPerson
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public DateTime BirthDate { get; set; }

    public string Department { get; set; }
    public string JobTitle { get; set; }
}

public class PersonConverter : CustomCreationConverter<IPerson>
{
    public override IPerson Create(Type objectType)
    {
        return new Employee();
    }
}
```

--------------------------------

### JObject()

Source: https://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_Linq_JObject__ctor.htm

Initializes a new instance of the JObject class.

```APIDOC
## JObject Constructor ()

### Description
Initializes a new instance of the JObject class.

### Method
Constructor

### Parameters
None

### Return Value
A new JObject instance.
```

--------------------------------

### Validate JSON with IsValid and get error messages

Source: https://www.newtonsoft.com/json/help/html/JsonSchema.htm

Uses the IsValid(JToken, JsonSchema, IList<String>) overload to collect validation error messages. The example shows that invalid JSON produces false and messages describing the type mismatches.

```csharp
JsonSchema schema = JsonSchema.Parse(schemaJson);

JObject person = JObject.Parse(@"{
  'name': null,
  'hobbies': ['Invalid content', 0.123456789]
}");

IList<string> messages;
bool valid = person.IsValid(schema, out messages);
// false
// Invalid type. Expected String but got Null. Line 2, position 21.
// Invalid type. Expected String but got Float. Line 3, position 51.
```

--------------------------------

### JProperty Constructor (String, Object)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JProperty__ctor_1.htm

Documentation for the JProperty constructor that takes a string name and an object content.

```APIDOC
## JProperty Constructor (String, Object)

### Description
Initializes a new instance of the JProperty class with the specified property name and content.

### Method
Constructor

### Signature
`public JProperty(string name, object content)`

### Parameters
- **name** (System.String) - The property name.
- **content** (System.Object) - The property content.

### Remarks
This constructor is part of the Newtonsoft.Json.Linq.JProperty class. It is used to create a new JProperty instance with a given name and content.
```

--------------------------------

### BsonWriter.WriteStartConstructor Method

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Bson_BsonWriter_WriteStartConstructor.htm

Documentation for the BsonWriter.WriteStartConstructor method, which writes the start of a constructor with the given name.

```APIDOC
## BsonWriter.WriteStartConstructor Method

### Description
Writes the start of a constructor with the given name.

### Method
WriteStartConstructor

### Signature
public override void WriteStartConstructor(string name)

### Parameters
- **name** (System.String) - Required - The name of the constructor.

### Return Value
void
```

--------------------------------

### Getting JSON Values with JObject/JArray Index

Source: https://www.newtonsoft.com/json/help/html/QueryingLINQtoJSON.htm

Uses the Item[Object] index on JObject/JArray to retrieve values by property name or collection index, then casts the returned JValue to the desired type. The example parses a JSON string and accesses nested properties, array elements, and a JArray, then converts the JArray to a list of strings.

```csharp
string json = @"{
  'channel': {
    'title': 'James Newton-King',
    'link': 'http://james.newtonking.com',
    'description': 'James Newton-King\'s blog.',
    'item': [
      {
        'title': 'Json.NET 1.3 + New license + Now on CodePlex',
        'description': 'Announcing the release of Json.NET 1.3, the MIT license and the source on CodePlex',
        'link': 'http://james.newtonking.com/projects/json-net.aspx',
        'categories': [
          'Json.NET',
          'CodePlex'
        ]
      },
      {
        'title': 'LINQ to JSON beta',
        'description': 'Announcing LINQ to JSON',
        'link': 'http://james.newtonking.com/projects/json-net.aspx',
        'categories': [
          'Json.NET',
          'LINQ'
        ]
      }
    ]
  }
}";

JObject rss = JObject.Parse(json);

string rssTitle = (string)rss["channel"]["title"];
// James Newton-King

string itemTitle = (string)rss["channel"]["item"][0]["title"];
// Json.NET 1.3 + New license + Now on CodePlex

JArray categories = (JArray)rss["channel"]["item"][0]["categories"];
// ["Json.NET", "CodePlex"]

IList<string> categoriesText = categories.Select(c => (string)c).ToList();
// Json.NET
// CodePlex
```

--------------------------------

### SnakeCaseNamingStrategy Constructor

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Serialization_SnakeCaseNamingStrategy__ctor.htm

Initializes a new instance of the SnakeCaseNamingStrategy class.

```APIDOC
## SnakeCaseNamingStrategy Constructor

### Description
Initializes a new instance of the SnakeCaseNamingStrategy class.

### Namespace
Newtonsoft.Json.Serialization

### Assembly
Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db

### Syntax
```csharp
public SnakeCaseNamingStrategy()
```

### Parameters
None.

### Return Value
A new instance of the SnakeCaseNamingStrategy class.

### Remarks
This constructor initializes a new instance of the SnakeCaseNamingStrategy class with default settings.

### Reference
- SnakeCaseNamingStrategy Class
- SnakeCaseNamingStrategy Overload
- Newtonsoft.Json.Serialization Namespace
```

--------------------------------

### Querying JSON with complex JSONPath using SelectToken and SelectTokens in C#

Source: https://www.newtonsoft.com/json/help/html/QueryJsonSelectTokenJsonPath.htm

This example loads a JSON object and demonstrates how to use SelectToken and SelectResult from Json.NET to query it with complex JSONPath expressions, showing how to filter and extract specific elements and properties, with printed outputs shown in-line in therning behaviors such as returning IEnumerable for C# example: complex.jsonpath.usage.example.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt first example Usage example.txt.txt.txt.txt.txt.txt.txt.txt.txt.txt demonstrates loading a complex JSON object and using SelectToken to get Manufacturer with name 'Acme Co' and SelectTokens to get names of all products priced  with the '@' notation for the current node in predicates and '.' notation for member names with special names with special names with special names: the use of '@' notation for the current node in predicates and '.' notation for member names with special names with special names with special names with special names with special names with special names with special names: the use of '@' notation. the use of '@' notation for the current node in predicates and '.' notation for Member names with special names with special names with special language: 

```csharp
JObject o = JCommand.Parse(@"{
  'Stellars': [
    'Lambton Quay',
    'Willis Street'
  ],
  'Manufacturers': [
    {
      'Name': 'Acme Co',
     
        {
          'Name': 'Anvil',
          'Price': 50
        }
      ]
    },
    {
      
```

```csharp
// manufacturer with the JToken acme = o.SelectToken("$.Manufacturers[?(@.Name == 'Acme Co')]”
Console.WriteLine( // { "Name": // { "Name": // { "Name": // { "Name": // { "name": // { "name": // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" // { "name" comments omitted for brevity and to avoid duplication; see source for full code example Usage example.txt.txt.txt.txt.txt.txt.txt.txt      
```

--------------------------------

### SnakeCaseNamingStrategy Constructor (Boolean, Boolean, Boolean)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Serialization_SnakeCaseNamingStrategy__ctor_2.htm

Initializes a new instance of the SnakeCaseNamingStrategy class with flags for processing dictionary keys, overriding specified names, and processing extension data names.

```APIDOC
## SnakeCaseNamingStrategy Constructor (Boolean, Boolean, Boolean)

### Description
Initializes a new instance of the SnakeCaseNamingStrategy class with the specified flags for processing dictionary keys, overriding specified names, and processing extension data names.

### Method
Constructor

### Signature
```csharp
public SnakeCaseNamingStrategy(
	bool processDictionaryKeys,
	bool overrideSpecifiedNames,
	bool processExtensionDataNames
)
```

### Parameters
- **processDictionaryKeys** (System.Boolean) - A flag indicating whether dictionary keys should be processed.
- **overrideSpecifiedNames** (System.Boolean) - A flag indicating whether explicitly specified property names should be processed, e.g. a property name customized with a JsonPropertyAttribute.
- **processExtensionDataNames** (System.Boolean) - A flag indicating whether extension data names should be processed.

### Return Value
None (constructor).
```

--------------------------------

### JTokenWriter.WriteValue(Guid)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JTokenWriter_WriteValue_8.htm

Writes a Guid value to the JTokenWriter. This method is an override of the base WriteValue method and is used to write a Guid value to the underlying token.

```APIDOC
## JTokenWriter.WriteValue(Guid)

### Description
Writes a Guid value to the JTokenWriter.

### Method
WriteValue(Guid)

### Parameters
- **value** (System.Guid) - Required - The Guid value to write.

### Return Value
void

### Remarks
This method overrides the base WriteValue method.
```

--------------------------------

### Serialize and deserialize with callback attributes

Source: https://www.newtonsoft.com/json/help/html/SerializationCallbackAttributes.htm

Creates an instance, serializes it with JsonConvert.SerializeObject, and then deserializes it, printing the property values at each stage to show the effect of the callback attributes.

```csharp
SerializationEventTestObject obj = new SerializationEventTestObject();

Console.WriteLine(obj.Member1);
// 11
Console.WriteLine(obj.Member2);
// Hello World!
Console.WriteLine(obj.Member3);
// This is a nonserialized value
Console.WriteLine(obj.Member4);
// null

string json = JsonConvert.SerializeObject(obj, Formatting.Indented);
// {
//   "Member1": 11,
//   "Member2": "This value went into the data file during serialization.",
//   "Member4": null
// }

Console.WriteLine(obj.Member1);
// 11
Console.WriteLine(obj.Member2);
// This value was reset after serialization.
Console.WriteLine(obj.Member3);
// This is a nonserialized value
Console.WriteLine(obj.Member4);
// null

obj = JsonConvert.DeserializeObject<SerializationEventTestObject>(json);

Console.WriteLine(obj.Member1);
// 11
Console.WriteLine(obj.Member2);
// This value went into the data file during serialization.
Console.WriteLine(obj.Member3);
// This value was set during deserialization
Console.WriteLine(obj.Member4);
// This value was set after deserialization.
```

--------------------------------

### WriteValue(Guid)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonTextWriter_WriteValue_8.htm

Writes a Guid value to the JSON output.

```APIDOC
## WriteValue(Guid)

### Description
Writes a Guid value.

### Method
WriteValue

### Signature
public override void WriteValue(Guid value)

### Parameters
- **value** (System.Guid) - The Guid value to write.

### Return Value
void
```

--------------------------------

### BsonWriter.WriteValue(Guid)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Bson_BsonWriter_WriteValue_8.htm

Writes a Guid value to the BSON output.

```APIDOC
## BsonWriter.WriteValue(Guid)

### Description
Writes a Guid value to the BSON writer.

### Method
WriteValue(Guid)

### Parameters
- **value** (System.Guid) - Required - The Guid value to write.

### Return Value
void
```

--------------------------------

### JsonContainer attribute with NamingStrategyParameters

Source: https://www.newtonsoft.com/json/help/html/P_Newtonsoft_Json_JsonContainerAttribute_NamingStrategyParameters.htm

Example attribute usage showing how to pass constructor parameters to a custom naming strategy. The parameters must match the constructor's number, order, and type.

```csharp
[JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
```

--------------------------------

### Serialize and deserialize NuGetPackage with VersionConverter

Source: https://www.newtonsoft.com/json/help/html/CustomJsonConverterGeneric.htm

Shows how to use the VersionConverter with JsonConvert.SerializeObject and JsonConvert.DeserializeObject. The serialized JSON contains the Version as a string, and deserialization reconstructs the Version object.

```csharp
NuGetPackage p1 = new NuGetPackage
{
    PackageId = "Newtonsoft.Json",
    Version = new Version(10, 0, 4)
};

string json = JsonConvert.SerializeObject(p1, Formatting.Indented, new VersionConverter());

Console.WriteLine(json);
// {
//   "PackageId": "Newtonsoft.Json",
//   "Version": "10.0.4"
// }

NuGetPackage p2 = JsonConvert.DeserializeObject<NuGetPackage>(json, new VersionConverter());

Console.WriteLine(p2.Version.ToString());
// 10.0.4
```

--------------------------------

### public static implicit operator JToken (Guid value)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JToken_op_Implicit_7.htm

Performs an implicit conversion from a Guid to a JToken. The operator creates a JValue initialized with the specified Guid value.

```APIDOC
## Implicit Conversion (Guid to JToken)

### Description
Performs an implicit conversion from Guid to JToken.

### Method
Implicit conversion operator

### Signature
public static implicit operator JToken (Guid value)

### Parameters
- **value** (System.Guid) - The value to create a JValue from.

### Return Value
- **JToken** - The JValue initialized with the specified value.

### Reference
- JToken Class
- Implicit Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### JValue Constructor (Guid)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JValue__ctor_7.htm

Constructor for JValue that takes a Guid value.

```APIDOC
## JValue Constructor (Guid)

### Description
Initializes a new instance of the JValue class with the given Guid value.

### Method
Constructor

### Signature
public JValue(Guid value)

### Parameters
- **value** (System.Guid) - Required - The value.

### Reference
- JValue Class
- JValue Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### JObject.FromObject Method

Source: https://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_Linq_JObject_FromObject.htm

Documentation for the JObject.FromObject method overloads.

```APIDOC
## JObject.FromObject(Object)

### Description
Creates a JObject from an object.

### Method
FromObject(Object)

### Parameters
- **o** (Object) - The object that will be used to create the JObject.

### Returns
JObject - The JObject created from the object.

```

```APIDOC
## JObject.FromObject(Object, JsonSerializer)

### Description
Creates a JObject from an object using a specified JsonSerializer.

### Method
FromObject(Object, JsonSerializer)

### Parameters
- **o** (Object) - The object that will be used to create the JObject.
- **jsonSerializer** (JsonSerializer) - The JsonSerializer that will be used to serialize the object.

### Returns
JObject - The JObject created from the object.

```

--------------------------------

### NullValueHandling Ignore Example - Serializing Movie with and without ignoring nulls

Source: https://www.newtonsoft.com/json/help/html/ReducingSerializedJSONSize.htm

Shows serializing a Movie instance with default settings (including null properties) and with NullValueHandling.Ignore to omit null properties. The output demonstrates the difference in JSON size.

```csharp
Movie movie = new Movie();
movie.Name = "Bad Boys III";
movie.Description = "It's no Bad Boys";

string included = JsonConvert.SerializeObject(movie,
    Formatting.Indented,
    new JsonSerializerSettings { });

// {
//   "Name": "Bad Boys III",
//   "Description": "It's no Bad Boys",
//   "Classification": null,
//   "Studio": null,
//   "ReleaseDate": null,
//   "ReleaseCountries": null
// }

string ignored = JsonConvert.SerializeObject(movie,
    Formatting.Indented,
    new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore });

// {
//   "Name": "Bad Boys III",
//   "Description": "It's no Bad Boys"
// }
```

--------------------------------

### JsonConvert.ToString(Guid)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonConvert_ToString_10.htm

Converts the specified Guid to its JSON string representation.

```APIDOC
## ToString(Guid)

### Description
Converts the Guid to its JSON string representation.

### Method
ToString(Guid)

### Signature
public static string ToString(Guid value)

### Parameters
- **value** (System.Guid) - The value to convert.

### Return Value
Type: String
A JSON string representation of the Guid.

### Example
```csharp
string json = JsonConvert.ToString(myGuid);
```
```

--------------------------------

### JProperty Constructor (String, Object[])

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JProperty__ctor_2.htm

Initializes a new instance of the JProperty class with the specified property name and content.

```APIDOC
## JProperty Constructor (String, Object[])

### Description
Initializes a new instance of the JProperty class with the specified property name and content.

### Method
Constructor

### Signature
public JProperty(string name, params Object[] content)

### Parameters
- **name** (System.String) - The property name.
- **content** (System.Object[]) - The property content.

### Reference
- JProperty Class
- JProperty Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### JsonProperty.ValueProvider Property

Source: https://www.newtonsoft.com/json/help/html/P_Newtonsoft_Json_Serialization_JsonProperty_ValueProvider.htm

Gets the IValueProvider that will get and set the JsonProperty during serialization.

```APIDOC
## [GET] /JsonProperty/ValueProvider

### Description
Gets the IValueProvider that will get and set the JsonProperty during serialization.

### Method
GET

### Endpoint
/JsonProperty/ValueProvider

### Parameters
#### Path Parameters
- **propertyName** (string) - Required - The name of the property to get the ValueProvider for.

### Response
#### Success Response (200)
- **ValueProvider** (IValueProvider) - The IValueProvider that will get and set the JsonProperty during serialization.

#### Response Example
{
  "ValueProvider": {}
}
```

--------------------------------

### Explicit Conversion (JToken to Guid)

Source: https://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_Linq_JToken_op_Explicit.htm

Converts a JToken to a Guid value explicitly.

```APIDOC
## Explicit Conversion (JToken to Guid)

### Description
Converts a JToken to a Guid value explicitly.

### Method
Explicit Conversion Operator

### Syntax
public static explicit operator Guid(JToken value)

### Parameters
- **value** (JToken) - The JToken to convert.

### Returns
- **Guid** - The converted Guid value.

### Exceptions
- **ArgumentException** - Thrown when the value is not convertible to Guid.

### Example
```csharp
JToken token = JToken.FromObject(Guid.NewGuid());
Guid result = (Guid)token;
```
```

--------------------------------

### ToString(IFormatProvider)

Source: https://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_Linq_JValue_ToString.htm

Returns a String that represents this instance using the specified format provider.

```APIDOC
## ToString(IFormatProvider)

### Description
Returns a String that represents this instance using the specified format provider.

### Method
ToString(IFormatProvider)

### Parameters
#### Parameters
- **provider** (IFormatProvider) - Required - The format provider to use for formatting.
```

--------------------------------

### Serialize Account with JsonConvert and show ordered JSON output

Source: https://www.newtonsoft.com/json/help/html/JsonPropertyOrder.htm

Creates an Account instance, serializes it with JsonConvert.SerializeObject using Formatting.Indented, and writes the JSON to the console. The output shows the properties in the order determined by the JsonProperty attributes: FullName first, then EmailAddress, CreatedDate, UpdatedDate, Deleted, and DeletedDate.

```csharp
Account account = new Account
{
    FullName = "Aaron Account",
    EmailAddress = "aaron@example.com",
    Deleted = true,
    DeletedDate = new DateTime(2013, 1, 25),
    UpdatedDate = new DateTime(2013, 1, 25),
    CreatedDate = new DateTime(2010, 10, 1)
};

string json = JsonConvert.SerializeObject(account, Formatting.Indented);

Console.WriteLine(json);
// {
//   "FullName": "Aaron Account",
//   "EmailAddress": "aaron@example.com",
//   "CreatedDate": "2010-10-01T00:00:00",
//   "UpdatedDate": "2013-01-25T00:00:00",
//   "Deleted": true,
//   "DeletedDate": "2013-01-25T00:00:00"
// }
```

--------------------------------

### public static explicit operator Nullable<Guid>(JToken value)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JToken_op_Explicit_33.htm

Performs an explicit conversion from a JToken to a nullable Guid. The conversion takes a JToken value and returns the result as a Nullable<Guid>.

```APIDOC
## Explicit Conversion (JToken to Nullable<Guid>)

### Description
Performs an explicit conversion from JToken to Nullable<T> of Guid.

### Method
Explicit operator

### Signature
public static explicit operator Nullable<Guid> (JToken value)

### Parameters
- **value** (JToken) - The value to convert.

### Return Value
Type: Nullable<Guid> - The result of the conversion.

### Reference
- JToken Class
- Explicit Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### Explicit(JToken to Nullable<Guid>)

Source: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JToken.htm

Performs an explicit conversion from JToken to Nullable<Guid>.

```APIDOC
## Explicit(JToken to Nullable<Guid>)

### Description
Performs an explicit conversion from JToken to Nullable<T> of Guid.

### Method
Explicit

### Parameters
- **value** (JToken) - Required - The token to convert.

### Returns
Nullable<Guid> - The converted value.
```

--------------------------------

### JArray Constructor (Object)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JArray__ctor_2.htm

Constructor for JArray that initializes a new instance with the specified content.

```APIDOC
## JArray Constructor (Object)

### Description
Initializes a new instance of the JArray class with the specified content.

### Method
Constructor

### Signature
```csharp
public JArray(
    Object content
)
```

### Parameters
- **content** (System.Object) - Required - The contents of the array.

### Remarks
- **Namespace:** Newtonsoft.Json.Linq
- **Assembly:** Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db
```

--------------------------------

### BinaryConverter Constructor

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Converters_BinaryConverter__ctor.htm

Documentation for the BinaryConverter constructor, which initializes a new instance of the BinaryConverter class.

```APIDOC
## BinaryConverter Constructor

### Description
Initializes a new instance of the BinaryConverter class.

### Syntax
```csharp
public BinaryConverter()
```

### Parameters
None.

### Return Value
None.

### Exceptions
None.

### Remarks
This constructor is used to create a new instance of the BinaryConverter class.

### Example
```csharp
BinaryConverter converter = new BinaryConverter();
```
```

--------------------------------

### WriteValue(Nullable<Guid>)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonWriter_WriteValue_19.htm

Writes a Nullable<T> of Guid value to the current JSON writer.

```APIDOC
## WriteValue(Nullable<Guid>)

### Description
Writes a Nullable<T> of Guid value to the current JSON writer.

### Method
WriteValue

### Signature
public virtual void WriteValue(Nullable<Guid> value)

### Parameters
- **value** (System.Nullable<Guid>) - The Nullable<T> of Guid value to write.

### Return Value
void

### Remarks
This method is virtual and can be overridden in derived classes.

### Reference
- JsonWriter Class
- WriteValue Overload
- Newtonsoft.Json Namespace
```

--------------------------------

### Create Method

Source: https://www.newtonsoft.com/json/help/html/Methods_T_Newtonsoft_Json_Converters_CustomCreationConverter_1.htm

Creates an object which will then be populated by the serializer.

```APIDOC
## Create Method

### Description
Creates an object which will then be populated by the serializer.

### Method
Create

### Signature
`public abstract T Create(Type objectType)`

### Parameters
- **objectType** (Type) - The type of object to create.

### Returns
- **T** - The created object.
```

--------------------------------

### Implicit Conversion (Nullable<Guid> to JToken)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JToken_op_Implicit_17.htm

This code snippet documents the implicit conversion operator from Nullable<Guid> to JToken in the Newtonsoft.Json.Linq namespace.

```APIDOC
## Implicit Conversion (Nullable<Guid> to JToken)

### Description
Performs an implicit conversion from Nullable<Guid> to JToken.

### Method
Implicit operator

### Signature
```csharp
public static implicit operator JToken (
	Nullable<Guid> value
)
```

### Parameters
- **value** (System.Nullable<Guid>) - The value to create a JValue from.

### Return Value
Type: JToken - The JValue initialized with the specified value.

### Reference
- JToken Class
- Implicit Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### WriteValueAsync(Guid, CancellationToken)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonTextWriter_WriteValueAsync_8.htm

Asynchronously writes a Guid value. This method is part of the JsonTextWriter class and returns a Task representing the asynchronous operation.

```APIDOC
## WriteValueAsync(Guid, CancellationToken)

### Description
Asynchronously writes a Guid value.

### Method
WriteValueAsync

### Signature
```csharp
public override Task WriteValueAsync(
	Guid value,
	CancellationToken cancellationToken = null
)
```

### Parameters
- **value** (System.Guid) - Required - The Guid value to write.
- **cancellationToken** (System.Threading.CancellationToken) - Optional - The token to monitor for cancellation requests. The default value is None.

### Return Value
- **Task** - A Task that represents the asynchronous operation.

### Remarks
Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.

### Reference
- JsonTextWriter Class
- WriteValueAsync Overload
- Newtonsoft.Json Namespace
```

--------------------------------

### JsonPropertyCollection.GetClosestMatchProperty Method

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Serialization_JsonPropertyCollection_GetClosestMatchProperty.htm

Gets the closest matching JsonProperty object. First attempts to get an exact case match of propertyName and then a case insensitive match.

```APIDOC
## GetClosestMatchProperty Method

### Description
Gets the closest matching JsonProperty object. First attempts to get an exact case match of propertyName and then a case insensitive match.

### Method
GetClosestMatchProperty

### Signature
public JsonProperty GetClosestMatchProperty(string propertyName)

### Parameters
- **propertyName** (System.String) - Required - Name of the property.

### Return Value
Type: JsonProperty - A matching property if found.

### Reference
JsonPropertyCollection Class
Newtonsoft.Json.Serialization Namespace
```

--------------------------------

### JArray Constructor ()

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JArray__ctor.htm

Initializes a new instance of the JArray class with no parameters.

```APIDOC
## JArray Constructor ()

### Description
Initializes a new instance of the JArray class.

### Syntax
csharp
public JArray()


### Parameters
None.

### Return Value
A new instance of the JArray class.

### Reference
- JArray Class
- JArray Overload
- Newtonsoft.Json.Linq Namespace
```

--------------------------------

### WriteValueAsync Method (Nullable<Guid>, CancellationToken)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonWriter_WriteValueAsync_19.htm

Asynchronously writes a Nullable<Guid> value to the JSON writer. This method is part of the JsonWriter class in the Newtonsoft.Json namespace.

```APIDOC
## WriteValueAsync Method (Nullable<Guid>, CancellationToken)

### Description
Asynchronously writes a Nullable<T> of Guid value.

### Method
WriteValueAsync

### Signature
public virtual Task WriteValueAsync(Nullable<Guid> value, CancellationToken cancellationToken = null)

### Parameters
- **value** (System.Nullable<Guid>) - Required - The Nullable<T> of Guid value to write.
- **cancellationToken** (System.Threading.CancellationToken) - Optional - The token to monitor for cancellation requests. The default value is None.

### Return Value
Type: Task - A Task that represents the asynchronous operation. The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.
```

--------------------------------

### JObject Constructor (Object)

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JObject__ctor_2.htm

Constructor for JObject that initializes a new instance with the specified content.

```APIDOC
## JObject Constructor (Object)

### Description
Initializes a new instance of the JObject class with the specified content.

### Method
Constructor

### Signature
public JObject(Object content)

### Parameters
- **content** (System.Object) - Required - The contents of the object.

### Remarks
- **Namespace:** Newtonsoft.Json.Linq
- **Assembly:** Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db
```

--------------------------------

### DynamicCodeGeneration Property

Source: https://www.newtonsoft.com/json/help/html/Properties_T_Newtonsoft_Json_Serialization_DefaultContractResolver.htm

Gets a value indicating whether members are being get and set using dynamic code generation. This value is determined by the runtime permissions available.

```APIDOC
## DynamicCodeGeneration Property

### Description
Gets a value indicating whether members are being get and set using dynamic code generation. This value is determined by the runtime permissions available.

### Property Signature
```csharp
public bool DynamicCodeGeneration { get; }
```

### Property Value
- **Type**: bool
- **Access**: Gets
```

--------------------------------

### JsonLoadSettings Constructor

Source: https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Linq_JsonLoadSettings__ctor.htm

Initializes a new instance of the JsonLoadSettings class.

```APIDOC
## JsonLoadSettings Constructor

### Description
Initializes a new instance of the JsonLoadSettings class.

### Syntax
```csharp
public JsonLoadSettings()
```

### Parameters
None.

### Return Value
A new instance of the JsonLoadSettings class.

### Remarks
This constructor is used to create a JsonLoadSettings object, which can be used to configure loading options for JSON operations.
```

--------------------------------

### JArray.Item Property

Source: https://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_Linq_JArray_Item.htm

Documentation for the JArray.Item property overloads, including the indexer that gets or sets a JToken at a specified index and the key-based accessor that gets a JToken with a specified key.

```APIDOC
## JArray.Item Property (Int32)

### Description
Gets or sets the JToken at the specified index.

### Syntax
```csharp
public JToken this[int index] { get; set; }
```

### Parameters
- **index** (Int32) - The zero-based index of the element to get or set.

### Property Value
- **JToken** - The JToken at the specified index.

### Exceptions
- **ArgumentOutOfRangeException** - Thrown when the index is less than 0 or greater than or equal to Count.

## JArray.Item Property (Object)

### Description
Gets the JToken with the specified key. This is an override of JToken.Item[Object].

### Syntax
```csharp
public override JToken this[object key] { get; }
```

### Parameters
- **key** (Object) - The key of the token to get.

### Property Value
- **JToken** - The JToken with the specified key.

### Remarks
This property is used to access tokens by key, typically for objects. For arrays, the key is typically an integer index.
```

--------------------------------

### JsonPropertyCollection Constructor

Source: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Serialization_JsonPropertyCollection.htm

Initializes a new instance of the JsonPropertyCollection class.

```APIDOC
## JsonPropertyCollection Constructor

### Description
Initializes a new instance of the JsonPropertyCollection class.

### Syntax
```csharp
public JsonPropertyCollection()
```

### Parameters
None.

### Exceptions
None.
```
Tokens:
Raw