Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.EPTListPageableFilteredDocuments20

Namespace: ContentStudio.Site.ActiveScripting.EPT
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)

The ListPageableFilteredDocuments20 type exposes the following members.

	Name	Description
	ListPageableFilteredDocuments20	Initializes a new instance of the ListPageableFilteredDocuments20 class

Top

	Name	Description
	AllowNonMLCParent	Sets or gets a value indicating if non-MLC documents should be allowed as parent documents. The default value is true.
	ApplicationTimeout	Sets or gets a value indicating the time out limit of the application cache (measured in minutes). A zero value means that no cache is used. The default value is 240.
	BackwardsComponentCompatibilityMode	Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false. (Inherited from ActiveScriptingBase.)
	Both	Sets or gets a value indicating if paging information should be both at the top and at the bottom of the listing. The default value is false.
	Bottom	Sets or gets a value indicating if paging information should be at the bottom of the listing. The default value is true.
	CheckForReadPermission	Sets or gets a value indicating if READ permissions should be checked (instead of BROWSE or READ). The default value is false.
	CheckLangCookie	Sets or gets a value indicating if language cookies should be checked. The default value is true.
	CheckPTID	Sets or gets a value indicating if the PTID should be checked. The default value is false.
	ColProperties	Sets or gets the column properties (CAPTION, COL and COLGROUP tags) of the table. The default value is an empty string.
	ComponentName	Gets the name of the component (Overrides ActiveScriptingBaseComponentName.)
	Conformance	Gets a value which specifies which type of code a component can generate. (Overrides ActiveScriptingBaseConformance.)
	CS_DataFields	Gets a EPTXmlParser that contains a collection of EPT field definitions and values. This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods. (Inherited from CodeBase.)
	DataTypes	Sets or gets an array of data types corresponding to the XML fields that are used for filtering. The specified data type must be capable of handling all values that occur in the corresponding field. The default value is null (no array values are set).
	DefaultSortField	Sets or gets the field to use for sorting, unless something else is defined. The default value is null (no sort order is specified).
	DynamicCodes	An optional array if object that implements the EPTBaseICS_ASDynamicCode interface and contains code to be executed for one or more columns in each processed row.
	EditTemplateID	Sets or gets the ETP document to refer to for drafts. The default value is zero (no ETP document).
	ElementType	Gets a value which specifies the type of outer element the component generates. (Overrides ActiveScriptingBaseElementType.)
	EnableDirectEditing	Sets or gets a value indicating if direct editing is enabled. The default value is null.
	Encoding	Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark. (Inherited from ActiveScriptingBase.)
	FilterCriteria	Sets or gets an optional SQL criteria that is used for filtering. Field names must be enclosed in square brackets and they must be types with the correct casing. The default value is null (no filtering criteria is used).
	IgnorePublishStatus	Sets or gets a value indicating if publishing status (Publishdate, Archivedate and Withdrawn) should be ignored when filtering documents. The default value is false (only published documents will be displayed).
	IsMLCAware	Sets or gets a value indicating if the filtering should be MLC aware. The default value is false.
	LBLLeadingPageRangeText	Sets or gets the leading text to display in the paging information. The default value is an empty string.
	LBLLinkPrefix	Sets or gets link prefix text of the paging information. The default value is an empty string.
	LBLNextPage	Sets or gets the text for next page in the paging information. The default value is a "greater than" sign.
	LBLNextRange	Sets or gets the text for next range in the paging information. The default value is two "greater than" signs.
	LBLPrevPage	Sets or gets the text for previous page in the paging information. The default value is a "less than" sign.
	LBLPrevRange	Sets or gets the text for the previous range in the paging information. The default value is two "less than" signs.
	LinkAttributes	Sets or gets the link attributes. The default value is an empty string.
	LinkSep	Sets or gets a value used as link separator text. The default value is a non-breaking space.
	ListDrafts	Sets or gets a value indicating if drafts should be included in the listing. Pass null (Nothing in Visual Basic) to query against the draft or the approved content, if draft was not found. The default value is false.
	MakeLinks	Sets or gets values indicating if the corresponding XML fields should be links. The default value is null.
	NoRecordDocId	Sets or gets the ID of the document to display if no documents are found. The default value is zero (no page is used).
	NoRecordDocPTId	Sets or gets the presentation template to use when displaying "no documents found" page. The default value is zero (no presentation template is used).
	NoRecordText	Sets or gets the text to display when no documents are found. The default value is "No records found".
	Page	A reference to the current context page. This will initialize in the constructor of this class. (Inherited from CodeBase.)
	PageSize	Sets or gets the number of documents to display on each page. If set to zero, all documents are displayed. The default value is 20.
	PostMode	Sets or gets a value indicating how posted pages should be handled. The default value is zero (not handling posted pages).
	PTID	Sets or gets an optional presentation template to use to when presenting the data elements. The default value is zero (the default presentation template is used).
	RandomSort	Randomize sorting order. The default value is false.
	RangeSize	Sets or gets the number if page references to display in the paging information. The default value is 10.
	RecordTextBottom	Sets or gets a text that is displayed after the list if any records were found. Constants $RecordCount$ and $PageCount$ will be replaced with the corresponding values. The default value is an empty string.
	RecordTextTop	Sets or gets a text that is displayed before the list if any records were found. Constants $RecordCount$ and $PageCount$ will be replaced with the corresponding values. The default value is an empty string.
	ReturnFieldsInResult	Sets or gets values indicating if the corresponding XML fields should be included in the result. The default value is null.
	ReturnOnlyThisColumn	Sets or gets a value indicating if only this column should be returned. The default value is false.
	RowColor1	Sets or gets the background color of odd numbered rows (1, 3 etc.). The default value is "#F5F5F5" (light grey).
	RowColor2	Sets or gets the background color of even numbered rows (2,4 etc.). The default value is "#FFFFFF" (white).
	RunningUserControl	Gets the current running user control. (Inherited from CodeBase.)
	SortCellAttributes	Sets or gets the attributes of sorted cells. The default value is an empty string (no attribute is used).
	SortColumns	Sets or gets the headers for columns that are prepared for sorting. The default value is null.
	SortDesc	Sets or gets a value indicating if the sort order should be descending. The default value is false (sort in ascending order).
	TableAttributes	Sets or gets table attributes. The default value is an empty string.
	TableBorder	Sets or gets the table border width. The default value is zero (no border). Remarks This property is only relevant if UseTable is set to true.
	TableCellPadding	Sets or gets the table cell padding. The default value is 3. Remarks This property is only relevant if UseTable is set to true.
	TableCellSpacing	Sets or gets the table cell spacing. The default value is 3. Remarks This property is only relevant if UseTable is set to true.
	TableWidth	Sets or gets the table width (in pixels or percentage). The default value is "100%".
	Target	Sets or gets the name of the field containing the text to be used in theTARGET attribute of the link. The default value is an empty string (the attribute is not used).
	Top	Sets or gets a value indicating if the paging information should be at the top of the listing. The default value is false.
	UniqueID	Sets or gets a unique identifier that can act as a prefix to the sortable columns. This is useful if there can be several paging instances on the same page.The default value is "CS_".
	UseApplicationCache	Sets or gets a value indicating if application cache should be used. The default value is false (no application cache is used).
	UsePageing	Sets or gets a value indicating if paging information should be displayed. The default value is true.
	UseRoot	Sets or gets a value indicating if the root should be used to fetch current language (rather than from the document in which the component is inserted). The default value is false.
	XMLFields	Sets or gets the XML fields that are used as result criteria or to define the sort order. The default value is null (no fields are specified).

Top

	Name	Description
	BuildHTMLComponentException	Returns an component exception in HTML format. (Inherited from ActiveScriptingBase.)
	CreatePageRange	Create a page range in HTML or XHTML (Inherited from PageableComponent.)
	CSF_LookUpField(Int32, String, String, String)	Used for id lookups from xmlindex (Inherited from EPTBase.)
	CSF_LookUpField(Int32, String, String, String, Boolean, Int32)	Used for id lookups from xmlindex (Inherited from EPTBase.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GenerateLinkTargetAttribute	Returns the attribute string to be written to the link. (Inherited from ActiveScriptingBase.)
	GetCorrectField	Extracts the correct value from a passed in EPT field name and a static field value. (Inherited from ActiveScriptingBase.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke(Int32)	Invokes the component and writes its content into the default response stream
	Invoke(Stream, Int32)	Invokes the component and writes its content into the specified stream.
	MakeDirectEditIcon	Method for creating an direct edit icon used in web view (Inherited from EPTBase.)
	MemberwiseClone	(Inherited from Object.)
	PrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean)	Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell. (Inherited from EPTBase.)
	PrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean, Boolean)	Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell. (Inherited from EPTBase.)
	ReadFromApplicationCache	Returns data that is read from the application cache. (Inherited from ActiveScriptingBase.)
	ReturnQueryAsDictionary	Returns a Dictionary containing query results. (Inherited from EPTBase.)
	SetApplicationCache	Stores a string in the application cache. (Inherited from ActiveScriptingBase.)
	SyncronizeMLC	Provides support for components that needs to be MLC aware, by localizing the supplied category or presentation template from the current document, or the preferred language of the visitor. (Inherited from ActiveScriptingBase.)
	ToString	(Inherited from Object.)
	WriteAttribute(TextWriter, String, String)	Writes an attribute string to the supplied stream, unless Value is an empty string or null (Inherited from ActiveScriptingBase.)
	WriteAttribute(TextWriter, String, String, Boolean)	Writes an attribute string to the supplied stream. (Inherited from ActiveScriptingBase.)

Top To use this class, create an instance of this object, set the properties that does not have the values you expect, and call the Invoke method. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible.

Reference