DropdownFieldChoice Class |
Item of a drop-down metadata field.
Inheritance HierarchyNamespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
SyntaxC#
[SerializableAttribute] public class DropdownFieldChoice : IEquatable<DropdownFieldChoice>
The DropdownFieldChoice type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DropdownFieldChoice | Initializes a new instance of the DropdownFieldChoice class |
Properties| Name | Description | |
|---|---|---|
 | ChoiceOrder |
The value of the counter which specifies the order of items.
|
| FirstSearchBy |
The optional value of the first "Search By" column for a lookup dropdown field.
This value is null for a FileHold managed dropdown field.
|
| FourthSearchBy |
The optional value of the fourth "Search By" column for a lookup dropdown field.
This value is null for a FileHold managed dropdown field.
|
| Id |
The internal identifier used by FileHold to track this drop-down item. This identifier
is returned from Document Finder and should be passed to Document Manager to edit the metadata
of a document.
|
| SecondSearchBy |
The optional value of the second "Search By" column for a lookup dropdown field.
This value is null for a FileHold managed dropdown field.
|
| SourceChoiceId |
The unique key of the item for a lookup dropdown field, which is the value the "Lookup By" column.
This value is null for a FileHold managed dropdown field.
|
| ThirdSearchBy |
The optional value of the third "Search By" column for a lookup dropdown field.
This value is null for a FileHold managed dropdown field.
|
| Value |
The name of the drop-down item visible to the user. For a database lookup dropdown field,
this is the value of the "Retrieve From" column.
|
MethodsExtension Methods| Name | Description | |
|---|---|---|
 | ConvertT | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
Remarks
Use the GetDropDownMenuItems() method of the Document Schema Manager to retrieve all items
of a drop-down metadata field. Use the GetDropDownMenuItemsByIDs() method to retrieve only items
with specific identifiers or the GetDropDownMenuItemsByNames() method to retrieve items with given
names.
In order to add, edit or remove existing items, use the ChangeGlobalField() method and pass the
new array of items in the GlobalFieldDefinition class. Existing items will be compared by the internal
Id, specify negative values when adding new items.
See Also