SettingsKeyName Class

Represents the settings key name.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SettingsKeyName

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

Syntax

public class SettingsKeyName

The SettingsKeyName type exposes the following members.

Constructors

	Name	Description
Public method	SettingsKeyName(String)	Constructor
Public method	SettingsKeyName(String, SiteInfoIdentifier)	Constructor

Methods

	Name	Description
Public method	ToString	Returns the fully qualified key name in format "[site name].[key name]" or "[key name]" for global setting. (Overrides Object.ToString().)

Operators

	Name	Description
Public operator Static member	Implicit(String to SettingsKeyName)	Implicitly converts the specified SettingsKeyName string representation to a SettingsKeyName instance.
Public operator Static member	Implicit(SettingsKeyName to String)	Implicitly converts the specified SettingsKeyName instance to it's string representation.

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.)

Fields

	Name	Description
Public field	KeyName	Key name
Public field	SiteName	Site name

Properties

	Name	Description
Public property	IsGlobal	Gets a value that indicates if the settings key name is global (i.e. site name is not specified).