logo
logo
  • Class EntityLoadOptions

    Specifies if and how resulting entities should be loaded.

    Inheritance
    System.Object
    EntityLoadOptions
    Namespace: Stylelabs.M.Base.Querying
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public class EntityLoadOptions : object

    Properties

    CulturesToLoad

    The cultures to load the entities in. If not specified, the entities will only be loaded in the invariant-culture.

    If the collection contains value "*", the entities will be loaded in all installed cultures.

    Declaration
    public IEnumerable<string> CulturesToLoad { get; set; }
    Property Value
    Type Description
    IEnumerable<System.String>

    LoadEntities

    Indicates if entities should be loaded.

    Declaration
    public bool LoadEntities { get; set; }
    Property Value
    Type Description
    System.Boolean

    PropertiesToLoad

    The names of the properties to load with the entities. If the value contains "*", all properties will be loaded. If the value is null, no properties will be loaded.

    The default value is "*", which mean all properties will be loaded.

    Declaration
    public IEnumerable<string> PropertiesToLoad { get; set; }
    Property Value
    Type Description
    IEnumerable<System.String>

    RelationsToLoad

    The names of the relations to load with the entities. If the value is null, no relations will be loaded.

    The default value is null, which mean no relations will be loaded.

    Declaration
    public IEnumerable<string> RelationsToLoad { get; set; }
    Property Value
    Type Description
    IEnumerable<System.String>

    Methods

    ToQueryLoadConfiguration()

    Converts the load-options to an instance of IQueryLoadConfiguration.

    Declaration
    public IQueryLoadConfiguration ToQueryLoadConfiguration()
    Returns
    Type Description
    IQueryLoadConfiguration

    Can we improve this article ? Provide feedback