BWA Client API
AdvantageCMS.Core.Admin Namespace
AdvantageCMS.Core.Admin.Authentication Namespace
AdvantageCMS.Core.Admin.BaseClasses Namespace
AdvantageCMS.Core.Admin.BaseClasses.ControlSettings Namespace
AdvantageCMS.Core.Admin.BusinessEntity Namespace
AdvantageCMS.Core.Admin.Engine Namespace
AdvantageCMS.Core.Admin.Enums Namespace
AdvantageCMS.Core.Admin.Event Namespace
AdvantageCMS.Core.Admin.Interfaces Namespace
AdvantageCMS.Core.Common Namespace
AdvantageCMS.Core.Common.AsyncJob Namespace
AdvantageCMS.Core.Common.BaseClasses Namespace
AdvantageCMS.Core.Common.BaseClasses.Handler Namespace
AdvantageCMS.Core.Common.BaseClasses.Webhook Namespace
AdvantageCMS.Core.Common.BusinessEntity Namespace
AdvantageCMS.Core.Common.Engine Namespace
AdvantageCMS.Core.Common.Enums Namespace
AdvantageCMS.Core.Common.Extension Namespace
AdvantageCMS.Core.Common.Interfaces Namespace
AdvantageCMS.Core.Common.SitemapGenerator Namespace
AdvantageCMS.Core.Keyoti Namespace
AdvantageCMS.Core.Resource Namespace
AdvantageCMS.Core.Routing Namespace
AdvantageCMS.Core.SMTP Namespace
AdvantageCMS.Core.Utils Namespace
AdvantageCMS.Core.Utils.Cache Namespace
AdvantageCMS.Core.Utils.Cache.Containers Namespace
AdvantageCMS.Core.Utils.Parser Namespace
AdvantageCMS.Data Namespace
AdvantageCMS.Data.Interfaces Namespace
AdvantageCMS.Web.UI Namespace
AdvantageCMS.Web.UI.Admin Namespace
AdvantageCMS.Web.UI.Admin.Selectors Namespace
AdvantageCMS.Web.UI.Admin.Tools Namespace
AdvantageCMS.Web.UI.Helpers Namespace
AdvantageCSP.AdvantageAPI Namespace
AdvantageCSP.API Namespace
AdvantageCSP.API.BaseClasses Namespace
AdvantageCSP.API.Classes Namespace
AdvantageCSP.Core.HierarchicalList Namespace
AdvantageCSP.HierarchicalModelDataSource Namespace
AdvantageCSP.Keyoti.SiteIndexer Namespace
AdvantageCSP.Snipcart Namespace
AdvantageCSP.Snipcart.Engine Namespace
AdvantageCSP.Snipcart.Enums Namespace
AdvantageCSP.Snipcart.Interfaces Namespace
Build With Advantage

Enum<(Of <(<'T>)>)>..::..FromDescription Method

Converts a description string back to the corresponding enum value by matching against LocalDescription, DescriptionAttribute, and enum member names.

Namespace:  AdvantageCMS.Core.Common.Extension
Assembly:  AdvantageCMS.Core (in AdvantageCMS.Core.dll)

Syntax

public static T FromDescription(
	string description,
	string cultureCode
)

Parameters

description
Type: String
The description string to match.
cultureCode
Type: String
Optional culture code for culture-specific matching.

Return Value

The enum value whose description matches the specified string.

Exceptions

ExceptionCondition
ArgumentNullExceptionThrown when description is null or whitespace.
ArgumentExceptionThrown when no matching enum value is found.

Examples

C#
// Given: [Description("Bad Entry")] Bad = 2
var value = Enum<eExampleEnum>.FromDescription("Bad Entry"); // returns eExampleEnum.Bad

// With culture-specific lookup:
var spanish = Enum<eExampleEnum>.FromDescription("Mala entrada", "es-MX"); // returns eExampleEnum.Bad

See Also

Enum<(Of <(<'T>)>)> Class
AdvantageCMS.Core.Common.Extension Namespace