Content Studio Web Content Management System

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

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

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

The InsertMultipleDocuments type exposes the following members.

	Name	Description
	InsertMultipleDocuments	Constructs a new instance of the InsertMultipleDocuments class that writes to the default response stream
	InsertMultipleDocuments(Stream)	Constructs a new instance of the InsertMultipleDocuments class that writes to the supplied stream

Top

	Name	Description
	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.)
	CategoryID	Sets or gets a value that indicates a category where the document to insert is located. The default value is zero, but this property must be set to a valid category before invoking the class.
	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.)
	DoAccessCheck	Sets or gets a value that indicates whether a check for the browse permission is performed on each inserted document or not. Set this parameter to false for better performance. The default value is false.
	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.)
	InsertedDocuments	Gets the number of documents that actually has been inserted by the Invoke method. If Invoke not has been called, the value is -1.
	NoRecordText	Sets or gets a text to be displayed if no documents are inserted. The default value is "No records found"
	Number	Sets or gets the number of documents you want to insert. If all documents in the current category should be inserted, use value zero. The default value is zero.
	OwnerDocuments	Sets or gets information indicating if only documents created by the owner of current document should be inserted. The default value is false.
	PTID	Sets or gets an optional presentation template for each documents to be inserted. The default value is zero. This field is optional.
	RootOwner	Sets or gets information indicating if the ID of the root document (true) or the ID in the querystring (false) should be used to determine the ownership. The default value is false. This property is only relevant to use if OwnerDocuments is set to true.
	RowColor1	Sets or gets a value that indicates the color of odd lines (1, 3 etc.) in the table. The default value is "#FFFFFF"
	RowColor2	Sets or gets a value that indicates the color of even lines (2, 4 etc) in the table. The default value is "#F5F5F5"
	SortOrder	Sets or gets a value that indicates the sort order of the inserted documents. The default value is DocListSortorder.PublishDateDesc
	StartNumber	Sets or gets a value that defines what document to start inserting from. The order is determined by the sort order. The default value is zero, which is the first document will be inserted.
	TableBorder	Sets or gets a value that indicates the border width of the generated table. The default value is zero (no border).
	TableCaption	Sets or gets the caption element connected to the the generated table. The default value is an empty string, which omits the caption element. Omitting the caption element will cause a warning when validating XHTML 1.0 strict or higher.
	TableCellPadding	Sets or gets a value that indicates the cell padding to use with the generated table. The default value is zero (no cell padding).
	TableCellSpacing	Sets or gets a value that indicates the cell spacing to use with the generated table. The default value is zero (no cell spacing)
	TableSummary	Sets or gets the summary attribute of the generated table. The default value is an empty string which omits the summary attribute. Omitting the summary attribute will cause a warning when validating with XHTML 1.0 strict or higher.
	TableWidth	Sets or gets a value that defines the width attribute of the generated table. The default value is "100%" (use the full width).
	UseApplicationCache	Sets or gets a value indicating if application cache should be used. The default value is false (no application cache is used).
	UseTable	Sets or gets whether to display documents in a table. The default value is false (not using a table).
	Wordwrap	Sets or gets a value indicating if there should be a word wrap (line break) between each inserted document. The default value is true (insert a word wrap).

Top

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke	Invokes the component and writes its content into the specified stream
	ToString	(Inherited from Object.)

Top 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.

Reference