ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - HTML Editor - Server side

Obout.Ajax.UI.HTMLEditor.EditorPopupHolder class

 Inheritance Hierarchy

<%@ Register Assembly="Obout.Ajax.UI" Namespace="Obout.Ajax.UI.HTMLEditor" TagPrefix="obout" %>

Container for a collection of Popups.Popup objects.
This container is used in the Editor control if the PopupHolderID property is not set.
If you want to change the properties of some popups, place them with altered properties into this container.

Example:
<obout:Editor runat="server" id="editor" Height="400px" Width="100%" >
    <PopupHolder>
        <Preload>
            <obout:SpellCheckPopup ID="mySpellChecker" runat="server" CustomDictionaryOnServer="true">
                <Dictionaries>
                    <obout:SpellCheckDictionary FileName="en-US.dic" DisplayName="English(US)" />
                    <obout:SpellCheckDictionary FileName="en-GB.dic" DisplayName="English(GB)" />
                </Dictionaries>
            </obout:SpellCheckPopup>
        </Preload>
    </PopupHolder>
</obout:Editor />

Properties

Name Description
propertyChangingOnLoad Bool. Gets or sets a value indicating whether some control's properties could be changed in the Page's 'OnLoad' event handler. (Inherited from Popup Holder.)
Default false.
propertyClientID String. Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
propertyDefaultAddPolicy PopupHolderAddPolicy overriden. Gets or sets the default policy of popups adding. (Inherited from Popup Holder.)
Default PopupHolderAddPolicy.Demand.
propertyDemand Collection<Popups.Popup>. Gets the popups collection subscribed for load on demand. (Inherited from Popup Holder.)
Default empty.
propertyDemandTemplate String. Gets or sets the file name of the template with the popups on demand. (Inherited from Popup Holder.)
Popups described in this template will be loaded on demand to this PopupHolder control.

Example:
DemandTemplate="~/App_Obout/HTMLEditor/XML/DemandPopups1.xml"

If the file extension is absent then .xml extension will be used by default.

Example:
DemandTemplate="~/App_Obout/HTMLEditor/XML/DemandPopups1"

Also you can use the file name only without path prefix. In this case the value of the TemplatesFolder property will be used as the path prefix (default "~/App_Obout/HTMLEditor/XML/").

Full example:
DemandTemplate="DemandPopups1"

Example of the template XML file:

<DemandPopups>

<!-- Change some default properties of the Spell Checker -->

<popup name="SpellCheckPopup" >

<!-- Keep custom dictionary on the server -->

<property name="CustomDictionaryOnServer" value="true" />

<!-- Define dictionaries to use -->

<collection name="Dictionaries">

<!-- American dictionary -->

<SpellCheckDictionary>

<property name="FileName" value="en-US.dic" />

<property name="DisplayName" value="English(US)" />

</SpellCheckDictionary>

<!-- Great Britain dictionary -->

<SpellCheckDictionary>

<property name="FileName" value="en-GB.dic" />

<property name="DisplayName" value="English(GB)" />

</SpellCheckDictionary>

</collection>

</popup>

<!--The Image browser will generate absolute URL for selected image-->

<popup name="ImageBrowser" >

<property name="RelativeUrl" value="false" />

</popup>

</DemandPopups>
propertyDraggablePopups Bool. Gets or sets a value indicating whether the popups in this holder are draggable. (Inherited from Popup Holder.)
Default true.
propertyID String. Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
propertyKeepPaternity Bool. Gets or sets a value indicating whether to keep paternity (this holder) of popups on open. (Inherited from Popup Holder.)
Default false.
propertyOnClientPopupStateChanged String. Gets or sets the name of client-side function(handler) executed on popup state changed. (Inherited from Popup Holder.)
This handler is added to the client-side event popupStateChanged, see Client-Side.
propertyPopupsZIndex Int. Gets or sets the starting z-index for all popups in this holder. (Inherited from Popup Holder.)
Default 10000.
propertyPreload Collection<Popups.Popup>. Gets the popups collection subscribed for preload. (Inherited from Popup Holder.)
By default it contain the following popups:
ColorPickerPopup, SpecialCharacters, Icons

If the PreloadTemplate property is set, then this collection is overriden with the popups described in the template.
propertyPreloadTemplate String. Gets or sets the file name of the template with the preloaded popups. (Inherited from Popup Holder.)
Popups described in this template will be preloaded to this PopupHolder control.

Example:
PreloadTemplate="~/App_Obout/HTMLEditor/XML/PreloadedPopups1.xml"

If the file extension is absent then .xml extension will be used by default.

Example:
PreloadTemplate="~/App_Obout/HTMLEditor/XML/PreloadedPopups1"

Also you can use the file name only without path prefix. In this case the value of the TemplatesFolder property will be used as the path prefix (default "~/App_Obout/HTMLEditor/XML/").

Full example:
PreloadTemplate="PreloadedPopups1"

Example of the template XML file:

<PreloadedPopups> 
    <popup name="ColorPickerPopup" />
    <popup name="SpecialCharacters" />
    <popup name="Icons" />
</PreloadedPopups>
propertyProgressImage String. Gets or sets the path of the 'progress' image used while a popup is loading. (Inherited from Popup Holder.)
By default the embedded image is used.

Example: "~/images/progress.gif"
propertyRetainPopupPosition Bool. Gets or sets a value indicating whether to retain popup's position before its closing and restore it when you reopen the popup. (Inherited from Popup Holder.)
If this property is set to false, then popups will be positioned to the center of the screen on each opening.
This behavior applies to all popups that belong to this PopupHolder control.
Default true.
propertyTemplatesFolder String. Gets or sets the Url of the default templates folder. (Inherited from Popup Holder.)
Default "~/App_Obout/HTMLEditor/XML/"

"Compliments regarding your products, our firm likes them so much."

Marco Carminati
Disc spa

Random testimonial   All testimonials

Products Downloads