Interface IVersionedFile
Can be implemented by an IFileHandler to support versioning of files.
Namespace: EPiServer.Web.Hosting.Versioning
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public interface IVersionedFileProperties
ChangedBy
Username of the user that changed the file.
Declaration
string ChangedBy { get; }Property Value
| Type | Description |
|---|---|
| System.String |
CheckedOut
If checked out; the date when the file was checked out.
Declaration
DateTime CheckedOut { get; }Property Value
| Type | Description |
|---|---|
| System.DateTime |
CheckedOutBy
If checked out; the username of the user who has this file checked out.
Declaration
string CheckedOutBy { get; }Property Value
| Type | Description |
|---|---|
| System.String |
CreatedBy
The username of the user that created this file.
Declaration
string CreatedBy { get; }Property Value
| Type | Description |
|---|---|
| System.String |
IsCheckedOut
Check whether the file is checked out.
Declaration
bool IsCheckedOut { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
CheckIn(String)
Check in file, requires the file to be checked out first.
Declaration
void CheckIn(string comments)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | comments | Comments entered by the user. |
CheckOut()
Called to check out a file.
Declaration
void CheckOut()GetCheckedOutVersion()
Called when the checked out version needs to be retrieved for a user.
Declaration
IFileVersion GetCheckedOutVersion()Returns
| Type | Description |
|---|---|
| IFileVersion |
GetVersions()
Gets a list of all versions.
Declaration
IFileVersion[] GetVersions()Returns
| Type | Description |
|---|---|
| IFileVersion[] |
UndoCheckOut()
Called when a user wants to undo a checked out file.
Declaration
void UndoCheckOut()