Stylelabs.M.Framework.Essentials.LoadOptions

API reference
SDK reference

Class RelationLoadOption

Specifies which relations to load.

Inheritance

object

RelationLoadOption

Implements

IRelationLoadOption

ILoadOption

Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadOptions

Assembly: Stylelabs.M.Sdk.dll

Syntax

public class RelationLoadOption : IRelationLoadOption, ILoadOption

Constructors

RelationLoadOption()

Initializes a new instance of the RelationLoadOption class. Defaults to LoadOption.None .

Declaration

public RelationLoadOption()

RelationLoadOption(IEnumerable)

Initializes a new instance of the RelationLoadOption class.

Declaration

public RelationLoadOption(IEnumerable<RelationSpecification> specs)

Parameters

Type	Name	Description
IEnumerable<>RelationSpecification	specs	Relation specifications.

RelationLoadOption(IEnumerable)

Initializes a new instance of the RelationLoadOption class.

Declaration

public RelationLoadOption(IEnumerable<string> relationNames)

Parameters

Type	Name	Description
IEnumerable<>string	relationNames	Relation names.

RelationLoadOption(LoadOption)

Initializes a new instance of the RelationLoadOption class.

Declaration

public RelationLoadOption(LoadOption loadOption)

Parameters

Type	Name	Description
LoadOption	loadOption	A LoadOption.

RelationLoadOption(params RelationSpecification[])

Initializes a new instance of the RelationLoadOption class.

Declaration

public RelationLoadOption(params RelationSpecification[] specs)

Parameters

Type	Name	Description
RelationSpecification	specs	Relation specifications.

RelationLoadOption(params string[])

Initializes a new instance of the RelationLoadOption class.

Declaration

public RelationLoadOption(params string[] relationNames)

Parameters

Type	Name	Description
string	relationNames	Relation names.

Properties

All

Gets all relations.

Declaration

public static IRelationLoadOption All { get; }

Property Value

Type	Description
IRelationLoadOption

LoadOption

Gets or sets the load option.

Declaration

public LoadOption LoadOption { get; set; }

Property Value

Type	Description
LoadOption

None

Gets no relations.

Declaration

public static IRelationLoadOption None { get; }

Property Value

Type	Description
IRelationLoadOption

Relations

Gets or sets a list of relations that need to be loaded. This is only useful when LoadOption is Custom.

Declaration

public IRelationSpecification[] Relations { get; set; }

Property Value

Type	Description
IRelationSpecification

Methods

DeepClone()

Creates a deep clone of this instance.

Declaration

public IRelationLoadOption DeepClone()

Returns

Type	Description
IRelationLoadOption	The relation load option.

DeepEquals(IRelationLoadOption)

Checks if this instance of IRelationLoadOption is equal to other.

Declaration

public bool DeepEquals(IRelationLoadOption other)

Parameters

Type	Name	Description
IRelationLoadOption	other	The relation load option.

Returns

Type	Description
bool	langword_csharp_True if the instances are equal; otherwise langword_csharp_False.

Implements

IRelationLoadOption

ILoadOption

If you have suggestions for improving this article, let us know!