Class EntityLoadOptions

Current version: 3.4

Specifies if and how resulting entities should be loaded.

Inheritance
object
EntityLoadOptions
Namespace: StylelabsStylelabs.MStylelabs.M.BaseQuerying
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public class EntityLoadOptions

Properties

CulturesToLoad

Gets or sets 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
RequestResponse
public IEnumerable<string> CulturesToLoad { get; set; }
Property Value
TypeDescription
IEnumerable<>string

LoadEntities

Gets or sets a value indicating whether the entities should be loaded.

Declaration
RequestResponse
public bool LoadEntities { get; set; }
Property Value
TypeDescription
bool

PropertiesToLoad

Gets or sets 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
RequestResponse
public IEnumerable<string> PropertiesToLoad { get; set; }
Property Value
TypeDescription
IEnumerable<>string

RelationsToLoad

Gets or sets 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
RequestResponse
public IEnumerable<string> RelationsToLoad { get; set; }
Property Value
TypeDescription
IEnumerable<>string

Methods

ToQueryLoadConfiguration()

Converts the load-options to an instance of IQueryLoadConfiguration.

Declaration
RequestResponse
public IQueryLoadConfiguration ToQueryLoadConfiguration()
Returns
TypeDescription
IQueryLoadConfiguration

The query load configuration.

Do you have some feedback for us?

If you have suggestions for improving this article,