Content Studio Web Content Management System
Top
[This is preliminary documentation and is subject to change.]
The ScriptFilteredDocuments type exposes the following members.
Properties
Name | Description | |
---|---|---|
AftScript |
An implementation of the EPTBaseICS_ASDynamicCode
interface that contains code to run after the data list has been rendered.
|
|
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.
|
|
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.) |
|
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).
|
|
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) |
|
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).
|
|
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.
|
|
LoopScript |
An object that implements the EPTBaseICS_ASDynamicCode
interface and contains code to be executed for one or more columns in each processed row.
|
|
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".
|
|
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).
|
|
PreScript |
An implementation of the EPTBaseICS_ASDynamicCode interface that contains code to run before the data list is rendered.
|
|
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.
|
|
RecordCount |
Gets the number of records that are returned in the list. The default
value is zero.
|
|
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.
|
|
ReturnType |
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.
|
|
SecondarySortDesc |
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).
|
|
SecondarySortField |
Sets or gets the name of the field to be used as secondary sorting
parameter. The default value is null.
|
|
SortDesc |
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).
|
|
SortField |
Sets or gets the name of the field to be used as primary sorting
parameter. The default value is null.
|
|
TextAfterRange |
Sets or gets the text (or HTML code) to be displayed immediately after
the list. The default value is an empty string.
|
|
TextBeforeRange |
Sets or gets the text (or HTML code) to be displayed immediately before
the list. The default value is an empty string.
|
|
Top |
Sets or gets a value indicating if 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.
|
|
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).
|
See Also