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

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

Writes a DIV section containing a number of documents to the supplied stream or the default response stream. The Insert Children class acts as the underlying engine for the Insert Children AS component.
Inheritance Hierarchy

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

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 InsertChildren : DocumentBase

The InsertChildren type exposes the following members.

Constructors

  NameDescription
Public methodInsertChildren
Constructs a new instance of the InsertChildren class that writes to the default response stream
Public methodInsertChildren(Stream)
Constructs a new instance of the InsertChildren 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 propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncapsulate
Sets or gets a value that indicates if the each part should be encapsulated in separate DIV elements. The default value is false.
Public propertyEncapsulateAll
Sets or gets a value that indicates if the whole object should be encapsulated by a DIV element. The default value is false.
Public propertyEncapsulateAllClass
Sets or gets the name of a CSS style class name to use to format a DIV section defined with EncapsulateAll property. The default value is an empty string
Public propertyEncapsulateClass
Sets or gets the name of a CSS style class name to use to format a DIV section defined with Encapsulate property. The default value is an empty string
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 propertyParentID
Sets or gets a value a value that indicates the ID of the parent document. The default value is zero witch means the current document will be used as parent.
Public propertyPTID
Sets or gets a value a value that indicates the ID of the presentation template document. The default value is zero, witch means that no presentation template is defined.
Public propertySortOrderProperty
Sets or gets a value that indicate which sort order to use. The default value is DocumentOrder.
Public propertyWordWrap
Sets or gets a value that indicate if it should be possible to wrap words within the DIV section. The default value is true.
Top
Methods

  NameDescription
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