Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingPageableComponent
ContentStudio.Site.ActiveScriptingEPTBase
ContentStudio.Site.ActiveScripting.EPTListFilteredDocumentsInDropdownAdvanced20
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
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.
[This is preliminary documentation and is subject to change.]
Inserts filtered documents from a category into a dropdown object,
and writes them as HTML to the supplied stream or the default response
stream. There is also functionality for generating dynamic code that is
executed for each row and selected columns in the result set.
The ListFilteredDocumentsInDropdownAdvanced20 class acts as the underlying
engine for the List filtered documents in dropown advanced 2.0 AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingPageableComponent
ContentStudio.Site.ActiveScriptingEPTBase
ContentStudio.Site.ActiveScripting.EPTListFilteredDocumentsInDropdownAdvanced20
Namespace: ContentStudio.Site.ActiveScripting.EPT
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The ListFilteredDocumentsInDropdownAdvanced20 type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ListFilteredDocumentsInDropdownAdvanced20 |
List two independent XML fields in dropdown from a category filtered on
one to ten XML fields.
|
Properties
Name | Description | |
---|---|---|
ApplicationTimeout |
Sets or gets a value indicating the application timeout limit, measured
in minutes . If the value is set to zero, no timeout limit is set. 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.) | |
BlankStart |
Sets or gets a value indicating if the first selection in the dropdown
should be blank. The default value is false.
| |
BlankStartText |
Sets or gets the text to use for blank items in the dropdown component.
The default value is an empty string.
| |
CategoryId |
Sets or gets the category ID to filter from. The default value is zero.
| |
CheckForReadPermission |
Sets or gets a value indicating if the component should check for WRITE
permission instead of BROWSE permission. 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.) | |
DataType |
Sets or gets the data type for the field to fill in the dropdown. This
value must be specified to get the correct sort order. Note that the
specified must be capable of handling all values that corresponds to
the chosen data type. The default value is ContentStudio.Document.EPT.XmlIndexQuery.QueryDataTypes.String.
| |
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 a 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 an empty string (no filtering
criteria is used).
| |
ListDrafts |
Sets or gets a value indicating if only drafts should be listed. 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.
| |
Number |
Sets or gets the maximum number of documents that should be listed. If
set to zero, all documents are listed. The default value is zero.
| |
RecordCount |
Gets the number of records that are returned in the list. The default
value is zero.
| |
RetField |
Sets or gets the name of the field to be used to fill the return value
of the dropdown component. The default value is null.
| |
SelectValue |
Sets or gets the value that should be selected.
| |
SortDesc |
Sets or gets a value indicating if the items in the dropdown component
should be sorted in descending order. The default value is false.
| |
UseApplicationCache |
Sets or gets a value indicating if application cache should be used.
The default value is false (no application cache is used).
| |
ValueField |
Sets or gets the optional field to be used to fill the value in
dropdown component. Leave this property empty to use document ID
instead. The default value is null.
| |
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).
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and fills the existing HtmlSelect object.
| |
ToString | (Inherited from Object.) |
Remarks
See Also