KeyStringValueAttribute Class

This attribute is used to represent a string value of an enum elements. Unlike StringValueAttribute, this attribute can be used multiple times. Which attribute should be used will be specified by key. Key can't be generic (C# limitation) nor Enum (Attribute params can not be dynamic). Thus it is int.

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.Chat.StringValueAttribute
      CMS.Chat.KeyStringValueAttribute

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 8.2.23

Syntax

public class KeyStringValueAttribute : StringValueAttribute

The KeyStringValueAttribute type exposes the following members.

Constructors

	Name	Description
Public method	KeyStringValueAttribute	Constructor.

Methods

	Name	Description
Public method	ToString	Gets string representation (the same as StringValue). (Inherited from StringValueAttribute.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	IsResourceString	If set to true, StringValue is resolved by ResHelper before returning. (Inherited from StringValueAttribute.)
Public property	Key	Gets or sets Key of this attribute. This key is used later to lookup this attribute in method ToStringValue().
Public property	StringValue	Holds the stringvalue for a value in an enum. (Inherited from StringValueAttribute.)

Examples

enum XXX { [KeyStringValue((int)ChatMessageTypeStringValueUsageEnum.CMSDeskDescription, "chat.system.cmsdesk.leaveroom", IsResourceString = true)] [KeyStringValue((int)ChatMessageTypeStringValueUsageEnum.LiveSiteMessage, "chat.system.userhasleftroom")] LeaveRoom = 2, } XXX.LeaveRoom.ToStringValue((int)ChatMessageTypeStringValueUsageEnum.CMSDeskDescription);