Class VersionControl

Namespace

Dynamicweb.Content.Versioning

Assembly

Dynamicweb.dll

Handles version data

public class VersionControl

Inheritance

object

VersionControl

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Used internally by Paragraph.

Constructors

VersionControl()

public VersionControl()

Fields

PageItemType

public const string PageItemType = "Page item"

Field Value

string

Methods

CleanUpVersions(IEnumerable<string>, IEnumerable<string>)

Cleans version older then specified days with specified threshold.

public void CleanUpVersions(IEnumerable<string> versionDataTypes, IEnumerable<string> ids)

Parameters

versionDataTypes IEnumerable<string>

e.g. "Product", "CategoryFields".

ids IEnumerable<string>

Remarks

Works only with objects using VersionDataTypeIdString, but not VersionDataTypeId!!

CleanUpVersions(string[], int, int)

Cleans version older then specified days with specified threshold.

public void CleanUpVersions(string[] versionDataTypes, int days, int versions)

Parameters

versionDataTypes string[]

e.g. "Product", "CategoryFields".

days int

Specifies the days older than that the versions are going to be deleted.

versions int

Specifies the versions threshhold.

Remarks

Works only with objects using VersionDataTypeIdString, but not VersionDataTypeId!!

DiscardChanges(string, string)

Discards the version changes for the version data .

public void DiscardChanges(string versionDataType, string versionDataTypeId)

Parameters

versionDataType string

The type of version data object i.e. "Page", "Product" etc.

versionDataTypeId string

The version data object id.

FindVersions(string, string)

public IEnumerable<VersionData> FindVersions(string type, string searchKey)

Parameters

type string

searchKey string

Returns

IEnumerable<VersionData>

GetAllVersions(string, string)

public IEnumerable<VersionData> GetAllVersions(string type, string key)

Parameters

type string

key string

Returns

IEnumerable<VersionData>

GetAllVersionsContainsKeyPart(string, string)

public IEnumerable<VersionData> GetAllVersionsContainsKeyPart(string type, string keyPart)

Parameters

type string

keyPart string

Returns

IEnumerable<VersionData>

Load(DataSet, string, string, DateTime)

Loads the specified ds.

public void Load(DataSet ds, string type, string key, DateTime previewDate)

Parameters

ds DataSet

Copied dataset

type string

The type.

key string

The key.

previewDate DateTime

The preview date.

LoadAllVersions(DataSet, string, string)

public void LoadAllVersions(DataSet ds, string type, string key)

Parameters

ds DataSet

type string

key string

LoadAllVersions(DataSet, string, string, DateTime)

public void LoadAllVersions(DataSet ds, string type, string key, DateTime publishTime)

Parameters

ds DataSet

type string

key string

publishTime DateTime

LoadItem(int)

Loads the specified item.

public static ItemEntry? LoadItem(int pageId)

Parameters

pageId int

Returns

ItemEntry

PublishVersion(string, string, DateTime)

public void PublishVersion(string versionDataType, string versionDataTypeId, DateTime publishTime)

Parameters

versionDataType string

versionDataTypeId string

publishTime DateTime

Save(DataSet, string, string)

Saves the specified version data from the dataset.

public void Save(DataSet ds, string type, string key)

Parameters

ds DataSet

The ds.

type string

The type.

key string

The key.

UpdatePublishedVersion(int)

public static void UpdatePublishedVersion(int versionDataId)

Parameters

versionDataId int