Class EntityLoadConfigurationBuilder
Default implementation of IEntityLoadConfigurationBuilder.
Inheritance
Implements
Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadConfigurations
Assembly: Stylelabs.M.Sdk.dll
Syntax
public class EntityLoadConfigurationBuilder : IEntityLoadConfigurationBuilderConstructors
EntityLoadConfigurationBuilder()
Initializes a new instance of the EntityLoadConfigurationBuilder class. The builder will build a completely new EntityLoadConfiguration.
Declaration
public EntityLoadConfigurationBuilder()EntityLoadConfigurationBuilder(IEntityLoadConfiguration)
Initializes a new instance of the EntityLoadConfigurationBuilder class. The builder will extend or overwrite an existing EntityLoadConfiguration.
Declaration
public EntityLoadConfigurationBuilder(IEntityLoadConfiguration entityLoadConfiguration)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityLoadConfiguration | entityLoadConfiguration |
The existing EntityLoadConfiguration to extend or overwrite. |
Methods
Build()
Gets the resulting instance of IEntityLoadConfiguration.
Declaration
public IEntityLoadConfiguration Build()Returns
| Type | Description |
|---|---|
| IEntityLoadConfiguration |
The builder. |
InCulture(CultureInfo)
Indicates that entities should be loaded in the specified culture.
Declaration
public IEntityLoadConfigurationBuilder InCulture(CultureInfo culture)Parameters
| Type | Name | Description |
|---|---|---|
| CultureInfo | culture |
The culture. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
InCultures(params CultureInfo[])
Indicates that entities should be loaded in the specified cultures.
Declaration
public IEntityLoadConfigurationBuilder InCultures(params CultureInfo[] cultures)Parameters
| Type | Name | Description |
|---|---|---|
| CultureInfo | cultures |
The cultures. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
InCultures(IEnumerable<CultureInfo>)
Indicates that entities should be loaded in the specified cultures.
Declaration
public IEntityLoadConfigurationBuilder InCultures(IEnumerable<CultureInfo> cultures)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>CultureInfo | cultures |
The cultures. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
InCultures(LoadOption)
Indicates that entities should be loaded int the cultures specified by LoadOption.
Declaration
public IEntityLoadConfigurationBuilder InCultures(LoadOption loadOption)Parameters
| Type | Name | Description |
|---|---|---|
| LoadOption | loadOption |
The load option. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithProperties(IEnumerable<string>)
Indicates that entities should be loaded with the specified properties.
Declaration
public IEntityLoadConfigurationBuilder WithProperties(IEnumerable<string> properties)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | properties |
The properties. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithProperties(LoadOption)
Indicates that entities should be loaded with the properties specified by loadOption.
Declaration
public IEntityLoadConfigurationBuilder WithProperties(LoadOption loadOption)Parameters
| Type | Name | Description |
|---|---|---|
| LoadOption | loadOption |
The load option. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithProperties(params string[])
Indicates that entities should be loaded with the specified properties.
Declaration
public IEntityLoadConfigurationBuilder WithProperties(params string[] properties)Parameters
| Type | Name | Description |
|---|---|---|
| string | properties |
The properties. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithProperty(string)
Indicates that entities should be loaded with the specified property.
Declaration
public IEntityLoadConfigurationBuilder WithProperty(string property)Parameters
| Type | Name | Description |
|---|---|---|
| string | property |
The property. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelation(string, RelationRole?)
Indicates that entities should be loaded with the specified relation in the specified role.
Declaration
public IEntityLoadConfigurationBuilder WithRelation(string relation, RelationRole? role)Parameters
| Type | Name | Description |
|---|---|---|
| string | relation |
The relation. |
| RelationRole | role |
The role. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelation(string)
Indicates that entities should be loaded with the specified relation.
Declaration
public IEntityLoadConfigurationBuilder WithRelation(string relation)Parameters
| Type | Name | Description |
|---|---|---|
| string | relation |
The relations. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelations(IEnumerable<RelationSpecification>)
Indicates that entities should be loaded with the relations specified by specifications.
Declaration
public IEntityLoadConfigurationBuilder WithRelations(IEnumerable<RelationSpecification> specs)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>RelationSpecification | specs |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelations(IEnumerable<string>)
Indicates that entities should be loaded with the specified relations.
Declaration
public IEntityLoadConfigurationBuilder WithRelations(IEnumerable<string> relations)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | relations |
The relations. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelations(LoadOption)
Indicates that entities should be loaded with the properties specified by loadOption.
Declaration
public IEntityLoadConfigurationBuilder WithRelations(LoadOption loadOption)Parameters
| Type | Name | Description |
|---|---|---|
| LoadOption | loadOption |
The load option. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelations(params RelationSpecification[])
Indicates that entities should be loaded with the relations specified by specifications.
Declaration
public IEntityLoadConfigurationBuilder WithRelations(params RelationSpecification[] specs)Parameters
| Type | Name | Description |
|---|---|---|
| RelationSpecification | specs |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |
WithRelations(params string[])
Indicates that entities should be loaded with the specified relations.
Declaration
public IEntityLoadConfigurationBuilder WithRelations(params string[] relations)Parameters
| Type | Name | Description |
|---|---|---|
| string | relations |
The relations. |
Returns
| Type | Description |
|---|---|
| IEntityLoadConfigurationBuilder |
The builder. |