ASP.NET 3.5 and above only

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

Obout.Ajax.UI.HTMLEditor.Popups.Popup abstract class

 Inheritance Hierarchy

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

Base class for all popups in Obout.Ajax.UI.HTMLEditor.Popups namespace.

Public properties

Name Description
propertyAdditionalCss String. Gets or sets comma separated paths of additional CSS files for this popup.
propertyAutoDimensions Bool overridable. Gets or sets a value indicating whether the size of the popup is determining automatically.
Default true.
propertyClientID String. Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
propertyCssPath String. Gets or sets a style file path.
By default embedded CSS file is used.
propertyID String. Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
propertyOnClientBeforeHidden String. Gets or sets the name of client-side function(handler) executed before the popup is hidden.
This handler is added to the client-side event beforeHidden, see Client-Side.
propertyOnClientBeforeShown String. Gets or sets the name of client-side function(handler) executed before the popup is shown.
This handler is added to the client-side event beforeShown, see Client-Side.
propertyOnClientHidden String. Gets or sets the name of client-side function(handler) executed when the popup is hidden.
This handler is added to the client-side event hidden, see Client-Side.
propertyOnClientShown String. Gets or sets the name of client-side function(handler) executed when the popup is shown.
This handler is added to the client-side event shown, see Client-Side.

Protected properties

Name Description
propertyAttachedToButton Bool overridable. Gets a value indicating whether the popup is 'attached' to a button called this popup.
Default true.

Example of 'attached' popup - SpecialCharacters:
propertyAutoClose Bool overridable. Gets a value indicating whether the popup is closed on click outside it.
Default true.

Example of 'attached' popup - SpecialCharacters see above.
propertyClientControlType String overridable. Gets the script type to use for the Control.
propertyContent Collection<Control>. Gets the collection of controls included into the popup.
propertyDefaultTitle String overridable. Gets the popup title if not found in Localization.
Default String.Empty .
propertyRegisteredFields Collection<RegisteredField>. Gets the collection of controls available for use in Client-Side as a field.

Example from the LinkProperties class code:

protected override void DescribeComponent
                                (ScriptComponentDescriptor descriptor)
{
  if (Url != null)
  {
     RegisteredFields.Add(new RegisteredField("url", Url));
  }
  ...
  base.DescribeComponent(descriptor);
}

See also Access to registered in Server-Side fields and handlers.
propertyRegisteredHandlers Collection<RegisteredField>. Gets the collection of controls available for use in Client-Side as a handler.

Example from the LinkProperties class code:

protected override void DescribeComponent
                                (ScriptComponentDescriptor descriptor)
{
  ...
  if (Browse != null)
  {
     RegisteredHandlers.Add(new RegisteredField("browse", Browse));
  }
  ...
  base.DescribeComponent(descriptor);
}

See also Access to registered in Server-Side fields and handlers.
propertyScriptPath String overridable. Gets the path of the script file where the associated script type is defined.

Protected methods

Name Description
propertyGetButton String Returns a value from the active localization resource file.
Parameters:
  • String name - resource "Button" name.
  • String defaultValue - value used by default if the name is not found in the active localization resource file or the localization resource file is not found.
Example:

string _Browse = GetButton("Browse", "...");

In context of LinkProperties class and, if the current localization resource file is "en.resx", it will get the resource named Popups.LinkProperties.Button.Browse: "Browse".
propertyGetField String Returns a value from the active localization resource file.
Parameters:
  • String name - resource "Field" name.
  • String defaultValue - value used by default if the name is not found in the active localization resource file or the localization resource file is not found.
Example:

string _URL = GetField("URL", "...");

In context of LinkProperties class and, if the current localization resource file is "en.resx", it will get the resource named Popups.LinkProperties.Field.URL: "URL".
propertyGetFromResource String Returns a value from the active localization resource file.
Parameters:
  • String name - resource name.
  • String defaultValue - value used by default if the name is not found in the active localization resource file or the localization resource file is not found.
Example:

string emptyUrlMessage = GetFromResource("Message.EmptyUrl", "...");

In context of LinkProperties class and, if the current localization resource file is "en.resx", it will get the resource named Popups.LinkProperties.Message.EmptyUrl: "Link URL can not be empty".
propertyFillContent Void abstract Fills content of the popup.
No parameters.
This method must be overridden in the derived class.

Example:

protected override void FillContent()
{
  HtmlInputHidden input = new HtmlInputHidden();
  input.ID = "dummy";
  preparePicker();
  Content.Add(input);
  Content.Add(ColorPicker);
}

"Obout is the best ;) really enjoy working with it."

Léon Neaimeh
Software Engineer

Random testimonial   All testimonials

Products Downloads