EkWebControl Class

The base class from which all Ektron CMS400 Server Controls are derived.

[ToolboxData("<{0}:EkWebControl runat=server></{0}:EkWebControl>")]
public abstract class EkWebControl : System.Web.UI.WebControls.WebParts.WebPart;

Visual Basic

<ToolboxData("<{0}:EkWebControl runat=server></{0}:EkWebControl>")>
Public abstract Class EkWebControl
Inherits System.Web.UI.WebControls.WebParts.WebPart

EkWebControl.cs

Name	Description
EkWebControl Methods	The methods of the EkWebControl class are listed here.
EkWebControl Properties	The properties of the EkWebControl class are listed here.

EkWebControl Methods

	Name	Description
	Fill	Method that can be overridden and used to grab data from the back end for each server control.
	GetEnumDescription	Gets the Description attribute value for the enum value
	GetFilenameFromPath	Returns the filename (with extention), given a path and filename.
	GetMessage	This is the overview for the GetMessage method overload.
	LocalizeString	Used to localize strings in the control properties window and at render time. Strings should be defined in resource files. Any property that the user would like to be localized to the sites default language should begin with the constant STR_LOCALIZE defined in the EkWebControl class.
	RedirectFromLoginPage	Provides a mechanism to return from the login page to the previous page (if specified in web.config and on the querystring).
	RedirectToLoginPage	Redirects to the login page (if specified in web.config) and the user is not currently logged in.
	RegisterAllDmsMenuCssAndScripts	Used to register all necessary DmsMenu CSS and Scripts in one shot
	RegisterDmsMenuCSS	Used to register the DmsMenu.css File for the DmsMenu
	RegisterDmsMenuScript	Used to register the DMSMenu.js file
	RegisterJQueryScript	Used to register the Ektron.js file
	RegisterMembershipTabScript	Used to Register the Membership tab JS and CSS files
	RegisterThickBoxCSS	Used to Register the box.css file for ThickBox
	RegisterThickBoxScript	Used to Register the thickbox.js file
	ToString	Renders the control for output as a string. Use this method to display your controls if you instantiate your control as a component in code behind.
	Wrap	Method that can be overridden and used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.

EkWebControl Properties

	Name	Description
	Authenticated	DESIGN TIME ONLY: Used to indicate to a user that they are logged in, and permits them to login through a login dialog in Visual Studio.NET.
	CmsSitePath	DESIGN TIME ONLY: Used to find the web service required to access the CMS in Design Time.
	Error	An exception caught in the rendering of this Server Control.
	Hide	Alias for the 'Visible' property. Visible is set to mirror this value. This property is used to hide output in design time, whereas Visible does not hide output in design time.
	IsLoggedIn	DESIGN TIME ONLY: Read only property that lets a developer know if the user is currently log into the site as a user.
	Language	Set a language for viewing content blocks, collections, etc. in different languages. The language property shows results in design-time (in Visual Studio) and at run-time (in a browser).
	LanguageID	This property lets a designer view content blocks, collections etc in different languages.
	loggedInUserID	DESIGN TIME ONLY: Read only property that lets a developer know the user ID of the user who is currently logged in.
	loggedInUserName	DESIGN TIME ONLY: Read only property that lets a developer know the user name of the user who is currently logged in.
	LogLevel	"Allows control-level filtering of the logged events, from verbose to none
	SuppressWrapperTags	Suppresses the output of span/div tags around the control.
	Text	Allows a developer to treat the server control as a Label, taking information from the Control and painting it on top of the Control for display. Leave blank for default display.
	WrapTag	Allows a developer to specify control's tag. Default is assumed "<span>".

Public Methods

	Name	Description
	EkWebControl	Constructor for the Ektron Server Control base class - initializes the CmsConnection layer

Links

EkWebControl Methods, EkWebControl Properties, Classes, Legend, Members, Topics, EkWebControl Methods, EkWebControl Properties, Public Methods

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!