Class VersionInfo

An instance of this class represents information about one version of one document

Inheritance
object
VersionInfo
Inherited Members
Namespace: SuperOffice.CRM.Documents
Assembly: SuperOffice.Plugins.dll
Syntax
public class VersionInfo
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

Constructors

VersionInfo()

An instance of this class represents information about one version of one document

Declaration
public VersionInfo()
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

Properties

CheckedInByAssociateId

Associate id of the user who performed the checkin

Declaration
public int CheckedInByAssociateId { get; set; }
Property Value
Type Description
int
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

CheckedInByName

Name (nicely formatted) of the user/person who performed the checkin

Declaration
public string CheckedInByName { get; set; }
Property Value
Type Description
string
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

CheckedInDate

The date that this version was checked in and became official

Declaration
public DateTime CheckedInDate { get; set; }
Property Value
Type Description
DateTime
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

Description

Arbitrary description string

Declaration
public string Description { get; set; }
Property Value
Type Description
string
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

DisplayText

A short description, suitable for display in a popup menu or dropdown list of versions.

It is suggested that this string contain user initials, checkin date and the first few words of the description, but it is up to the document plugin to provide whatever it thinks fits the purpose. In menus, the full Description property may be used as a tooltip by the client GUI - though there is no guarantee of that, since there are potentially many clients.
Declaration
public string DisplayText { get; set; }
Property Value
Type Description
string
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

DocumentId

The document Id that uniquely identifies the document within the SuperOffice database

Declaration
public int DocumentId { get; set; }
Property Value
Type Description
int
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

ExternalReference

The document plugin's key that uniquely identifies a document; stored in the externalReference field of the document table

Declaration
public string ExternalReference { get; set; }
Property Value
Type Description
string
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

ExtraFields

Private metadata, owned by the document plugin. This set of metadata is related directly to the version that this VersioNinfo structure describes; metadata related to the document as a whole is retrieved using the LoadMetaData(IDocumentInfo) method.

The string should be formatted like a query string, i.e., name1=value1&name2=value2... - this format, instead of a string/string dictionary avoids serialization problems, even though it is somewhat less efficient
Declaration
public string[] ExtraFields { get; set; }
Property Value
Type Description
string[]
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

VersionId

The document plugin's version id that uniquely identifies one version of a document. If versioning is not supported, this will be blank. When versioning is supported, blank values imply the latest checked-in version.

Declaration
public string VersionId { get; set; }
Property Value
Type Description
string
Remarks

Document plugins that support versioning are responsible for managing versions and provinding these objects. Storage/generation of these properties is the responsibility of the plugin.

Instances of this class can be retrieved using LoadVersionInfo(IDocumentInfo, string) and GetVersionList(IDocumentInfo) methods.

Extension Methods