DialogConfiguration Class

Container class for CMS dialogs parameters which determine the behavior of the dialogs.

Inheritance Hierarchy

System.Object
  CMS.ExtendedControls.DialogConfiguration

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

Syntax

public class DialogConfiguration

The DialogConfiguration type exposes the following members.

Constructors

	Name	Description
Public method	DialogConfiguration()	Constructor - creates dialog default configuration.
Public method	DialogConfiguration(Hashtable)	Constructor - creates dialog configuration from the parameters.

Methods

	Name	Description
Public method	Clone	Clones current dialog configuration.
Public method Static member	GetDialogConfiguration	Returns dialog configuration from current query string.

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	AdditionalQueryParameters	Additional query parameters appended to URL generated for current config.
Public property	AttachmentDocumentID	ID of the existing document the attachment should be uploaded to.
Public property	AttachmentFormGUID	GUID of the form the temporary attachment should be uploaded to before the document is created.
Public property	AttachmentParentID	Parent ID of the document the attachment should be added to.
Public property	ContentSelectedSite	Name of the selected site on the 'Content' tab.
Public property	ContentSites	Indicates which content sites are available.
Public property	ContentStartingPath	Starting path of the content tree on the 'Content' tab.
Public property	ContentUseRelativeUrl	Indicates whether returned URL should be relative.
Public property	Culture	Culture the dialog works with.
Public property	CustomFormatCode	Code of the custom output format.
Public property	DialogHeight	Height of the dialog.
Public property	DialogWidth	Width of the dialog.
Public property	EditorClientID	Client id of editor area where content should be inserted.
Public property	HideAnchor	Indicates if 'Anchor' tab should be hidden.
Public property	HideAttachments	Indicates if 'Attachments' tab should be hidden.
Public property	HideContent	Indicates if 'Content' tab should be hidden.
Public property	HideEmail	Indicates if 'E-mail' tab should be hidden.
Public property	HideLibraries	Indicates if 'Media libraries' tab should be hidden.
Public property	HideWeb	Indicates if 'Web' tab should be hidden.
Public property	LibGlobalLibraries	Indicates which global media libraries are available.
Public property	LibGlobalLibraryName	Name of the available global media library. Set when only one global media library should be available.
Public property	LibGroupLibraries	Indicates which group media libraries are available.
Public property	LibGroupLibraryName	Name of the available group media library. Set when only one group media library should be available.
Public property	LibGroupName	Name of the available group. Set when only one group should be available.
Public property	LibGroups	Indicates which groups are available.
Public property	LibSelectedSite	Name of the selected site on the 'Media libraries' tab.
Public property	LibSites	Indicates which media library sites are available.
Public property	LibStartingPath	Starting path of the media library folder tree.
Public property	MetaFileCategory	Object category that, together with MetaFileObjectID and MetaFileObjectType, specifies object where metafiles should be uploaded to.
Public property	MetaFileObjectID	ID that, together with MetaFileObjectType and MetaFileCategory, specifies object where metafiles should be uploaded to.
Public property	MetaFileObjectType	Object type that, together with MetaFileObjectID and MetaFileCategory, specifies object where metafiles should be uploaded to.
Public property	OutputFormat	Dialog output format.
Public property	ResizeToHeight	New image height after it is uploaded.
Public property	ResizeToMaxSideSize	New image max side size after it is uploaded.
Public property	ResizeToWidth	New image width after it is uploaded.
Public property	SelectableContent	Dialog selectable content.
Public property	UseFullURL	Indicates if absolute URL should be used in dialogs.
Public property	UseRelativeDimensions	Indicates if dialog width/height are set as relative to the total width/height of the screen.
Public property	UseSimpleURLProperties	If set to true, dialog will not display input fields for specifying size and alt text of image. Default is false, which means that size inputs will be displayed or hidden according to other settings.