Version

DialogModel Class Members

The following tables list the members exposed by DialogModel.

Public Constructors
 NameDescription
Public ConstructorDialogModel ConstructorCreate DialogModel  
Public Properties
 NameDescription
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyCloseAnimationSets animation applied to dialog when it is closed.

That can be any value supported by jquery hide(param) method.

 
Public PropertyCloseButtonTitleSets title for close button in header of dialog.  
Public PropertyCloseOnEscapeSets ability to close dialog when it has focus and Esc key was pressed.  
Public PropertyContainerSets jquery selector for html element, which will be used as container for dialog.

Dialog will be locked in bounds of that container. That includes not only dragging/resizing, but also maximized state.

 
Public PropertyContentHTMLSets the HTML which is used as content for the dialog.

Notes:

1. The content of dialog is built by $("<div id=" + ID + ">" + value + "</div>").

2. That property has priority over possible ContentID and ContentJquerySelector. 3. The single quote character is not supported within html. The double quote should be used instead.

 
Public PropertyContentIDSets the ID of html element which is used as content for the dialog.

Notes:

1. The content of dialog is built by $("#" + value).

2. That property has priority over ContentJquerySelector.

3. The ContentHTML has priority over that property.

4. The ID property is not used.

 
Public PropertyContentJquerySelectorSets the jquery selector which is used as content for the dialog.

Notes:

1. The content of dialog is built by $(value).

2. The ContentHTML and ContentID have priority over that property. 3. The ID property is not used.

 
Public PropertyDialogClassSets name of css class which is applied to the main DIV element of dialog.  
Public PropertyDraggableSets ability to change location of dialog by mouse drag over header.  
Public PropertyEnableDblclickSets ability to change state of dialog by dblclick on header. Dialog will be maximized if its state was normal, or dialog state will be set to normal if it was maximized, or dialog state will be set to normal if it was minimized. Default value is null which is equivalent to the "auto" flag.  
Public PropertyEnableHeaderFocusSets ability to adjust state of header depending on focused and not-focused states.

Note: the TrackFocus should be enabled.

 
Public PropertyFooterTextSets text which appears in footer of dialog.  
Public PropertyHeaderTextSets text which appears in header of dialog.  
Public PropertyHeightSets initial height of dialog.

Number and valid html size-units can be used.

 
Public PropertyHtmlAttributesSets custom attributes for main html element used by control

Dictionary of attributes passed to TagBuilder.MergeAttributes(value).

 
Public PropertyIDSets the ID of the dialog.

Note: that property has no effect if ContentJquerySelector or ContentID is set.

 
Public PropertyImageClassSets name of css class which is applied to the SPAN element located on the left side of header.  
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLocaleGets/sets the Locale of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyMaxHeightSets maximum height of dialog in pixels.  
Public PropertyMaximizeButtonTitleSets title for maximize button in header of dialog.  
Public PropertyMaxWidthSets maximum width of dialog in pixels.  
Public PropertyMinHeightSets minimum height of dialog in pixels.  
Public PropertyMinimizeButtonTitleSets title for minimize button in header of dialog.  
Public PropertyMinWidthSets minimum width of dialog in pixels.  
Public PropertyModalSets modal functionality of dialog.  
Public PropertyOpenAnimationSets animation applied to dialog when it is opened.

That can be any value supported by jquery show(param) method.

 
Public PropertyPinButtonTitleSets title for pin button in header of dialog.  
Public PropertyPinnedSets pinned state of dialog.  
Public PropertyPinOnMinimizedSets ability to automatically pin dialog, when it was minimized.  
Public PropertyPositionSets javascript statement which defines initial position of dialog. That can be value supported by jquery.position or it can be "[x, y]", where numeric x and y reresent left and top corners of dialog.  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyResizableSets ability to resize dialog by mouse drag over edges of dialog.  
Public PropertyRestoreButtonTitleSets title for restore button in header of dialog.  
Public PropertyShowCloseButtonSets visibility of close button in header of dialog.  
Public PropertyShowFooterSets visibility of footer.  
Public PropertyShowHeaderSets visibility of header.  
Public PropertyShowMaximizeButtonSets visibility of maximized button in header of dialog.  
Public PropertyShowMinimizeButtonSets visibility of minimized button in header of dialog.  
Public PropertyShowPinButtonSets visibility of pin button in header of dialog.  
Public PropertyStateSets state of dialog.  
Public PropertyTabIndexSets tabIndex attribute to dialog.  
Public PropertyTemporaryUrlSets temporary value for src, which is used while changing parent of base element if it is instance of IFRAME. That is allows to get around possible javascript exceptions under IE. That property has effect only when ContentID or ContentJquerySelector or ContentHTML point to IFRAME.  
Public PropertyTrackFocusSets ability to process focus and blur events of child elements located in dialog in order to maintain focused state.  
Public PropertyUnpinButtonTitleSets title for unpin button in header of dialog.  
Public PropertyWidthSets initial width of dialog.

Number and valid html size-units can be used.

 
Public PropertyZIndexSets zIndex attribute to dialog.  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public MethodSetLeftTopSets initial position of dialog. That is a wrapper for Position("[" + left + "," + top + "]").  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreSerializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub