ScriptFilteredDocuments Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Inserts documents from a category, filtered on up to twenty XML fields, and writes them as HTML to the supplied stream or the default response stream. There is functionality for generating dynamic code that is executed for each row and selected columns in the result set. In addition to this, it is also possible to define code to run before and after the point where the result set is written to the stream. The ScriptFilteredDocuments class acts as the underlying engine for the Script filtered documents AS component.
Inheritance Hierarchy

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

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

public sealed class ScriptFilteredDocuments : EPTBase

The ScriptFilteredDocuments type exposes the following members.

Constructors

  NameDescription
Public methodScriptFilteredDocuments
Initializes a new instance of the ScriptFilteredDocuments class
Top
Properties

  NameDescription
Public propertyCode exampleAftScript
An implementation of the EPTBaseICS_ASDynamicCode interface that contains code to run after the data list has been rendered.
Public propertyApplicationTimeout
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.
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyBoth
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.
Public propertyBottom
Sets or gets a value indicating if paging information should be at the bottom of the listing. The default value is true.
Public propertyCheckForReadPermission
Sets or gets a value indicating if READ permissions should be checked (instead of BROWSE or READ). The default value is false.
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDataTypes
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).
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyCode exampleFilterCriteria
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).
Public propertyIgnorePublishStatus
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).
Public propertyLBLLeadingPageRangeText
Sets or gets the leading text to display in the paging information. The default value is an empty string.
Public propertyLBLLinkPrefix
Sets or gets link prefix text of the paging information. The default value is an empty string.
Public propertyLBLNextPage
Sets or gets the text for next page in the paging information. The default value is a "greater than" sign.
Public propertyLBLNextRange
Sets or gets the text for next range in the paging information. The default value is two "greater than" signs.
Public propertyLBLPrevPage
Sets or gets the text for previous page in the paging information. The default value is a "less than" sign.
Public propertyLBLPrevRange
Sets or gets the text for the previous range in the paging information. The default value is two "less than" signs.
Public propertyLinkAttributes
Sets or gets the link attributes. The default value is an empty string.
Public propertyLinkSep
Sets or gets a value used as link separator text. The default value is a non-breaking space.
Public propertyListDrafts
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.
Public propertyCode exampleLoopScript
An object that implements the EPTBaseICS_ASDynamicCode interface and contains code to be executed for one or more columns in each processed row.
Public propertyNoRecordDocId
Sets or gets the ID of the document to display if no documents are found. The default value is zero (no page is used).
Public propertyNoRecordDocPTId
Sets or gets the presentation template to use when displaying "no documents found" page. The default value is zero (no presentation template is used).
Public propertyNoRecordText
Sets or gets the text to display when no documents are found. The default value is "No records found".
Public propertyPageSize
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.
Public propertyPostMode
Sets or gets a value indicating how posted pages should be handled. The default value is zero (not handling posted pages).
Public propertyCode examplePreScript
An implementation of the EPTBaseICS_ASDynamicCode interface that contains code to run before the data list is rendered.
Public propertyRandomSort
Randomize sorting order. The default value is false.
Public propertyRangeSize
Sets or gets the number if page references to display in the paging information. The default value is 10.
Public propertyRecordCount
Gets the number of records that are returned in the list. The default value is zero.
Public propertyRecordTextBottom
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.
Public propertyRecordTextTop
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.
Public propertyReturnFieldsInResult
Sets or gets values indicating if the corresponding XML fields should be included in the result. The default value is null.
Public propertyReturnType
Sets or gets a value describing what type of data that should be returned and how the corresponding SQL statement should be processed. The default value is XmlIndexQuery.QueryAggregate.None. None A standard SQL statment is used SelectDistinctValues Return distinct values from all chosen fields. GoupAndCount Return distinct values from all chosen fields, and adding the parameter AggregateValue (column aggregatevalue) containing the number of distinct values. The default sort order of AggregateValue is ascending. Min The SQL aggregate function MIN is used. The first field must be an integer. Max The SQL aggregate function MAX is used. The first field must be an integer. Avg The SQL aggregate function AVERAGE is used. The first field must be an integer.
Public propertySecondarySortDesc
Sets or gets a value indicating if the sort order of the secondary field should be descending. The default value is false (sort in ascending order).
Public propertySecondarySortField
Sets or gets the name of the field to be used as secondary sorting parameter. The default value is null.
Public propertySortDesc
Sets or gets a value indicating if the sort order of the primary field should be descending. The default value is false (sort in ascending order).
Public propertySortField
Sets or gets the name of the field to be used as primary sorting parameter. The default value is null.
Public propertyTextAfterRange
Sets or gets the text (or HTML code) to be displayed immediately after the list. The default value is an empty string.
Public propertyTextBeforeRange
Sets or gets the text (or HTML code) to be displayed immediately before the list. The default value is an empty string.
Public propertyTop
Sets or gets a value indicating if paging information should be at the top of the listing. The default value is false.
Public propertyUniqueID
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_".
Public propertyUseApplicationCache
Sets or gets a value indicating if application cache should be used. The default value is false (no application cache is used).
Public propertyUsePageing
Sets or gets a value indicating if paging information should be displayed. The default value is true.
Public propertyXMLFields
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
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke(Int32)
Invokes the component and writes its content into the default response stream
Public methodInvoke(Stream, Int32)
Invokes the component and writes its content into the specified stream.
Public methodToString (Inherited from Object.)
Top
Remarks

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 core of the generated code is fully HTML/XHTML strict compatible. But since large parts of the final code is defined by the users, the conformance level of the class is set to unspecified.
See Also

Reference