AnonymousWriter Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Allows anonymous users to store data in Content Studio. The data is written as HTML to the supplied stream or the default response stream. The AnonymousWriter class acts as the underlying engine for the Anonymous Writer AS component. The component is intended to be used with a submit form. The corresponding EPT category must have "Use server side validation" set. To edit an existing document, the flags runat="server" and EnableViewState must be set. This class supports the synchronous event OnBeforeDocumentSave.

Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.EPTAnonymousWriter

Namespace: ContentStudio.Site.ActiveScripting.EPT
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public sealed class AnonymousWriter : EPTBase

Public NotInheritable Class AnonymousWriter
	Inherits EPTBase

The AnonymousWriter type exposes the following members.

Constructors

	Name	Description
	AnonymousWriter	Constructs a new instance of the AnonymousWriter class that writes to the default response stream
	AnonymousWriter(Stream)	Constructs a new instance of the AnonymousWriter class that writes to the supplied stream

Top

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.)
	ButtonNameToReactOn	Optional: Name on the submit button name to react on. If set, pressing the button with the specified name will trigger the writing to start. The default value is an empty string (no optional button name is used).
	CategoryId	Gets or sets the category where to store the document. The default value is zero.
	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.)
	OKDocument	Optional: The document to redirect to when user has submitted the form. The default value is zero (not used).
	OKPT	Optional: The presentation template to use when user has submitted the form. The default value is zero (not used).
	RedirectionLevel	Tells what entity to redirect to, after saving the document. The default value is Redirection.RedirectToCreatedDocument.
	SaveState	Tells what action to take when saving a document. The default value is ReviseControl.Draft.
	WasCreated	Returns true if the document was successfully created.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke	Invokes the component and writes its content into the specified stream
	ToString	(Inherited from Object.)

Top

Remarks

To use this class, create an instance of this object, set the properties that does not have the values you expect, and call the Invoke method. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash.

Reference

ContentStudio.Site.ActiveScripting.EPT Namespace