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

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

Writes HTML code containing information/statistics for the current document its root document. The code generated is fully HTML/XHTML strict compatible.
Inheritance Hierarchy

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

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

The DocumentInformation type exposes the following members.

Constructors

  NameDescription
Public methodDocumentInformation
Constructs a new instance of the DocumentInformation class that writes to the default response stream
Public methodDocumentInformation(Stream)
Constructs a new instance of the DocumentInformation class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyApproveDate
Sets or gets wheather to display date when document was approved. The default value is false
Public propertyArchiveDate
Sets or gets wheather to display archive date. The default value is false
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 propertyCategory
Sets or gets wheather to display category name. The default value is false
Public propertyClassName
Sets or gets title class name. The default value is an empty string
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 propertyCreatedBy
Sets or gets wheather to display created by. The default value is false
Public propertyCreatedDate
Sets or gets wheather to display created date. The default value is false
Public propertyDateFormat
Sets or gets Sets or gets a value that indicates a format string to use with the custom date format. For a more information on the different time format strings see the System.Globalization.DateTimeFormatInfo class documentation. The default value is g which displays a combination of the short date and long time patterns, separated by a space. The default value is "g"
Public propertyDisplayInTable
Sets or gets whether to display result in a table The default value is false
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
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 propertyModifiedBy
Sets or gets wheather to display modified by. The default value is false
Public propertyModifiedDate
Sets or gets wheather to display modified date. The default value is false
Public propertyPublishDate
Sets or gets wheather to display publish date. The default value is true
Public propertyRequestDate Obsolete.
Sets or gets wheather to display last request date. The default value is false
Public propertyRequests Obsolete.
Sets or gets wheather to display number of requests. The default value is false
Public propertyRevisionNR
Sets or gets wheather to display revision number. The default value is false
Public propertyShowTitles
Sets or gets whether to display titles for each field. The default value is false
Public propertyTableCaption
Sets or gets table caption. The default value is an empty string
Public propertyTableSummary
Sets or gets table summary. The default value is an empty string
Public propertyUnit
Sets or gets wheather to display unit name. The default value is false
Public propertyUseRootDocument
Sets or gets whether to use the root document information instead of the included document. The default value is false
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
This method invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Content Studio permissions

BROWSE permission on the object is required and anonymous callers are supported.
Remarks

  • In older versions of Content Studio it was possible to get document usage data using the document statics API. However, this functionality has been removed for performance reasons.
  • This class can only display information for the most recent published version of a document. If no published version of the document exists a ApplicationException is thrown.
  • This class can throw exceptions thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash.
Examples

The following code demonstrates how to use the DocumentInformation class. The example will write publish date and modfied date of the current document to the response stream.

DocumentInformation docInf = new DocumentInformation();
docInf.PublishDate = true;
docInf.ModifiedBy = true;
docInf.Invoke();
See Also

Reference