Excluding fields

Introduction

By default all public properties on an object are included when indexing it. Below we describe how properties can be excluded.

Examples

The simplest way to exclude a property is to annotate it with the JsonIgnore attribute (found in the Newtonsoft.Json namespace).

using Newtonsoft.Json;

public class User
{
    public string Username { get; set; }

    [JsonIgnore]
    public string Password { get; set; }
}

It is also possible to exclude properties, or other previously included fields, by customizing the Client conventions.

//using EPiServer.Find.ClientConventions;

client.Conventions
    .ForInstancesOf<User>()
        .ExcludeField(x => x.Password);

The above code excludes the Password property from instances of the User class as well as instances of classes that inherit the User class.