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

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

Inserts published documents, specified in a comma-delimited list, into the supplied stream or the default response stream. All documents must be located in a specific category. All documents and EPT documents must be of a type without meta data. The InsertCommaSeparatedDocuments class acts as the underlying engine for the Insert Comma Separated Documents AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDocumentBase
        ContentStudio.Site.ActiveScripting.DocumentInsertCommaSeparatedDocuments

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

public sealed class InsertCommaSeparatedDocuments : DocumentBase

The InsertCommaSeparatedDocuments type exposes the following members.

Constructors

  NameDescription
Public methodInsertCommaSeparatedDocuments
Constructs a new instance of the InsertCommaSeparatedDocuments class that writes to the default response stream
Public methodInsertCommaSeparatedDocuments(Stream)
Constructs a new instance of the InsertCommaSeparatedDocuments class that writes to the supplied stream
Top
Properties

  NameDescription
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 propertyCategoryID
Sets or gets the category where the documents to insert should be located. The default value is zero
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. The default value is ConformanceLevels.Unspecified.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDoAccessCheck
Sets or gets a value that indicates whether an access check for the Browse permission should be done on each found document or not. By default an access check is made for the category, so this option is relevant only when some of the documents has an individual permission set. Set this parameter to false for better performance The default value is false.
Public propertyDocumentList
Sets or gets an array of DocumentID (integer) to insert. These documents must belong to the category indicated by the CategoryID property. The default value is an empty array (with length zero).
Public propertyDocumentsNotFoundText
Sets or gets the text to display if no documents that match the conditions are found. The default value is "No documents found".
Public propertyDocumentsToReturn
Sets or gets a value that indicates the maximum number of documents to be listed, Use zero to list all of the documents. The default value is zero.
Public propertyElementType
Gets a value which specifies the type of outer element the component generates. The value is always ElementTypeSpecification.Unknown.
(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 propertyPresentationTemplate
Sets or gets an optional presentation template to use to present the documents. If no optional presentation template should be specified, set the property to zero. If no presentation template is specified and the category contains EPT documents, the default presentation template is used. This property is ignored unless the category contains EPT documents. The default value is zero.
Public propertySortOrder
Sets or gets the sort order of the inserted documents. The default value is DocumentComponentSupport.DocumentCollectionSortOrder.PublishDateAscending.
Public propertyWordwrap
Sets or gets a value that specifies if there should be a word wrap (line break) between each of the listed documents. The default value is true.
Top
Methods

  NameDescription
Public methodStatic memberCommaSeparatedListToIntArray
Converts a string consisting of a list of comma separated values (that are possible to convert to integers) into an array of integers.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
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 up the properties and call the Invoke method with an appropriate set of parameters. 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.
See Also

Reference