Show / Hide Table of Contents

Class VersionableExtensions

Provides various extension methods useful for working with IVersionable items.

Inheritance
object
VersionableExtensions
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Utility
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public static class VersionableExtensions

Methods

GetHeader(IVersionable, bool)

Gets a display label for the item, based on the item's content.

Declaration
public static string GetHeader(this IVersionable item, bool noNameWithLabel = false)
Parameters
Type Name Description
IVersionable item

The item.

bool noNameWithLabel
Returns
Type Description
string

GetMetadata(IVersionable)

Transforms a local IVersionable to a RepositoryItemMetadata via local processing.

Declaration
public static RepositoryItemMetadata GetMetadata(this IVersionable item)
Parameters
Type Name Description
IVersionable item

The item.

Returns
Type Description
RepositoryItemMetadata

GetUserAttribute(IVersionable, string)

Gets the value of a UserAttributePair.

Declaration
public static CodeValue GetUserAttribute(this IVersionable item, string key)
Parameters
Type Name Description
IVersionable item
string key
Returns
Type Description
CodeValue

GetUserAttributeInt(IVersionable, string)

Gets an integer user attribute of an item.

Declaration
public static int? GetUserAttributeInt(this IVersionable item, string key)
Parameters
Type Name Description
IVersionable item
string key
Returns
Type Description
int?

SetUserAttribute(IVersionable, string, string)

Sets a UserAttributePair on the item.

Declaration
public static void SetUserAttribute(this IVersionable item, string key, string value)
Parameters
Type Name Description
IVersionable item
string key
string value
In this article
Back to top Generated by DocFX