DocumentWriter Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Represents a non visual component used to configure Content Studio Editing templates.

Inheritance Hierarchy

SystemObject
System.Web.UIControl
ContentStudio.Site.ControlsDocumentWriter

Namespace: ContentStudio.Site.Controls
Assembly: ContentStudio.Site.Controls (in ContentStudio.Site.Controls.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public class DocumentWriter : Control

Public Class DocumentWriter
	Inherits Control

The DocumentWriter type exposes the following members.

Constructors

	Name	Description
	DocumentWriter	Initializes a new instance of the DocumentWriter class.

Top

Properties

	Name	Description
	Adapter	(Inherited from Control.)
	AjaxPostBackIsUsed	If ASP.Net ajax is used this setting should be set to true.
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	BindingContainer	(Inherited from Control.)
	CategoryId	Gets or sets a value that determines the default category to store ept-data in if no category is specified in the querystring.
	CheckinOperationModeForChangedDocuments	Gets or sets a value that determines how to handle check in operations of changed documents.
	CheckinOperationModeForUnchangedDocuments	Gets or sets a value that determines how to handle check in operations of unchanged documents.
	CheckoutOperationMode	Gets or sets a value that determines how to handle checkout operations on existing documents.
	ChildControlsCreated	(Inherited from Control.)
	ClientID	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	Context	(Inherited from Control.)
	Controls	(Inherited from Control.)
	DesignMode	(Inherited from Control.)
	DetermineModificationOutsideEnvironment	Gets or sets a value that determines whether the document is modified outside the environment.
	DisableSaveCheckinCheckoutOperationEventsOnPostBack	If postback is used within an edit template, the postback will trigger save/checkin/checkout operations. You can disable theese operations on post back by enable this setting.
	EnableEditing	Gets or sets a value that determines whether editing of existing documents is allowed.
	EnableTheming	(Inherited from Control.)
	EnableViewState	(Inherited from Control.)
	Events	(Inherited from Control.)
	HasChildViewState	(Inherited from Control.)
	ID	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	IsChildControlStateCleared	(Inherited from Control.)
	IsTrackingViewState	(Inherited from Control.)
	IsViewStateEnabled	(Inherited from Control.)
	LoadViewStateByID	(Inherited from Control.)
	NamingContainer	(Inherited from Control.)
	OnBeforeDocumentApprovedFunction	Gets or sets code to call a client side script function that that executes just before that the document is approved.
	OnBeforeDocumentCheckedinFunction	Gets or sets code to call a client side script function that that executes just before that the document is checked in.
	OnBeforeDocumentCheckedoutFunction	Gets or sets code to call a client side script function that that executes just before that the document is checked out.
	OnBeforeDocumentCreatedFunction	Gets or sets code to call a client side script function that that executes just before that the document is created.
	OnBeforeDocumentDeletedFunction	Gets or sets code to call a client side script function that that executes just before that the document is deleted.
	OnBeforeDocumentPreviewedFunction	Gets or sets code to call a client side script function that that executes just before that the document is being previewed.
	OnBeforeDocumentRejectedFunction	Gets or sets code to call a client side script function that that executes just before that the document is rejected.
	OnBeforeDocumentSavedFunction	Gets or sets code to call a client side script function that that executes just before that the document is saved.
	OnBeforeDocumentSentForVersioningFunction	Gets or sets code to call a client side script function that that executes just before that user sends the document for versioning.
	OnBeforePageLoadedFunction	Gets or sets code to call a client side script function that that executes just before that the page is loaded.
	OnBeforeUserActionPerformedFunction	Gets or sets code to call a client side script function that that executes just before that the user performs a workflow action.
	OnDocumentApprovedFunction	Gets or sets code to call a client side script function that that executes when the document has beed approved.
	OnDocumentCheckedinFunction	Gets or sets code to call a client side script function that that executes when the document has beed checked in.
	OnDocumentCheckedoutFunction	Gets or sets code to call a client side script function that that executes when the document has beed checked out.
	OnDocumentCreatedFunction	Gets or sets code to call a client side script function that that executes when the document has beed created.
	OnDocumentDeletedFunction	Gets or sets code to call a client side script function that that executes when the document has beed deleted (placed in the recycling bin).
	OnDocumentRejectedFunction	Gets or sets code to call a client side script function that that executes when the document has beed rejected.
	OnDocumentSavedFunction	Gets or sets code to call a client side script function that that executes when the document has beed saved.
	OnDocumentSentForVersioningFunction	Gets or sets code to call a client side script function that that executes when a document has been sent for versioning.
	OnPageLoadedFunction	Gets or sets code to call a client side script function that that executes when the document has been loaded.
	OnUserActionPerformedFunction	Gets or sets code to call a client side script function that that executes when a workflow user action has been performed.
	Page	(Inherited from Control.)
	Parent	(Inherited from Control.)
	SaveOperationModeForChangedDocuments	Gets or sets a value that determines how to handle save operations of changed documents.
	SaveOperationModeForUnchangedDocuments	Gets or sets a value that determines how to handle save operations of unchanged documents.
	SaveState	Gets or sets a value that determines how to save operations will be carried out.
	Site	(Inherited from Control.)
	SkinID	(Inherited from Control.)
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	UniqueID	(Inherited from Control.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	Visible	(Inherited from Control.)

Top

Methods

	Name	Description
	AddedControl	(Inherited from Control.)
	AddParsedSubObject	(Inherited from Control.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	CreateChildControls	(Inherited from Control.)
	CreateControlCollection	(Inherited from Control.)
	DataBind	(Inherited from Control.)
	DataBind(Boolean)	(Inherited from Control.)
	DataBindChildren	(Inherited from Control.)
	Dispose	(Inherited from Control.)
	EnsureChildControls	(Inherited from Control.)
	EnsureID	(Inherited from Control.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindControl(String)	(Inherited from Control.)
	FindControl(String, Int32)	(Inherited from Control.)
	Focus	(Inherited from Control.)
	GetCurrent	Gets the DocumentWriter on a specific Page.
	GetDesignModeState	(Inherited from Control.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadViewState	(Inherited from Control.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnInit	(Inherited from Control.)
	OnLoad	Raises the Init event. (Overrides ControlOnLoad(EventArgs).)
	OnPreRender	(Inherited from Control.)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	RaiseBubbleEvent	(Inherited from Control.)
	RemovedControl	(Inherited from Control.)
	Render	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Overrides ControlRender(HtmlTextWriter).)
	RenderChildren	(Inherited from Control.)
	RenderControl(HtmlTextWriter)	(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	(Inherited from Control.)
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from Control.)
	SetDesignModeState	(Inherited from Control.)
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from Control.)

Top

Events

	Name	Description
	DataBinding	(Inherited from Control.)
	Disposed	(Inherited from Control.)
	Init	(Inherited from Control.)
	Load	(Inherited from Control.)
	PreRender	(Inherited from Control.)
	Unload	(Inherited from Control.)

Top

Remarks

To use all functionality the client needs Internet Explorer, Mozilla Firefox or a Webkit browser (Chrome / Safari). DocumentWriter is intended to be used with one of more EptButton controls

Reference

ContentStudio.Site.Controls Namespace