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

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

The InsertCommaSeparatedDocuments type exposes the following members.

Properties

  Name Description
Public property 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.)
Public property CategoryID
Sets or gets the category where the documents to insert should be located. The default value is zero
Public property ComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public property Conformance
Gets a value which specifies which type of code a component can generate. The default value is ConformanceLevels.Unspecified.
(Overrides ActiveScriptingBaseConformance.)
Public property DoAccessCheck
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 property DocumentList
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 property DocumentsNotFoundText
Sets or gets the text to display if no documents that match the conditions are found. The default value is "No documents found".
Public property DocumentsToReturn
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 property ElementType
Gets a value which specifies the type of outer element the component generates. The value is always ElementTypeSpecification.Unknown.
(Overrides ActiveScriptingBaseElementType.)
Public property Encoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public property PresentationTemplate
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 property SortOrder
Sets or gets the sort order of the inserted documents. The default value is DocumentComponentSupport.DocumentCollectionSortOrder.PublishDateAscending.
Public property Wordwrap
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
See Also

Reference