Collection Class

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

Class Hierarchy

[DefaultProperty("DefaultCollectionID"), ToolboxData("<{0}:Collection runat=server></{0}:Collection>"), PersistChildren(true)]
public class Collection : EkXsltWebPart, IEnumerator, IEnumerable, IListSource, IDataSource, ICallbackEventHandler;

Visual Basic

<DefaultProperty("DefaultCollectionID"), ToolboxData("<{0}:Collection runat=server></{0}:Collection>"), PersistChildren(true)>
Public Class Collection
Inherits EkXsltWebPart
Inherits IEnumerator
Inherits IEnumerable
Inherits IListSource
Inherits IDataSource
Inherits ICallbackEventHandler

Collection.cs

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

Collection Methods

	Name	Description
	CopyTo	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 the database and updates the contents of the collection if the data is out of sync with the specified parameters.
	GetEnumerator	Gets a System.Collections.IEnumerator for the collection.
	GetRssFeed	This method returns a Collection RSS feed.
	GetView	Gets the view data using a dataset.
	GetViewNames	Gets the view names.
	MoveNext	Moves up the index of the Collection. Returns false if the end of the collection has been surpassed.
	Reset	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.
	ToString	Wraps the resulting collection with the Ektron toolbars, which will only display when a user is logged in.
	Wrap	Overrideable method that's used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.

Collection Properties

	Name	Description
	AddText	Allows overriding the derived controls default Add-menu button text (i.e. 'Add HTML Content' could be changed to 'Add Report')
	CacheInterval	Sets the cache interval in second(s).
	CollectionDescription	Returns the description of the given folder ID.
	CollectionTitle	Returns the name of the given folder ID.
	ContentParameter	Checks the QueryString for this value and replaces the collection with that content block when specified. Leave blank to always display the collection.
	Count	Indicates the number of elements in your Collection.
	Current	Gets the current object in the collection.
	DefaultCollectionID	Gets or Sets the Default CollectionID for this Control.
	DynamicParameter	The parameter to query for a Dynamic Collection.
	EkItems	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.
	EnablePaging	Enables paging if the total number of records exceeds the MaxResult value.
	GetHtml	If set to true, retrieves the content (Html body) of every content block in the collection for display.
	IncludeIcons	Determines whether or not to display an icon next to your navigation lists. NOTE: Only works with ecmSummary and ecmTeaser.
	IsSynchronized	Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchronized.
	LinkTarget	Defines the way a link acts when a link is clicked. 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... more
	MarkupLanguage	Enter the name of a markup file that manages the display of this server control.
	MaxResults	Maximum number of results to be returned. If set to zero, there is no limit.
	Random	If set to true, grabs a single content block randomly from the collection. Set to false for all data in the collection.
	SelTaxonomyID	Gets or Sets the Default TaxonomyID for this Collection Control.
	SuppressWrapperTags	Suppresses the output of span/div tags around the control.
	SyncRoot	Gets an object that's used to synchronize the collection.
	XmlDoc	Returns the Xslt object for the collection.

Links

Collection Methods, Collection Properties, Classes, Legend, Members, Topics, Collection Methods, Collection Properties

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!