FileHold 17.0 API Documentation
FileHold 17.0 API Reference
FileHold.LibraryManager
DocumentSchemaManager Class
DocumentSchemaManager Methods
AddDocumentControlField Method
AddDocumentSchema Method
AddDocumentSchemaField Method
AddEvent Method
AddGlobalField Method
AddVersionControlField Method
AreDocumentTypesCompatible Method
ChangeDocumentSchema Method
ChangeGlobalField Method
CheckHasAccessToSchemaInCabinet Method
CheckIfItemIsAssociatedWithDocuments Method
CreateDocumentSchema Method
DeleteDocumentControlField Method
DeleteDocumentSchema Method
DeleteDocumentSchemaFieldDefinition Method
DeleteEvent Method
DeleteVersionControlField Method
GetAllDocumentsSchemas Method
GetAllFields Method
GetAllowedConversionsInFolder Method
GetAvailableCurrencySymbols Method
GetAvailableDateFormats Method
GetAvailableDecimalSeparators Method
GetAvailableGroupSeparators Method
GetAvailableNegativeColors Method
GetAvailableNegativeFormats Method
GetChoicesFromSource Method
GetChoicesFromSourceForPreview Method
GetControlFieldsOverview Method
GetDataProviders Method
GetDefaultFolderSchemaId Method
GetDocumentControlField Method
GetDocumentControlFieldsList Method
GetDocumentDetailsFields Method
GetDocumentSchema Method
GetDocumentSchemaFields Method
GetDocumentSchemaFieldsIncludingInvisible Method
GetDocumentSchemasInfoList Method
GetDocumentSchemasOverviewList Method
GetDocumentSchemaType Method
GetDrillDownMenuItemByID Method
GetDrilldownMenuItems Method
GetDrillDownMenuPathByID Method
GetDropDownMenuItems Method
GetDropDownMenuItemsByIDs Method
GetDropDownMenuItemsByNames Method
GetDropDownMenuItemsForImport Method
GetDropDownMenuItemsPaged Method
GetElectronicSchemaList Method
GetEventDefinition Method
GetEventsList Method
GetEventsOverview Method
GetFieldsInfo Method
GetFieldsList Method
GetFieldsOverviewInfoList Method
GetFieldsOverviewList Method
GetFieldsOverviewListIncludingInvisible Method
GetFilteredDropDownMenuItems Method
GetFirstCharactersOfDocumentSchemas Method
GetFirstCharactersOfGlobalFields Method
GetGlobalField Method
GetGlobalFieldFast Method
GetGlobalFields Method
GetOfflineSchemaList Method
GetPagedDocumentSchemaFields Method
GetPagedDocumentSchemaFieldsCount Method
GetReindexWarningThreshold Method
GetSchemaList Method
GetSchemaListAdvanced Method
GetSchemaListForCabinet Method
GetSchemaListNoCustomNaming Method
GetSchemaListOfConvertedType Method
GetSchemaListOfDocumentType Method
GetSchemaListOfSelectionType Method
GetUserDateFormats Method
GetVersionControlField Method
GetVersionControlFieldsList Method
IsCustomNamingPatterModified Method
IsDocumentSchemaUsed Method
IsMetadataFieldUsed Method
IsReindexWarningThresholdReached Method
LookupMetadata Method
LookupMultiMetadata Method
RemoveDocumentSchemaField Method
RemoveEventNotifications Method
SetFieldsOrder Method
UpdateDocumentControlField Method
UpdateEvent Method
UpdateVersionControlField Method
VerifyConnection Method
VerifyFieldSourceSettings Method
VerifyLookupConnection Method
VerifySourceSettings Method
Click or drag to resize

DocumentSchemaManagerAddGlobalField Method

Creates new metadata field (also called "global field" in the API)

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
Copy
public int AddGlobalField(
	GlobalFieldDefinition field,
	ref bool exceeded
)

Parameters

field
Type: FileHold.LibraryManagerGlobalFieldDefinition
details of the field to create
exceeded
Type: SystemBoolean
notification that field contains a large amount of data

Return Value

Type: Int32
id of created field
See Also