CMSDialogHelper Class

Class providing helper methods for CMS dialogs.

Inheritance Hierarchy

System.Object
  CMS.ExtendedControls.CMSDialogHelper

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

Syntax

public class CMSDialogHelper

The CMSDialogHelper type exposes the following members.

Constructors

	Name	Description
Public method	CMSDialogHelper

Methods

	Name	Description
Public method Static member	EncodeQueryString	Encodes query string.
Public method Static member	EscapeArgument	Escapes special characters for artgument.
Public method Static member	EscapeUrlParameter	Escapes url parameter special characters.
Public method Static member	GetAnchorItem	Gets JavaScript object representing anchor item being inserted.
Public method Static member	GetAVItem	Gets JavaScript object representing audio/video item being inserted.
Public method Static member	GetDialogItem	Returns object javascript for insert into wysiwyg editor.
Public method Static member	GetDialogQueryString(DialogConfiguration)	Returns query string which will be passed to the CMS dialogs (Insert image or media/Insert link).
Public method Static member	GetDialogQueryString(DialogConfiguration, Boolean)	Returns query string which will be passed to the CMS dialogs (Insert image or media/Insert link).
Public method Static member	GetDialogUrl(DialogConfiguration, Boolean)	Returns complete URL according to the dialog configuration.
Public method Static member	GetDialogUrl(DialogConfiguration, Boolean, Boolean)	Returns complete URL according to the dialog configuration.
Public method Static member	GetDialogUrl(DialogConfiguration, Boolean, Boolean, String)	Returns complete URL according to the dialog configuration.
Public method Static member	GetDialogUrl(DialogConfiguration, Boolean, Boolean, String, Boolean)	Returns complete URL according to the dialog configuration.
Public method Static member	GetDialogViewMode(String)	Returns dialog view mode enumeration from its string representation.
Public method Static member	GetDialogViewMode(DialogViewModeEnum)	Returns string representation of specified dialog view mode.
Public method Static member	GetEmailItem	Gets JavaScript object representing email item being inserted.
Public method Static member	GetFileSystemItem	Gets JavaScript object representing file system item being inserted.
Public method Static member	GetFlashItem	Gets JavaScript object representing image item being inserted.
Public method Static member	GetHashTableFromString	Returns hashtable parsed from string.
Public method Static member	GetImageItem	Gets JavaScript object representing image item being inserted.
Public method Static member	GetLinkItem	Gets JavaScript object representing link item being inserted.
Public method Static member	GetListFromString	Returns array list from input string.
Public method Static member	GetMediaData	Returns Media data according to given URL.
Public method Static member	GetMediaSource(String)	Converts string into MediaSourceEnum.
Public method Static member	GetMediaSource(MediaSourceEnum)	Converts MediaSourceEnum into string.
Public method Static member	GetMediaType(String)	Converts string into MediaTypeEnum.
Public method Static member	GetMediaType(MediaTypeEnum)	Converts MediaTypeEnum into string.
Public method Static member	GetMediaTypeByExt	Returns MediaTypeEnum based on item's extension.
Public method Static member	GetNoItemsMessage	Gets info message for the specified dialog and source type displayed when no file exists.
Public method Static member	GetOutputFormat	Returns output format enumeration.
Public method Static member	GetSelectableContent(String)	Converts string into SelectableContentEnum.
Public method Static member	GetSelectableContent(SelectableContentEnum)	Converts SelectableContentEnum into string.
Public method Static member	GetSelectItemMessage	Gets info message for the specified dialog and source type displayed when no file is selected.
Public method Static member	GetThumbImageDimensions	Gets thumbnail preview image dimensions.
Public method Static member	GetUrlItem	Gets JavaScript object representing url item being inserted.
Public method Static member	GetYouTubeItem	Gets JavaScript object representing you tube item being inserted.
Public method Static member	IsImageLink	Returns true if link url is not for image full size, returns false if link is image full size url.
Public method Static member	IsItemSelectable(SelectableContentEnum, String)	Indicates whether the file with specified extension is selectable according specified condition.
Public method Static member	IsItemSelectable(SelectableContentEnum, String, Boolean)	Indicates whether the file with specified extension is selectable according specified condition.
Public method Static member	RegisterDialogHelper	Ensures registration of dialog helper JavaScript.
Public method Static member	UnEscapeArgument	Unescapes special characters for artgument.
Public method Static member	UpdateUrl(Int32, Int32, Int32, Int32, String, MediaSourceEnum)	Returns URL updated according specified properties.
Public method Static member	UpdateUrl(Int32, Int32, Int32, Int32, String, MediaSourceEnum, Boolean)	Returns URL updated according specified properties.

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 Static member	GuidReg	GUID regular expresion.