Stylelabs.M.Framework.Essentials.LoadOptions

API reference
SDK reference

Class PropertyLoadOption

Specifies which properties to load.

Inheritance

object

PropertyLoadOption

Implements

IPropertyLoadOption

ILoadOption

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

Assembly: Stylelabs.M.Sdk.dll

Syntax

public class PropertyLoadOption : IPropertyLoadOption, ILoadOption

Constructors

PropertyLoadOption()

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

Declaration

public PropertyLoadOption()

PropertyLoadOption(IEnumerable)

Initializes a new instance of the PropertyLoadOption class.

Declaration

public PropertyLoadOption(IEnumerable<string> propertyNames)

Parameters

Type	Name	Description
IEnumerable<>string	propertyNames	Property names.

PropertyLoadOption(LoadOption)

Initializes a new instance of the PropertyLoadOption class.

Declaration

public PropertyLoadOption(LoadOption loadOption)

Parameters

Type	Name	Description
LoadOption	loadOption	A LoadOption.

PropertyLoadOption(params string[])

Initializes a new instance of the PropertyLoadOption class.

Declaration

public PropertyLoadOption(params string[] propertyNames)

Parameters

Type	Name	Description
string	propertyNames	Property names.

Properties

All

Gets all properties.

Declaration

public static IPropertyLoadOption All { get; }

Property Value

Type	Description
IPropertyLoadOption

LoadOption

Gets or sets the load option.

Declaration

public LoadOption LoadOption { get; set; }

Property Value

Type	Description
LoadOption

None

Gets no properties.

Declaration

public static IPropertyLoadOption None { get; }

Property Value

Type	Description
IPropertyLoadOption

Properties

Gets or sets a list of property names (case insensitive) that need to be loaded. This is only useful when LoadOption is Custom.

Declaration

public string[] Properties { get; set; }

Property Value

Type	Description
string

Methods

DeepClone()

Creates a deep clone of this instance.

Declaration

public IPropertyLoadOption DeepClone()

Returns

Type	Description
IPropertyLoadOption	The property load option.

DeepEquals(IPropertyLoadOption)

Checks if this instance of IPropertyLoadOption is equal to other.

Declaration

public bool DeepEquals(IPropertyLoadOption other)

Parameters

Type	Name	Description
IPropertyLoadOption	other	The property load option.

Returns

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

Implements

IPropertyLoadOption

ILoadOption

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