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

public string Preview(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData
)

Public Function Preview ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String
) As String

Parameters

connectionId

Type: ContentStudioConnectionId
A value that identifies the web site

sessionId

Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).

xmlParameterData

Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
The xml has the following parameters defined:

Xml parameter name	Meaning
CategoryId	A category where the document to preview exists
Content	The draft content of the document to preview
HeaderProperties	Header data of the document to preview
DocumentTitle	The title of the document to preview
BodyProperties	The html attributes of the BODY element of the document to preview
ETXml	The EPT content of the document to preview (only applicable for Ept xml documents)
FileExtension	The file extension of the document to preview
ASCode	Component code when previewing an Active Scripting component.
RegisterXml	Embedded directive xml data for registering components.
IsActiveScript	1 when previewing an Active Scripting component; otherwise 0 or omit.

Return Value

An xml document that contains data about files to temporary file to browse. The calling process should remove this file after previewing.

<root>
   <previewfilename></previewfilename>
   <tempfilename></tempfilename>
   <etxmlfilename></etxmlfilename>
   <!-- new in CS 5.3 -->
   <customIdentifier></customIdentifier>
   <url></url>
</root>

The returned xml has the following elements and meaning

Reference