Class CustomFieldDefinition
Provides information describing a CustomField that may be reused across by many items and users.
Inherited Members
Namespace: Algenta.Colectica.Model
Assembly: Algenta.Colectica.Model.dll
Syntax
public class CustomFieldDefinition : NotificationObjectConstructors
CustomFieldDefinition()
Initializes a new instance of the CustomFieldDefinition class.
Declaration
public CustomFieldDefinition()Properties
ControlledVocabularyId
Gets the identifier of the CodeScheme that represents the controlled vocabulary used for this custom field.
Declaration
public TypedIdTriple ControlledVocabularyId { get; set; }Property Value
| Type | Description |
|---|---|
| TypedIdTriple |
ControlledVocabularyTerms
A list of terms from which the user will select one. This can be used instead of specifying the ID of a CodeList.
Declaration
public List<string> ControlledVocabularyTerms { get; }Property Value
| Type | Description |
|---|---|
| List<System.String> |
DefinedTypeId
The unique identifier for the custom field definition.
Declaration
public Guid DefinedTypeId { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
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.
IsLongText
When the ValueType is String, this indicates a multiline text field should be used for user input.
Declaration
public bool IsLongText { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
ItemType
Gets or sets the identifier of the type of IVersionable item to which the custom field applies.
Declaration
public Guid ItemType { get; set; }Property Value
| Type | Description |
|---|---|
| Guid | The identifier of the type of IVersionableitem to which the custom field applies. |
RelationshipTargetType
Gets the type of it that a relationship references.
Declaration
public Guid RelationshipTargetType { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
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.
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 |