Class EntityLoadConfiguration

Version: 4.0

Represents a loading configuration for loading entities.

Inheritance
object
EntityLoadConfiguration
Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadConfigurations
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public class EntityLoadConfiguration : IEntityLoadConfiguration

Constructors

EntityLoadConfiguration()

Initializes a new instance of the EntityLoadConfiguration class.

Declaration
RequestResponse
public EntityLoadConfiguration()

EntityLoadConfiguration(ICultureLoadOption, IPropertyLoadOption, IRelationLoadOption)

Initializes a new instance of the EntityLoadConfiguration class.

Declaration
RequestResponse
public EntityLoadConfiguration(ICultureLoadOption cultureOption, IPropertyLoadOption propertyOption, IRelationLoadOption relationOption)
Parameters
TypeNameDescription
ICultureLoadOptioncultureOption

Culture load option.

IPropertyLoadOptionpropertyOption

Property load option.

IRelationLoadOptionrelationOption

Relation load option.

Properties

CultureLoadOption

Gets or sets the culture load option.

Declaration
RequestResponse
public ICultureLoadOption CultureLoadOption { get; set; }
Property Value
TypeDescription
ICultureLoadOption

Default

Gets the entity in the default culture, with all properties and no relations.

Declaration
RequestResponse
public static IEntityLoadConfiguration Default { get; }
Property Value
TypeDescription
IEntityLoadConfiguration

DefaultCultureFull

Gets the entity in default culture, with all properties and all relations.

Declaration
RequestResponse
public static IEntityLoadConfiguration DefaultCultureFull { get; }
Property Value
TypeDescription
IEntityLoadConfiguration

Full

Gets the entity in all installed cultures, with all properties and all relations.

Declaration
RequestResponse
public static IEntityLoadConfiguration Full { get; }
Property Value
TypeDescription
IEntityLoadConfiguration

Minimal

Gets teh entity only with system entity properties.

Declaration
RequestResponse
public static IEntityLoadConfiguration Minimal { get; }
Property Value
TypeDescription
IEntityLoadConfiguration

PropertyLoadOption

Gets or sets the property load option.

Declaration
RequestResponse
public IPropertyLoadOption PropertyLoadOption { get; set; }
Property Value
TypeDescription
IPropertyLoadOption

RelationLoadOption

Gets or sets the relation load option.

Declaration
RequestResponse
public IRelationLoadOption RelationLoadOption { get; set; }
Property Value
TypeDescription
IRelationLoadOption

Methods

Builder()

Creates a IEntityLoadConfigurationBuilder from the current IEntityLoadConfiguration. The builder can extend or overwrite the configuration of the current IEntityLoadConfiguration.

Declaration
RequestResponse
public IEntityLoadConfigurationBuilder Builder()
Returns
TypeDescription
IEntityLoadConfigurationBuilder

The entity load configuration builder.

DeepClone()

Creates a deep clone of this instance.

Declaration
RequestResponse
public IEntityLoadConfiguration DeepClone()
Returns
TypeDescription
IEntityLoadConfiguration

The entity load configuration.

DeepEquals(IEntityLoadConfiguration)

Checks if this instance of IEntityLoadConfiguration is equal to other.

Declaration
RequestResponse
public bool DeepEquals(IEntityLoadConfiguration other)
Parameters
TypeNameDescription
IEntityLoadConfigurationother

The entity load configuration.

Returns
TypeDescription
bool

langword_csharp_True if the instances are equal; otherwise langword_csharp_False.

Implements

Do you have some feedback for us?

If you have suggestions for improving this article,