Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingDocumentBase
ContentStudio.Site.ActiveScripting.DocumentInsertDocument
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
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.
This example, which only works in a Content Studio, inserts the content
of a document, formatted by a presentation template, into a HTML document.
[This is preliminary documentation and is subject to change.]
This class writes the content of another document into a stream that
renders HTML code. Only documents without meta data can be correctly
inserted into the HTML code.
The InsertDocument class acts as the underlying engine for the Insert
Document AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingDocumentBase
ContentStudio.Site.ActiveScripting.DocumentInsertDocument
Namespace: ContentStudio.Site.ActiveScripting.Document
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The InsertDocument type exposes the following members.
Constructors
Name | Description | |
---|---|---|
InsertDocument | Initializes a new instance of the InsertDocument class |
Properties
Name | Description | |
---|---|---|
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.) | |
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.) | |
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.) |
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke(Int32) |
Inserts the content of another document into the default Response stream.
| |
Invoke(Int32, Int32) |
Inserts the content of another document into the default Response stream.
| |
Invoke(Stream, Int32) |
Inserts the content of another document into the supplied stream.
| |
Invoke(Stream, Int32, Int32) |
Inserts the content of another document into the supplied stream.
| |
Invoke(Stream, Int32, Int32, SiteBaseCS_EditIconTypes) |
Inserts a document using Server.execute method.
| |
Invoke(Stream, Int32, Int32, SiteBaseCS_EditIconTypes, Int32) |
Inserts a document using Server.execute method.
| |
ToString | (Inherited from Object.) |
Remarks
Examples
int documentId = 18235; int PresentationTemplate = 18538; //Insert the content of a document at the current location and use a presentation template to format it. InsertDocument(DocumentID, PresentationTemplate);
See Also