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

Ektron ContentByMeta class. Allows access to a ContentBlockItem object through IEnumerator, ICollection and IList interfaces.

C#
[DefaultProperty("KeyWordName"), PersistChildren(true)]
public class MetaDataList : EkXsltBase, IEnumerator, IEnumerable, IListSource, IDataSource, ICallbackEventHandler;
Visual Basic
<DefaultProperty("KeyWordName"), PersistChildren(true)>
Public Class MetaDataList
Inherits EkXsltBase
Inherits IEnumerator
Inherits IEnumerable
Inherits IListSource
Inherits IDataSource
Inherits ICallbackEventHandler

MetaDataList.cs

Name 
Description 
The methods of the MetaDataList class are listed here. 
The properties of the MetaDataList 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 
Calls up the database and updates the items in the control if the data is out of sync with the specified parameters.  
 
Gets a System.Collections.IEnumerator for the collection.  
 
Moves up the index of the Collection. Returns false if the end of the collection has been surpassed.  
 
Brings the index of the collection back to zero. Does not clear the collection.  
 
this 
Index operator into a strongly typed dataset holding some common properties for a Collection item.  
 
Wrap 
Overrideable method that can be used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.  
 
Name 
Description 
 
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).  
 
Select a type of content for this control. Choices are:
  • all types
  • archived content
  • archived forms
  • content
  • forms
 
 
Indicates the number of elements in your Collection.  
 
Gets the current object in the collection.  
 
Array of Ektron.Cms.Common.ContentBase items that correspond to the specified Collection. Holds more information than the exposed strongly typed this[i] index operator.  
 
This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of content items while controlling the amount of screen space. To accomplish this, the content display is limited to the number set in the MaxNumber property. If you set this property to True, and the number of content items exceeds the MaxNumber number, navigation aids appear below the last item.  
 
Gets or Sets the boolean value of ExactPhrase. Determines whether the KeyWordValue needs to match the phrase exactly.
For example, if “site” is the KeyWordValue and the title of a content block is “Welcome to the site” and ExactPhrase is set to True, you would not see the content block in the metadata list. This is because “site” does not equal “Welcome to the site”.
  • True = match the exact phrase
  • False = does not need to match exact phrase
 
 
The folder ID from which content is retrieved. At the Recursive property, you determine if content in this folder’s subfolders is also retrieved.  
 
If set to true, retrieves the content (Html body) of every content block in the MetadataList for display.  
 
Determines whether or not to display an icon next to your navigation lists. NOTE: Only works with "ecmSummary" and "ecmTeaser" or when the [$imageIcon] variable is used in an EkML file.  
 
Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchronized.  
 
KeyWordName represents a metadata definition, that is, the container for the KeyWordValues. Examples of a KeyWordName are Keywords and Title.  
 
Enter the values associated with the KeyWordName. Only content whose metadata (defined at the KeyWordName property) matches this value appears on the metadata list.  
 
This property is only used if you enter more than one keyword value.
If you do, and only want content to appear on the metadata list if all values entered at the KeyWordValue field match its metadata values, enter true.
If metadata can appear on the list as long as any value defined at the KeyWordValue field matches the selected metadata value for a content item, enter false.
Example:
KeyWordValue for Title (assigned for this server control): home; page; company.
Metadata values for a content item’s Title metadata definition field: software; ektron; company.
If KeyWordValueMatchAll = true, content... more 
 
Enter the character used to separate the list of keyword values. An example is a semicolon(;).  
 
Gets or Sets the target window for the result. Choices are:
  • _blank - this target causes the link to always be loaded in a new blank window. This window is not named.
  • _self - this target causes the link to always load in the same window the anchor was clicked in. This is useful for overriding a globally assigned BASE target.
  • _parent - this target makes the link load in the immediate frameset parent of the document. This defaults to acting like “_self” if the document has no parent.
  • _top - this target makes the link load in the full... more 
 
Enter name of a markup file that manages the display of this server control.  
 
Determine the maximum number of content items to return. If set to zero then all items are returned.  
 
The order of the list to be returned. Order by:
  • Title - The title of the content block
  • ID - The content block ID number
  • Date Created - The date the content block was created
  • Date Modified - The date the content block was last modified
  • LastEditorLname - The last editor’s last name
  • LastEditorFname - The last editor’s first name
 
 
Whether to search sub-folders of the identified root folder. The starting folder is identified in the FolderID property.  
 
Gets or sets the sort order. Choose whether to sort by Ascending or Descending.  
 
Suppresses the output of span/div tags around the control.  
 
Gets an object that can be used to synchronize the collection.  
 
Returns the XSLT object for the MetaDataList control.  
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!