ContentStudio.Site.ActiveScripting.Document Namespace Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This namespace contains the code behind implementation for all the document aware Content Studio components.
Classes

  Class Description
Public class CountChildren
Writes a SPAN element to the supplied stream or the default response stream. The Count Children class acts as the underlying engine for the Count Children AS component.
Public class DeleteDocument
Writes an HTML insert button or link to delete the current document, to the supplied stream or the default response stream. The DeleteDocument class acts as the underlying engine for the Delete document AS component.
Public class Code example DocumentInformation
Writes HTML code containing information/statistics for the current document its root document. The code generated is fully HTML/XHTML strict compatible.
Public class DocumentLevelInformation
Inserts level dependent information for a certain document This class writes code to the supplied stream or the default response stream. The DocumentLevelInformation class acts as the underlying engine for the Document level information AS component.
Public class InsertAuthor
Creates HTML code containing information about the creator or the modifier of a document. It writes to the supplied stream or the default response stream. The InsertAuthor class acts as the underlying engine for the Insert Author AS component. Anonymous callers are supported, provided that they can browse the document.
Public class InsertBacklink
Writes a link to the last page to the supplied stream or the default response stream. The InsertBacklink class acts as the underlying engine for the Insert Backlink AS component.
Public class InsertChildren
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.
Public class InsertCommaSeparatedDocuments
Inserts published documents, specified in a comma-delimited list, into the supplied stream or the default response stream. All documents must be located in a specific category. All documents and EPT documents must be of a type without meta data. The InsertCommaSeparatedDocuments class acts as the underlying engine for the Insert Comma Separated Documents AS component.
Public class Code example InsertDocument
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.
Public class Code example InsertDocumentFromURL
This class writes HTML from an external http source to the supplied stream or the default response stream. The InsertDocumentFromURL class acts as the underlying engine for the InsertDocumentFromURL AS component.
Public class InsertMultipleDocuments
Inserts multiple documents and writes HTML to the supplied stream or the default response stream. The documents should not contain meta data. The InsertMultipleDocuments class acts as the underlying engine for the Insert multiple documents AS component.
Public class InsertNumberOfChildren
Writes the number of children of a specified document to the supplied stream or the default response stream. The InsertNumberOfChildren class acts as the underlying engine for the Insert number of children AS component.
Public class LastModified
Writes HTML code containing information about when a document was last modified, to the supplied stream or the default response stream. Anonymous callers are supported, provided that they can browse the referenced document. The LastModified class acts as the underlying engine for the Last modified AS component.
Public class Code example ListChildren
Writes a TABLE containing list of direct child documents of a document to the supplied stream or the default response stream. The List Children class acts as the underlying engine for the List Children AS component.
Protected class ListChildrenDataRow
This class is used internally and by inheriting classes when parsing data from the retrieved xml. This class is used by the ListChildren class when parsing xml.
Public class Code example ListDocuments20
Lists information about documents from a category in a table. The content of the document will not be displayed. The ListDocuments20 class acts as the underlying engine for the List documents 2.0 AS component.
Public class OpenWindow
Writes a link or button with an open window script fragment in the supplied stream or the default response stream. The script is activated on the click event, opens a new window and loads the document specified by a given URL. The OpenWindow class acts as the underlying engine for the Open Window AS component.
Public class PreviewDraftButton
This class writes html code to the supplied stream or the default response stream. The PreviewDraftButton class acts as the underlying engine for the PreviewDraftButton AS component and generates an ordinary button that via java script opens a browser popup dialog that enables the caller to preview the document just beeing edited.
Public class RandomizeDocuments
Inserts a random document from a list of documents to the supplied stream or the default response stream. The RandomizeDocuments class acts as the underlying engine for the Randomize Documents AS component.
Public class RotateDocuments
Inserts a random document from a category to the supplied stream or the default response stream. The RotateDocuments class acts as the underlying engine for the Rotate Documents AS component.
Enumerations

  Enumeration Description
Public enumeration DeleteDocumentLinkTypes
Defines what type of element delete document should generate
Public enumeration InsertAuthorInfoToInsert
Indicate which information about the author that should be inserted.
Public enumeration InsertAuthorPersonToInsert
Indicates for which author information should be inserted.
Public enumeration ListChildrenColumnDefinition
Defines the columns that should be displayed
Public enumeration ListChildrenListOrientation
Defines how the list will be oriented
Public enumeration ListChildrenListSorting
Defines how the list of child documents should be sorted
Public enumeration ListDocuments20Documentfield
An enumeration that defines meta-data on a document. Use it with AddColumn() to specify which columns to display.