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

Summary description for ListSummary.

C#
[DefaultProperty("FolderID"), ToolboxData("<{0}:ListSummary runat=server></{0}:ListSummary>")]
public class ListSummary : EkXsltWebPart, IEnumerator, IEnumerable, IListSource, IDataSource, ICallbackEventHandler;
Visual Basic
<DefaultProperty("FolderID"), ToolboxData("<{0}:ListSummary runat=server></{0}:ListSummary>")>
Public Class ListSummary
Inherits EkXsltWebPart
Inherits IEnumerator
Inherits IEnumerable
Inherits IListSource
Inherits IDataSource
Inherits ICallbackEventHandler

ListSummary.cs

Name 
Description 
The methods of the ListSummary class are listed here. 
The properties of the ListSummary class are listed here. 
 
Name 
Description 
 
Copies all the elements of the current System.Data.InternalDataCollectionBase to a one-dimensional System.Array, starting at the specified System.Data.InternalDataCollectionBase index.  
 
Fill 
Populates the data for the ListSummary.  
 
Gets a System.Collections.IEnumerator for the ListSummary.  
 
This method returns the ListSummary RSS feed.  
 
Gets the view data using dataset.  
 
Gets the view names.  
 
Move to next index.  
 
Resets the index.  
 
this 
Returns the current ContentItem.ContentRow.  
 
Overrides the system ToString function.  
 
Wrap 
Wrap the Html toolbar.  
 
Name 
Description 
 
Allows overriding the derived controls default Add-menu button text (i.e. 'Add HTML Content' could be changed to 'Add Report')  
 
Sets the amount of time the server control’s data is cached. The default is 0 (zero). This is the amount of time, in seconds, a control’s data is cached. For example, if you want to cache the data for five minutes, you set the CacheInterval property to 300 (three hundred).  
 
Checks the QueryString for this value and replaces the list summary with that content block when specified. Leave blank to always display the list summary.  
 
Determines the type for content to return. For example, Forms. Choices are:
  • AllTypes - displays all of the content types for the given folder.
  • Content - displays a list of content blocks.
  • Forms - forms appear in the list summary.
  • Archive_Content - archived content blocks appear in the list summary.
  • Archive_Forms - archived forms appear in the list summary.
  • Assets - assets, such as offices documents, appear in the list summary.
  • Archive_Assets - archived assets appear in the list summary.
  • LibraryItem - library items appear in the list summary.
  • Multimedia - multimedia items appear in the list summary.
  • Archive_Media -... more 
 
Indicates the number of elements in your ListSummary.  
 
Gets the current index.  
 
Direction for sorting results, "ascending" or "descending".  
 
Returns the array of ContentBase.  
 
Enables paging if the total records exceeds MaxResult value.  
 
Returns a description of the given folder ID.  
 
The ID of the folder from which to select data. Root is 0.  
 
Returns name of the given folder ID.  
 
The path of the folder from which to select data. Root starts at \.  
 
If set to True, retrieves the content (Html body) of every content block in the list summary for display.  
 
Determines whether or not to display an icon next to your navigation lists. NOTE: ONLY WORKS WITH ecmSummary AND ecmTeaser.  
 
Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchronized.  
 
Gets or Sets the target window for the result.  
 
Enter the name of a markup file that manages the display of this server control.  
 
Maximum number of results to be returned. If set to 0 (zero), there is no limit.  
 
Direction for sorting results, "ascending" or "descending".  
 
The key by which to sort your results.  
 
If set to true, grabs a single content block randomly from the folder (and subfolders, if recursive.) Set to false for all data in the list summary.  
 
Determines if subfolders of the selected folders should be included in the list.  
 
Gets or Sets the TaxonomyID for this Collection Control.  
 
Suppresses the output of span/div tags around the control.  
 
Gets an object that can be used to synchronize the ListSummary.  
 
Returns the Xml object loaded for ListSummary.  
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!