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

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

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.
Inheritance Hierarchy

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

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

The InsertAuthor type exposes the following members.

Constructors

  NameDescription
Public methodInsertAuthor
Constructs a new instance of the InsertAuthor class .
Public methodInsertAuthor(Stream)
Constructs a new instance of the InsertAuthor class that writes to the supplied stream
Public methodInsertAuthor(MasterPageBase)
Constructs a new instance of the InsertAuthor class.
Public methodInsertAuthor(SiteBase)
Constructs a new instance of the InsertAuthor class.
Public methodInsertAuthor(UserControlBase)
Constructs a new instance of the InsertAuthor class.
Public methodInsertAuthor(SiteBase, UserControlBase)
Constructs a new instance of the InsertAuthor class.
Public methodInsertAuthor(Stream, SiteBase, UserControlBase)
Constructs a new instance of the InsertAuthor 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 propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyInfo
Sets or gets a value that indicates which personal information to display. The default value is InfoToInsert.NameOnly
Public propertyPerson
Sets or gets a value that indicates which author information to display, the creator or the modifier. The default value is PersonToInsert.Creator
Public propertyUseRootDocument
Sets or gets a value that indicates whether to insert the root document information or not. The default value is true.
Public propertyUseXmlDocument
Sets or gets a value that indicates whether to insert information for the XML document, when the current document is a presentation template. This property should always be set to true in a presentation template, unless you would like information about the template itself. 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
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