Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
[This is preliminary documentation and is subject to change.]
Disposes temporary files after a complete preview.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void PreviewDispose( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId, string[] filesToRemove, string customIdentifier, string url )
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). - categoryId
- Type: ContentStudio.DocumentCategoryId
The category where the file just previewed exists. This category must exist. - filesToRemove
- Type: SystemString
An array of file names of the temporary preview files to remove. These files must be valid preview files. - customIdentifier
- Type: SystemString
Identifies an external identifiers that an event actions handler can use to remove data in an external content store. This parameter can be null. - url
- Type: SystemString
An url or that an event actions handler can use to remove data in an external content store. This parameter can be null.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | filesToRemove is null. |
ArgumentException | The category does not exist |
ApplicationException | |
CSException | |
SqlException |
Remarks
This method was added in Content Studio 5.3 in order to be able to serve the OnDocumentPreview synchronous event action.
See Also