CMSAPIExampleException Class

API example exception might be thrown when something expectedly fails during executing an API example.

Inheritance Hierarchy

System.Object
  System.Exception
    CMS.Base.CMSException
      CMS.UIControls.CMSAPIExampleException

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

Syntax

public class CMSAPIExampleException : CMSException

The CMSAPIExampleException type exposes the following members.

Constructors

	Name	Description
Public method	CMSAPIExampleException	Creates a new CMSAPIExampleException.

Methods

	Name	Description
Public method	Clone	Returns clone of the exception. (Overrides CMSException.Clone().)

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
Protected property	CustomMessage	Custom message. (Inherited from CMSException.)
Public property	Message	Message. (Inherited from CMSException.)
Public property	UIMessage	Message displayed in the UI to the user (Inherited from CMSException.)