Interface ICultureSensitiveProperty

Current version: 4.0

Represents a property where values are mapped to specific cultures.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface ICultureSensitiveProperty : IProperty, IMember, ICultureSensitiveDirtyTracking, IDirtyTracking
Remarks

It is not possible to get or set a value in a culture when that culture was not loaded on the IEntity. It is possible to set values in cultures that are not enabled in M, if they are loaded on the IEntity, but they will not be persisted.

Methods

GetCultures()

Gets all cultures that the property supports. These are always equal to the cultures the IEntity was loaded with.

Declaration
RequestResponse
IList<CultureInfo> GetCultures()
Returns
TypeDescription
IList<>CultureInfo

The cultures (never null).

GetValue(CultureInfo)

Gets the value for a specific culture.

Declaration
RequestResponse
object GetValue(CultureInfo culture)
Parameters
TypeNameDescription
CultureInfoculture

Culture of the value.

Returns
TypeDescription
object

The value or null if it has no value for this culture.

GetValue<T>(CultureInfo)

Gets the value for a specific culture.

Declaration
RequestResponse
T GetValue<T>(CultureInfo culture)
Parameters
TypeNameDescription
CultureInfoculture

Culture of the value.

Returns
TypeDescription
T

The value or null if it has no value for this culture.

Type Parameters
NameDescription
T

Type of the value (preferable nullable).

GetValues()

Gets all values per culture in a non generic way.

Declaration
RequestResponse
IDictionary<CultureInfo, object> GetValues()
Returns
TypeDescription
IDictionary<, >CultureInfoobject

Property values.

Remarks

This method only returns the values in the cultures the IEntity was loaded in.

GetValues<T>()

Gets all values per culture.

Declaration
RequestResponse
IDictionary<CultureInfo, T> GetValues<T>()
Returns
TypeDescription
IDictionary<, >CultureInfo

All property values.

Type Parameters
NameDescription
T

Type of the value (preferable nullable).

Remarks

This method only returns the values in the cultures the IEntity was loaded in.

GetValues<T>(IEnumerable<CultureInfo>)

Gets all values in the requested cultures.

Declaration
RequestResponse
IDictionary<CultureInfo, T> GetValues<T>(IEnumerable<CultureInfo> cultures)
Parameters
TypeNameDescription
IEnumerable<>CultureInfocultures

Cultures to include.

Returns
TypeDescription
IDictionary<, >CultureInfo

All property values in the requested cultures.

Type Parameters
NameDescription
T

Type of the value (preferable nullable).

SetValue(CultureInfo, object)

Sets a value for a specific culture.

Declaration
RequestResponse
void SetValue(CultureInfo culture, object value)
Parameters
TypeNameDescription
CultureInfoculture

Culture of the value.

objectvalue

Value.

Do you have some feedback for us?

If you have suggestions for improving this article,