Interface IVersioningFile
Methods a versioning file should implement
Namespace: EPiServer.Web.Hosting
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public interface IVersioningFileProperties
CheckedOutBy
Mebership name which have the file checked out.
Declaration
string CheckedOutBy { get; }Property Value
| Type | Description |
|---|---|
| System.String |
IsCheckedOut
File is checked out flag. Good practice on derived classes is that this property can never return true if property IsVersioned returns false.
Declaration
bool IsCheckedOut { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
CheckIn(String)
Checks in the file version.
Declaration
void CheckIn(string comments)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | comments | Check in comments. |
CheckOut()
Checks out the fs file.
Declaration
void CheckOut()GetVersion(Object)
Gets a speciffic version of a file by unique identification.
Declaration
UnifiedVersion GetVersion(object id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | id |
Returns
| Type | Description |
|---|---|
| UnifiedVersion |
GetVersions()
Gets all versions of a versioned file.
Declaration
IList<UnifiedVersion> GetVersions()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IList<UnifiedVersion> |
UndoCheckOut()
Undo the checkout of a file.
Declaration
void UndoCheckOut()