Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingDocumentBase
ContentStudio.Site.ActiveScripting.DocumentDocumentInformation
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
BROWSE permission on the object is required and anonymous callers are supported.
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.
[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
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
The DocumentInformation type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocumentInformation |
Constructs a new instance of the DocumentInformation class that writes to the default response stream
| |
DocumentInformation(Stream) |
Constructs a new instance of the DocumentInformation class that writes to the supplied stream
|
Properties
Name | Description | |
---|---|---|
ApproveDate |
Sets or gets wheather to display date when document was approved.
The default value is false
| |
ArchiveDate |
Sets or gets wheather to display archive date.
The default value is false
| |
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.) | |
Category |
Sets or gets wheather to display category name.
The default value is false
| |
ClassName |
Sets or gets title class name.
The default value is an empty string
| |
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.) | |
CreatedBy |
Sets or gets wheather to display created by.
The default value is false
| |
CreatedDate |
Sets or gets wheather to display created date.
The default value is false
| |
DateFormat |
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"
| |
DisplayInTable |
Sets or gets whether to display result in a table
The default value is false
| |
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.) | |
ModifiedBy |
Sets or gets wheather to display modified by.
The default value is false
| |
ModifiedDate |
Sets or gets wheather to display modified date.
The default value is false
| |
PublishDate |
Sets or gets wheather to display publish date.
The default value is true
| |
RequestDate | Obsolete.
Sets or gets wheather to display last request date.
The default value is false
| |
Requests | Obsolete.
Sets or gets wheather to display number of requests.
The default value is false
| |
RevisionNR |
Sets or gets wheather to display revision number.
The default value is false
| |
ShowTitles |
Sets or gets whether to display titles for each field.
The default value is false
| |
TableCaption |
Sets or gets table caption.
The default value is an empty string
| |
TableSummary |
Sets or gets table summary.
The default value is an empty string
| |
Unit |
Sets or gets wheather to display unit name.
The default value is false
| |
UseRootDocument |
Sets or gets whether to use the root document information instead of the included document.
The default value is false
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
This method invokes the component and writes its content into the specified stream
| |
ToString | (Inherited from Object.) |
Content Studio permissions
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
DocumentInformation docInf = new DocumentInformation(); docInf.PublishDate = true; docInf.ModifiedBy = true; docInf.Invoke();
See Also