Class CustomField

Provides the ability to add information to an existing IVersionable item type, beyond the information built into the item type.

Inheritance

Object

CustomField

Implements

INotifyPropertyChanged

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Algenta.Colectica.Model

Assembly: Algenta.Colectica.Model.dll

Syntax

public class CustomField : INotifyPropertyChanged

Constructors

CustomField()

Initializes a new instance of the CustomField class.

Declaration

public CustomField()

CustomField(Guid, String, MultilingualString)

Initializes a new instance of the CustomField class.

Declaration

public CustomField(Guid definedTypeId, string fieldTitle, MultilingualString value)

Parameters

Type	Name	Description
Guid	definedTypeId	The identifier of the CustomFieldDefinition on which the custom field is based.
String	fieldTitle	The title of the custom field.
MultilingualString	value	The value of the custom field.

Properties

ControlledVocabularyId

Gets or sets the controlled vocabulary unique identifier.

Declaration

public TypedIdTriple ControlledVocabularyId { get; set; }

Property Value

Type	Description
TypedIdTriple	The controlled vocabulary unique identifier.

DateValue

Gets or sets the date value stored in the custom field.

Declaration

public DateTime? DateValue { get; set; }

Property Value

Type	Description
Nullable<DateTime>	The date value stored in the custom field.

DefinedTypeId

The identifier of the CustomFieldDefinition, if one is applicable.

Declaration

public Guid? DefinedTypeId { get; set; }

Property Value

Type	Description
Nullable<Guid>

Remarks

CustomFieldDefinitions define a custom field that may be reused across Colectica installations.

Description

Gets the description of the custom field.

Declaration

public MultilingualString Description { get; }

Property Value

Type	Description
MultilingualString

Remarks

The description is displayed as help text when information held in a custom field is displayed.

DisplayLabel

Gets the display label used when a list of CustomField objects is displayed.

Declaration

public string DisplayLabel { get; }

Property Value

Type	Description
String	The display label.

HasDefinedType

Gets a value indicating whether this instance is based on a defined custom field type.

Declaration

public bool HasDefinedType { get; }

Property Value

Type	Description
Boolean	true if this instance is based on a defined custom field type; otherwise, false.

HasValue

Gets a value indicating whether has a value.

Declaration

public bool HasValue { get; }

Property Value

Type	Description
Boolean	true if there is a value; otherwise, false.

MultilingualStringValue

Gets the multilingual string value stored in the custom field.

Declaration

public MultilingualString MultilingualStringValue { get; }

Property Value

Type	Description
MultilingualString

MultipleRelatedItemIdsValue

Gets or sets the related item unique identifier value.

Declaration

public ObservableCollection<TypedIdTriple> MultipleRelatedItemIdsValue { get; set; }

Property Value

Type	Description
ObservableCollection<TypedIdTriple>	The related item unique identifier value.

NumberValue

Gets the number value stored in the custom field.

Declaration

public decimal? NumberValue { get; set; }

Property Value

Type	Description
Nullable<Decimal>

RelatedItemIdValue

Gets or sets the related item unique identifier value.

Declaration

public TypedIdTriple RelatedItemIdValue { get; set; }

Property Value

Type	Description
TypedIdTriple	The related item unique identifier value.

RelationshipTargetType

Gets or sets the type of the relationship target.

Declaration

public Guid RelationshipTargetType { get; set; }

Property Value

Type	Description
Guid	The type of the relationship target.

StringValue

Gets or sets the string value stored in the custom field.

Declaration

public string StringValue { get; set; }

Property Value

Type	Description
String	The string value stored in the custom field.

Title

Gets the title of the custom field.

Declaration

public MultilingualString Title { get; }

Property Value

Type	Description
MultilingualString

Remarks

The title is treated as the label when information held in a custom field is displayed.

UriValue

Gets or sets the URI value stored in the custom field.

Declaration

public Uri UriValue { get; set; }

Property Value

Type	Description
Uri	The URI value stored in the custom field.

ValueType

Gets or sets the type of the value held in the custom field.

Declaration

public CustomFieldType ValueType { get; set; }

Property Value

Type	Description
CustomFieldType	The type of the value held in the custom field.

ValueTypes

Gets the value types that can be held by custom fields.

Declaration

public static Array ValueTypes { get; }

Property Value

Type	Description
Array

Methods

OnPropertyChanged(String)

Raises the PropertyChanged event.

Declaration

public void OnPropertyChanged(string propertyName)

Parameters

Type	Name	Description
String	propertyName	Name of the property.

ToString()

Returns a string representation of the current value

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Events

PropertyChanged

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods

Extensions.Yield<T>(T)