Class QueryLoadConfiguration
Inheritance
Implements
Namespace: Stylelabs.M.Framework.Essentials.LoadConfigurations
Assembly: Stylelabs.M.Sdk.dll
Syntax
public class QueryLoadConfiguration : object, IQueryLoadConfigurationConstructors
QueryLoadConfiguration()
Creates an empty load configuration. Loads no entities by default.
Declaration
public QueryLoadConfiguration()QueryLoadConfiguration(IQueryLoadConfiguration)
Creates a copy of the load configuration.
Declaration
public QueryLoadConfiguration(IQueryLoadConfiguration configuration)Parameters
| Type | Name | Description |
|---|---|---|
| IQueryLoadConfiguration | configuration | The load configuration. |
QueryLoadConfiguration(ICultureLoadOption, IPropertyLoadOption, IRelationLoadOption)
Creates a new load configuration with specified loading options. Loads entities by default.
Declaration
public QueryLoadConfiguration(ICultureLoadOption cultureOption, IPropertyLoadOption propertyOption, IRelationLoadOption relationOption)Parameters
| Type | Name | Description |
|---|---|---|
| ICultureLoadOption | cultureOption | Culture load option. |
| IPropertyLoadOption | propertyOption | Property load option. |
| IRelationLoadOption | relationOption | Relation load option. |
QueryLoadConfiguration(Boolean, ICultureLoadOption, IPropertyLoadOption, IRelationLoadOption)
Creates a new load configuration with specified loading options.
Declaration
public QueryLoadConfiguration(bool loadEntities, ICultureLoadOption cultureOption, IPropertyLoadOption propertyOption, IRelationLoadOption relationOption)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | loadEntities | Load entities. |
| ICultureLoadOption | cultureOption | Culture load option. |
| IPropertyLoadOption | propertyOption | Property load option. |
| IRelationLoadOption | relationOption | Relation load option. |
Properties
CultureLoadOption
Declaration
public ICultureLoadOption CultureLoadOption { get; set; }Property Value
| Type | Description |
|---|---|
| ICultureLoadOption |
Default
Gets the query result entities in default culture, with all properties and no relations.
Declaration
public static IQueryLoadConfiguration Default { get; }Property Value
| Type | Description |
|---|---|
| IQueryLoadConfiguration |
DefaultCultureFull
Gets the query result entities in default culture, with all properties and all relations.
Declaration
public static IQueryLoadConfiguration DefaultCultureFull { get; }Property Value
| Type | Description |
|---|---|
| IQueryLoadConfiguration |
Full
Gets the query result entities in all installed cultures, with all properties and all relations.
Declaration
public static IQueryLoadConfiguration Full { get; }Property Value
| Type | Description |
|---|---|
| IQueryLoadConfiguration |
Ids
The query result will only contain ids.
Declaration
public static IQueryLoadConfiguration Ids { get; }Property Value
| Type | Description |
|---|---|
| IQueryLoadConfiguration |
LoadEntities
Declaration
public bool LoadEntities { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Minimal
Only loads the base entity properties.
Declaration
public static IQueryLoadConfiguration Minimal { get; }Property Value
| Type | Description |
|---|---|
| IQueryLoadConfiguration |
PropertyLoadOption
Declaration
public IPropertyLoadOption PropertyLoadOption { get; set; }Property Value
| Type | Description |
|---|---|
| IPropertyLoadOption |
RelationLoadOption
Declaration
public IRelationLoadOption RelationLoadOption { get; set; }Property Value
| Type | Description |
|---|---|
| IRelationLoadOption |
Implements
Can we improve this article ? Provide feedback