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

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

The InsertMultipleDocuments type exposes the following members.

Properties

  Name Description
Public property 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.
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 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.
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.
(Overrides ActiveScriptingBaseConformance.)
Public property 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.
Public property ElementType
Gets a value which specifies the type of outer element the component generates.
(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 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.
Public property NoRecordText
Sets or gets a text to be displayed if no documents are inserted. The default value is "No records found"
Public property 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.
Public property OwnerDocuments
Sets or gets information indicating if only documents created by the owner of current document should be inserted. The default value is false.
Public property PTID
Sets or gets an optional presentation template for each documents to be inserted. The default value is zero. This field is optional.
Public property 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.
Public property RowColor1
Sets or gets a value that indicates the color of odd lines (1, 3 etc.) in the table. The default value is "#FFFFFF"
Public property RowColor2
Sets or gets a value that indicates the color of even lines (2, 4 etc) in the table. The default value is "#F5F5F5"
Public property SortOrder
Sets or gets a value that indicates the sort order of the inserted documents. The default value is DocListSortorder.PublishDateDesc
Public property 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.
Public property TableBorder
Sets or gets a value that indicates the border width of the generated table. The default value is zero (no border).
Public property 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.
Public property 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).
Public property 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)
Public property 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.
Public property TableWidth
Sets or gets a value that defines the width attribute of the generated table. The default value is "100%" (use the full width).
Public property UseApplicationCache
Sets or gets a value indicating if application cache should be used. The default value is false (no application cache is used).
Public property UseTable
Sets or gets whether to display documents in a table. The default value is false (not using a table).
Public property 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
See Also

Reference