Public Instance Constructors
 PortalModuleControl Constructor | Dafault contructor, initializes default settings |
Public Instance Fields
 ButtonListAdmin | Admin Buttons |
| ButtonListCustom | Custom Buttons |
| ButtonListUser | User Buttons |
| CurrentTheme |
Public Instance Properties
 AddButton | Module Add button |
| AddModuleControl | Override on derivates classes. Return the path of the add control if available. |
| AddTarget | Target frame/page for Add Link |
| AddText | Text for Add Link |
| AddUrl | Url for Add Link |
| AdminModule | Override on derivates class. Return true if the module is an Admin Module. |
| Application (inherited from UserControl) | Gets the Application object for the current Web request. |
| ApplyTheme | Before apply theme DesktopModule designer checks this property to be true. On inherited modules you can override this property to not apply theme on specific controls. |
| AppRelativeTemplateSourceDirectory (inherited from Control) | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. |
| AppRelativeVirtualPath (inherited from TemplateControl) | Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled. |
| ApproveButton | Module Approve button |
| ApproveText | Text for approve link |
| ArePropertiesEditable | Edit properties permission |
| Attributes (inherited from UserControl) | Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file. |
| BackButton | Module button that will return to previous tab |
| BaseSettings | Module base settings defined by control creator |
| BindingContainer (inherited from Control) | Gets the control that contains this control's data binding. |
| ButtonsRenderAs | Determines how ModuleButtons are rendered: as TextOnly, TextAndImage or ImageOnly. ImageOnly is the 'classic' Rainbow style. |
| Cache (inherited from UserControl) | Gets the Cache object that is associated with the application that contains the user control. |
| Cacheable | Override on derived class. Return true if the module is Cacheable. |
| CachePolicy (inherited from UserControl) | Gets a reference to a collection of caching parameters for this user control. |
| CanAdd | Permission for AddButton |
| CanApproveReject | Permission for Approve/Reject Buttons |
| CanArrows | Permission for Arrow Buttons (Up/Down/Left/Right) |
| CanBack | Permission for BackButton |
| CanClose | Close permission |
| CanDeleteModule | Permission for DeleteModuleButton |
| CanEdit | Permission for EditButton |
| CanEmail | Permission for EmailButton |
| CanHelp | Permission for HelpButton |
| CanMinimized | Minimize permission |
| CanPrint | Print permission |
| CanProperties | Permission for Properties Button |
| CanPublish | Permission for Publish Button |
| CanRequestApproval | Permission for ReadyToApprove and Revert Buttons |
| CanSecurity | Permission for Security Button |
| CanVersion | Permission for Version Button |
| ClassName | ClassName (Used for Get/Save: not implemented) |
| ClientID (inherited from Control) | Gets the server control identifier generated by ASP.NET. |
| CloseButton | Module button to close module |
| Content | Will return module content as an object, if called. |
| Controls (inherited from Control) | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. |
| Cultures | The module culture. If specified module should be showed only if current culture matches this setting. Colon separated list |
| DeleteModuleButton | "Delete this Module" button |
| DownButton | Module Down button |
| EditButton | Module edit button |
| EditModuleControl | Override on derivates classes. Return the path of the edit control if available. |
| EditTarget | Target frame/page for Edit Link |
| EditText | Text for Edit Link |
| EditUrl | Url for Edit Link |
| EmailButton | Module button that will launch a pop-up window to allow the module contents to be emailed |
| EnableTheming (inherited from TemplateControl) | Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. |
| EnableViewState (inherited from Control) | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. |
| GuidID | GUID of module (mandatory) |
| HelpButton | Module button that will launch the module help in a pop-up window |
| ID (inherited from Control) | Gets or sets the programmatic identifier assigned to the server control. |
| InnerSupportsWorkflow | This property indicates if the specified module supports workflow. It returns the module property regardless of current module setting. |
| IsAddable | Add permission |
| IsDeleteable | Delete permission |
| IsEditable | Edit permission |
| IsPostBack (inherited from UserControl) | Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time. |
| IsViewable | View permission |
| LeftButton | Module Left button |
| MinMaxButton | Module button to minimize/maximize module |
| ModuleCacheKey | unique key for module caching |
| ModuleConfiguration | Configuration |
| ModuleID | The current ID of the module. Is unique for all portals. |
| ModuleTitle | Inner Title control. Now only used for backward compatibility |
| NamingContainer (inherited from Control) | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. |
| OriginalModuleID | The ID of the orginal module (will be different to ModuleID when using shortcut module) |
| Page | Overloaded. Returns the current page |
| PageID | Stores current linked module ID if applicable |
| pageSettings | Stores current tab settings |
| Parent (inherited from Control) | Gets a reference to the server control's parent control in the page control hierarchy. |
| PortalID | ID of portal in which module is instantiated |
| portalSettings | Stores current portal settings |
| PrintButton | Module button that will launch the module in a pop-up window suitable for printing |
| ProductionVersionText | Text for version Link for swapping to production version |
| PropertiesButton | Module Properties button |
| PropertiesTarget | Target frame/page for Properties Link |
| PropertiesText | Text for Properties Link |
| PropertiesUrl | Url for Properties Link |
| PublishButton | Module Version button |
| PublishText | Text for publish link |
| ReadyToApproveButton | Module ReadyToApprove button |
| ReadyToApproveText | Text for request approval link |
| RejectButton | Module Reject button |
| RejectText | Text for reject link |
| Request (inherited from UserControl) | Gets the HttpRequest object for the current Web request. |
| Response (inherited from UserControl) | Gets the HttpResponse object for the current Web request. |
| RevertButton | Module Revert button |
| RevertText | |
| RightButton | Module Right button |
| Searchable | Override on derivates classes. Return true if the module is Searchable. |
| SecurityButton | Module Security button |
| SecurityTarget | Target frame/page for Security Link |
| SecurityText | Text for Security Link |
| SecurityUrl | Url for Security Link |
| Server (inherited from UserControl) | Gets the HttpServerUtility object for the current Web request. |
| Session (inherited from UserControl) | Gets the HttpSessionStateobject for the current Web request. |
| Settings | Module custom settings |
| ShowBack | Can be set from module code to indicate whether module should display Back button |
| ShowTitle | Switch to turn on/off the display of Title text. |
| ShowTitlePrint | Switch to turn on/off the display of the module title text (not the buttons) in the print pop-up. |
| Site (inherited from Control) | Gets information about the container that hosts the current control when rendered on a design surface. |
| SkinID (inherited from Control) | Gets or sets the skin to apply to the control. |
| StagingVersionText | Text for version Link for swapping to staging version |
| SupportCollapsable | This property indicates if the specified module supports can be collpasable (minimized/maximized/closed) |
| SupportsArrows | This property indicates if the specified module supports arrows to move modules |
| SupportsBack | This property indicates whether the module supports a Back button |
| SupportsEmail | This property indicates if the module supports email |
| SupportsHelp | This property indicates if the specified module supports help |
| SupportsPrint | Override on derived class. Return true if the module supports print in pop-up window. |
| SupportsWorkflow | This property indicates if the specified module workflow is enabled. |
| TemplateControl (inherited from Control) | Gets or sets a reference to the template that contains this control. |
| TemplateSourceDirectory (inherited from Control) | Gets the virtual directory of the Page or UserControl that contains the current server control. |
| TitleText | The module title as it will be displayed on the page. Handles cultures automatically. |
| Trace (inherited from UserControl) | Gets the TraceContext object for the current Web request. |
| UniqueID (inherited from Control) | Gets the unique, hierarchically qualified identifier for the server control. |
| UpButton | Module Up button |
| Version | This property indicates which content will be shown to the user production content or staging content |
| VersionButton | Module Version button |
| Visible (inherited from Control) | Gets or sets a value that indicates whether a server control is rendered as UI on the page. |
| WorkflowStatus | This property indicates the staging content state |
Public Instance Methods
| ApplyStyleSheetSkin (inherited from Control) | Applies the style properties defined in the page style sheet to the control. |
| Commit | Unknown |
| DataBind (inherited from Control) | Overloaded. Binds a data source to the invoked server control and all its child controls. |
| DesignerInitialize (inherited from UserControl) | Performs any initialization steps on the user control that are required by RAD designers. |
| Dispose (inherited from Control) | Enables a server control to perform final clean up before it is released from memory. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| FindControl (inherited from Control) | Overloaded. Searches the current naming container for a server control with the specified id parameter. |
| Focus (inherited from Control) | Sets input focus to a control. |
| GetContent | Used by Content to fetch module content, by raising Init and Load events on the module. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| GetLastModified | Returns the "Last Modified" string, or an empty string if option is not active. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| HasControls (inherited from Control) | Determines if the server control contains any child controls. |
| InitializeAsUserControl (inherited from UserControl) | Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly. |
| Install | Unknown |
| LoadControl (inherited from TemplateControl) | Overloaded. Loads a Control object from a file based on a specified virtual path. |
| LoadData | Load Data |
| LoadTemplate (inherited from TemplateControl) | Obtains an instance of the ITemplate interface from an external file. |
| MapPath (inherited from UserControl) | Assigns a virtual file path, either absolute or relative, to a physical file path. |
| ParseControl (inherited from TemplateControl) | Parses an input string into a Control object on the Web Forms page or user control. |
| ReadStringResource (inherited from TemplateControl) | Reads a string resource. The ReadStringResource method is not intended for use from within your code. |
| RenderControl (inherited from Control) | Overloaded. Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. |
| ResolveClientUrl (inherited from Control) | Gets a URL that can be used by the browser. |
| ResolveUrl (inherited from Control) | Converts a URL into one that is usable on the requesting client. |
| Rollback | Unknown |
| SaveData | Save module data |
| SearchSqlSelect | Searchable module implementation |
| SetRenderMethodDelegate (inherited from Control) | Assigns an event handler delegate to render the server control and its content into its parent control. |
| TestDeviceFilter (inherited from TemplateControl) | Returns a Boolean value indicating whether a device filter applies to the HTTP request. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| Uninstall | Unknown |
Public Instance Events
 AbortTransaction (inherited from TemplateControl) | Occurs when a user ends a transaction. |
| CommitTransaction (inherited from TemplateControl) | Occurs when a transaction completes. |
| DataBinding (inherited from Control) | Occurs when the server control binds to a data source. |
| Disposed (inherited from Control) | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. |
| Error (inherited from TemplateControl) | Occurs when an unhandled exception is thrown. |
| FlushCache | The FlushCache event is defined using the event keyword. The type of FlushCache is EventHandler. |
| Init (inherited from Control) | Occurs when the server control is initialized, which is the first step in its lifecycle. |
| Load (inherited from Control) | Occurs when the server control is loaded into the Page object. |
| PreRender (inherited from Control) | Occurs after the Control object is loaded but prior to rendering. |
| Unload (inherited from Control) | Occurs when the server control is unloaded from memory. |
| Update | The Update event is defined using the event keyword. The type of Update is EventHandler. |
Protected Instance Fields
 _baseSettings | _baseSettings holds datatype information |
| DeleteBtn | Standard content Delete button |
| EditBtn | Standard content Edit button |
| updateButton | Standard content Update button |
Protected Instance Properties
 Adapter (inherited from Control) | Gets the browser-specific adapter for the control. |
| AutoHandlers (inherited from TemplateControl) | Obsolete. The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code. |
| ChildControlsCreated (inherited from Control) | Gets a value that indicates whether the server control's child controls have been created. |
| ClientIDSeparator (inherited from Control) | Gets a character value representing the separator character used in the ClientID property. |
| Events (inherited from Control) | Gets a list of event handler delegates for the control. This property is read-only. |
| HasChildViewState (inherited from Control) | Gets a value indicating whether the current server control's child controls have any saved view-state settings. |
| HasTitle | Return true if module has inner control of type title |
| IdSeparator (inherited from Control) | Gets the character used to separate control identifiers. |
| IsTrackingViewState (inherited from Control) | Gets a value that indicates whether the server control is saving changes to its view state. |
| LoadViewStateByID (inherited from Control) | Gets a value indicating whether the control participates in loading its view state by ID instead of index. |
| SupportAutoEvents (inherited from TemplateControl) | Gets a value indicating whether the TemplateControl control supports automatic events. |
| ViewState (inherited from Control) | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. |
| ViewStateIgnoresCase (inherited from Control) | Gets a value that indicates whether the StateBag object is case-insensitive. |
Protected Instance Methods
 AddParsedSubObject (inherited from Control) | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. |
| Build | Builds the "with theme" versions of the module, with optional Title, Buttons and Body. |
| BuildButtonLists | Builds the three public button lists |
| BuildControlHierarchy | Makes the decisions about what needs to be built and calls the appropriate method |
| BuildNoTheme | Method builds "no theme" version of module. Now obeys ShowTitle and GetLastModified. |
| BuildProfileTree (inherited from Control) | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. |
| BuildShortcut | Builds the shortcut. |
| ClearChildControlState (inherited from Control) | Deletes the control-state information for the server control's child controls. |
| ClearChildState (inherited from Control) | Deletes the view-state and control-state information for all the server control's child controls. |
| ClearChildViewState (inherited from Control) | Deletes the view-state information for all the server control's child controls. |
| Construct (inherited from TemplateControl) | Performs design-time logic. |
| CreateControlCollection (inherited from Control) | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. |
| CreateResourceBasedLiteralControl (inherited from TemplateControl) | Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl method is not intended for use from within your code. |
| DataBind (inherited from Control) | Overloaded. Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. |
| DataBindChildren (inherited from Control) | Binds a data source to the server control's child controls. |
| EnsureChildControls (inherited from Control) | Determines whether the server control contains child controls. If it does not, it creates child controls. |
| EnsureID (inherited from Control) | Creates an identifier for controls that do not have an identifier assigned. |
| Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| FindControl (inherited from Control) | Overloaded. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. |
| FrameworkInitialize (inherited from TemplateControl) | Initializes the control that is derived from the TemplateControl class. |
| GetDesignModeState (inherited from Control) | Gets design-time data for a control. |
| GetGlobalResourceObject (inherited from TemplateControl) | Overloaded. Gets an application-level resource object based on the specified ClassKey and ResourceKey properties. |
| GetLocalResourceObject (inherited from TemplateControl) | Overloaded. Gets a page-level resource object based on the specified ResourceKey property. |
| HasEvents (inherited from Control) | Returns a value indicating whether events are registered for the control or any child controls. |
| IsLiteralContent (inherited from Control) | Determines if the server control holds only literal content. |
| LoadViewState (inherited from UserControl) | Restores the view-state information from a previous user control request that was saved by the SaveViewState method. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
| MergeButtonLists | Merges the three public button lists into one. |
| OnAbortTransaction (inherited from TemplateControl) | Raises the AbortTransaction event. |
| OnBubbleEvent (inherited from Control) | Determines whether the event for the server control is passed up the page's UI server control hierarchy. |
| OnCommitTransaction (inherited from TemplateControl) | Raises the CommitTransaction event. |
| OnDataBinding (inherited from Control) | Raises the DataBinding event. |
| OnDelete | On Delete |
| OnEdit | On Edit |
| OnError (inherited from TemplateControl) | Raises the Error event. |
| OnFlushCache | Handles FlushCache event at Module level Performs FlushCache actions that are common to all Pages Can be overridden |
| OnInit | Raises OnInit event. |
| OnLoad | |
| OnUpdate | Handles OnUpdate event at Page level Performs OnUpdate actions that are common to all Pages Can be overridden |
| OnVersionSwap | On Version Swap |
| Publish | Publish staging to production |
| RaiseBubbleEvent (inherited from Control) | Assigns any sources of the event and its information to the control's parent. |
| RenderControl (inherited from Control) | Overloaded. Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. |
| ResolveAdapter (inherited from Control) | Gets the control adapter responsible for rendering the specified control. |
| RevertToProductionContent | Event handler for Workflow "revert" |
| SaveViewState (inherited from UserControl) | Saves any user control view-state changes that have occurred since the last page postback. |
| SetDesignModeState (inherited from Control) | Sets design-time data for a control. |
| SetStringResourcePointer (inherited from TemplateControl) | Sets a pointer to a string resource. The SetStringResourcePointer method is used by generated classes and is not intended for use from within your code. |
| SetupTheme | Sets the CurrentTheme - allowing custom Theme per module |
| TrackViewState (inherited from Control) | Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. |
| WriteUTF8ResourceString (inherited from TemplateControl) | Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString method is used by generated classes and is not intended for use from within your code. |
| ZenBuild | The Zen version of Build(). Parses XML Zen Module Layout. |
Protected Internal Instance Properties
 Context (inherited from Control) | Gets the HttpContext object associated with the server control for the current Web request. |
| DesignMode (inherited from Control) | Gets a value indicating whether a control is being used on a design surface. |
| IsChildControlStateCleared (inherited from Control) | Gets a value indicating whether controls contained within this control have control state. |
| IsViewStateEnabled (inherited from Control) | Gets a value indicating whether view state is enabled for this control. |
Protected Internal Instance Methods
 AddedControl (inherited from Control) | Called after a child control is added to the Controls collection of the Control object. |
| CreateChildControls (inherited from Control) | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. |
| Eval (inherited from TemplateControl) | Overloaded. Evaluates a data-binding expression. |
| LoadControlState (inherited from Control) | Restores control-state information from a previous page request that was saved by the SaveControlState method. |
| MapPathSecure (inherited from Control) | Retrieves the physical path that a virtual path, either absolute or relative, maps to. |
| OnPreRender (inherited from Control) | Raises the PreRender event. |
| OnUnload (inherited from Control) | Raises the Unload event. |
| OpenFile (inherited from Control) | Gets a Stream used to read a file. |
| RemovedControl (inherited from Control) | Called after a control is removed from the Controls collection of another control. |
| Render (inherited from Control) | Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. |
| RenderChildren (inherited from Control) | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. |
| SaveControlState (inherited from Control) | Saves any server control state changes that have occurred since the time the page was posted back to the server. |
| XPath (inherited from TemplateControl) | Overloaded. Evaluates an XPath data-binding expression. |
| XPathSelect (inherited from TemplateControl) | Overloaded. Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface. |
See Also
PortalModuleControl Class | Rainbow.Framework.Web.UI.WebControls Namespace