You are here: Ektron Namespace > Server Controls API > Ektron.Cms Namespace > Ektron.Cms.Controls Namespace > Classes
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
Classes

The following table lists classes in this documentation.

 
Name 
Description 
 
The ActiveTopics server control displays either the most active topics or the most recent topics. The most active are determined by how many new posts are added to a topic or how many replies a post receives. The most recent are determined by the date of the post.  
 
[deprecated]AnalyticsTracker server control has been deprecated. Instead use Analytic server control to track statistics about visits to your Web site.  
 
The AssetControl server control, when viewed on a Web form, displays a drag and drop box for users to upload assets to CMS400.NET or update an existing asset.  
 
Blog 
The Blog server control allows you to quickly add a blog to a Web form. It has all of the items commonly found on a blog page in one server control.  
 
The BlogArchive server control displays a list of past months or years that have posts.  
 
The BlogCalendar server control allows a user to display a calendar on a Web page and associate it with a blog.  
 
The BlogCategories server control displays a blog’s categories on a Web form.  
 
The BlogEntries server control allows you to display a list of multiple blog posts on a Web form.  
 
The BlogPost server control allows you to display an individual blog post on a page.  
 
The BlogRecentPosts server control displays a list of recent blog posts links on a Web form.  
 
The BlogRoll server control displays the blog roll for a blog on a Web form.  
 
The BlogRSS server control displays the icon for the blog’s RSS feed on the Web form.  
 
The BreadCrumb server control displays history breadcrumbs. Your site visitors can use the breadcrumb trail to jump to previously visited pages.  
 
Class to contain compass item data.  
 
Business Rules allow you to define conditions for Web pages on your site. You choose an action based on whether the conditions are true or false when a site visitor browses your site. For example:

  • Condition - a site visitor visits your site for the first time
  • Action - add a cookie to the site visitor’s system and pop up a welcome message

With Business Rules, you do not write code to set conditions and initiate actions. You simply complete the information requested in the Business Rules wizard within the workarea, have your developer add a Business Rules server control... more 

 
Summary description for Calendar.  
 
Cart 
This is class Ektron.Cms.Controls.Cart. 
 
This is class Ektron.Cms.Controls.Checkout. 
 
Ektron Collection class. Allows access to a ContentBlockItem object through IEnumerator, ICollection and IList interfaces.  
 
This is class Ektron.Cms.Controls.CommunityDocuments. 
 

Summary description for Message board
 
 

Summary description for Message board
 
 

Summary description for Message board
 
 
 
 
This is class Ektron.Cms.Controls.CommunitySearch. 
 
Summary description for ContentBlock.  
 
 
 
The ContentList server control is used to display a list of content blocks on a Web page. In contrast to a List Summary, where content must be in a specified folder, the ContentList server control uses content from any CMS400.NET folder.  
 
Use the ContentRating server control to place a rating scale on any page of your Web site. The scale lets Ektron CMS400.NET collect feedback by giving site visitors the opportunity to rate a particular content item. A visitor can rank the content on a numerical scale of one through nine, as well as submit a text comment.  
 
The ContentReview server control has two ways it can be used. The first, places a star based rating scale on any page of your Web site. The scale lets Ektron CMS400.NET collect feedback by giving site visitors the opportunity to rate a particular content item. An item is rated when a visitor clicks on a star. Depending on the XSLT chosen, visitors can also submit review comments.
The second way the ContentReview control can be used is to retrieve and display visitor reviews and comments. In this mode, the control can display reviews of a content item or reviews by... more 
 

Summary description for CurrencySelect control
 
 
The DesignTimeDiagnostic server control is used to verify the connection to Ektron’s server controls Web service. When added to a Web form, this control provides the following information: 

  • Web Service Path - displays the server control Web service path in your web.config file
  • Web Service Exists - calls a method in the Web service that returns True when the Web service exists. When it does not, it returns False.
  • Test Login Control - displays the Login server control to show that the Web service is connected and working properly. When not connecting properly, an error message is displayed.

 

 
The DhtmlMenu server control lets you display a menu with drop down boxes and submenus. This lets developers add a menu to a page without taking up a lot space.  
 
The Directory server control lets you customize the behavior of the Taxonomy feature. You place this control on any Web form to display a taxonomy.  
 
When placed inside a Microsoft CatalogZone, the EktronCatalogPart allows users to choose the type of CMS400.NET control that is added to a WebPartZone.  
 
The EktronCommunityCatalogPart Server Control gets a list of Discussion Board (Forums) and Blogs from your site. Then, it allows site users to choose from any available Discussion Boards and Blogs and add them to a WebPartZone.  
 
Similar to a Microsoft WebPartZone, the EktronWebPartZone server control provides a location for content to be displayed on a Web page. The difference between the two is formatting. The EktronWebPartZone is designed to work specifically with Ektron Server Controls, while Microsoft WebPartZones are more generic.  
 
The base class from which all Ektron CMS400 Server Controls are derived.  
 
This is class Ektron.Cms.Controls.EkWebPart. 
 
Summary description for EkXsltBase.  
 
Defines the Explorer Drag Drop control, used to upload assets via Desktop drag drop to the CMS.  
 

Summary description for Favorites
 
 
The FlexMenu server control displays a menu on a Web form. Although it looks and acts like a Smart Menu, its architecture is substantially different. Specifically, a FlexMenu creates XML. So, you can modify its behavior using an XSLT file, and change its appearance using a cascading style sheet (.css) file.  
 
The FolderBreadcrumb server control displays sitemap breadcrumbs. This type of trail is typically made up of the folder path for the content. It is important to note that the FolderBreadcrumb server control does not simply read your folder structure and display its path. It reads breadcrumb information set in the Workarea’s folder properties for each folder. Administrators define a folder's breadcrumbs on the Breadcrumb tab located in the Workarea folder properties. See Also: The Administrator Manual > "Managing Content" > "Managing Content Folders" > "Breadcrumbs"
For additional information on this server control, see the Developer Manual section "Introduction to... more 
 
The FormBlock server control displays a content block associated with a form.  
 
Defines a field within the form.  
 
The Forum server control displays a discussion board on a Web page.  
 

Summary description for Friends (Colleague Server Control API
 
This is class Ektron.Cms.Controls.HtmlEditDisplay. 
 
This server control provides the ability to edit specific CMS content. The eWebEditPro editor can easily be placed onto a page for content editing. There is flexibility to control the toolbars, the available functionality, and the operations of the editor.
The control, at run time, produces the fields listed below. They are posted with the content and can be processed in the receiving page.

  • [ControlName]_Action = the action to take - save, check in, undo checkout
  • [ControlName]_ContentTitle = the content title
  • [ControlName]_ContentId = the ID of the content
  • [ControlName]_Language = the language of the content


The content title caption is... more 

 
The ImageControl server control, when viewed on a Web form, displays an image stored within the CMS400.NET document management feature. When a user is logged in and has permission to edit the image, he can right click the image and select edit. This creates a drag and drop box that the user can use to update the file.  
 
Use the IndexSearch server control to display a Smart Form’s search screen on any Web form. This lets a user search your site based on XML parameters.  
 
 
 
Control that can be used to override the default system language assignment behavior.  
 
The LanguageSelect server control displays a language selection dropdown list on an Ektron CMS400.NET Web page. The dropdown box lists all languages selected on the Settings > Configuration > Language settings screen.  
 
Summary description for ListSummary.  
 
Summary description for Login.  
 
Map 
Map control  
 
The Membership server control creates a form on a Web page that allows a user to create or update a profile of themselves in your membership list. The control creates the form based on the standard Ektron user properties and any custom user properties that exist. It also provides a way to have new membership users read and accept the terms and conditions for using Discussion Boards (Forums) when needed.  
 
Menu 
The Menu server control calls a menu to be displayed on a page. Using the Menu server control, you can manipulate a menu by using the DisplayXslt property.  
 

Summary description for Message board
 
 
 
 
The Metadata server control lets you add the metadata from content blocks to a Web page. This lets developers add metadata quickly without having to type it in. You can add metadata from a single content block, multiple content blocks, or by dynamically passing a content ID from a URL.  
 
Ektron ContentByMeta class. Allows access to a ContentBlockItem object through IEnumerator, ICollection and IList interfaces.  
 

Summary description for MicroMessage
 
 
This is class Ektron.Cms.Controls.MyAccount. 
 

Summary description for OrderList control
 
 
The PersonalizationManager server control allows site users to personalize, add, edit and hide content on a Web page. The level of privileges assigned to a site user in CMS400.NET determines what personalization functionality is available when the control is active. The Personalization manager only appears when a user is logged in to the site. 
 
This is class Ektron.Cms.Controls.PhotoGallery. 
 
Poll 
The Poll Server Control displays a poll or survey created from an Ektron CMS400.NET form on a Web page.  
 
The PostHistory server control displays a list of posts for a given user. The posts are displayed in order by date and contain the following: Topic - the topic that contains the post Posted - the date the post was created Content - the content with in the post  
 
Holds the Post-Login event arguments.  
 

Summary description for Product
 
 
This is class Ektron.Cms.Controls.ProductList. 
 
The Web Search server control lets you customize the behavior of the search. You place this control on any Web form from which a site visitor can search your site. For information about the site visitor experience, see the Ektron CMS400.NET Administrator Manual section "Searching Your Web Site" > "Web Site Search."  
 
 
 
Ektron RssAggregator class. Allows access to a RSS Feed object through IEnumerator, ICollection and IList interfaces.  
 
Container for Title, Link, Description and DatePosted article information.  
 
Search object returns the control and results.  
 
The Sitemap server control utilizes the folder breadcrumb information in the Workarea to display a sitemap of your site. By choosing the starting point of the sitemap, the max levels to display and applying a style class, you can customize the sitemap.  
 
Class extends the Menu-Sever-Control, adding CSS based menus.  
 
Summary description for ListSummary.  
 
The TagCloud server control allows you to visually depict a weighted list of tags assigned to users or community groups. The weight of each tag is determined by the amount of times a tag is assigned and represented by font size. The large the font size the more times a tag is assigned. Tags are keywords that are associated with a user or community group in CMS400.NET.  
 
 
 
Summary description for Calendar.  
 
The Web Search server control lets you customize the behavior of the search. You place this control on any Web form from which a site visitor can search your site. For information about the site visitor experience, see the Ektron CMS400.NET Administrator Manual section "Searching Your Web Site" > "Web Site Search."  
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].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!