Click or drag to resize

DocumentSchemaManager Class

Service for managing document schemas and metadata fields.
Inheritance Hierarchy

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
public class DocumentSchemaManager : WebService

The DocumentSchemaManager type exposes the following members.

Constructors
  NameDescription
Public methodDocumentSchemaManager
Initializes a new instance of the DocumentSchemaManager class
Top
Properties
  NameDescription
Public propertyReindexWarningThreshold
Top
Methods
  NameDescription
Public methodAddDocumentControlField
Create a new Document Control Field.
Public methodAddDocumentSchema
Adds new document schema with fields
Public methodAddDocumentSchemaField
Adds field definition to document schema
Public methodAddEvent
Create a new event definition.
Public methodAddGlobalField
Creates new metadata field (also called "global field" in the API)
Public methodAddVersionControlField
Create a new Version Control Field.
Public methodAreDocumentTypesCompatible
This method is obsolete.
Public methodChangeDocumentSchema
Sets new details for schema
Public methodChangeGlobalField
Changes definition of metadata field
Public methodCheckHasAccessToSchemaInCabinet
Checks whether user is allowed to add document in particular schema to specified cabinet
Public methodCheckIfItemIsAssociatedWithDocuments
Check if a metadata field has values with given dropdown or drilldown menu item
Public methodCreateDocumentSchema
Creates document schema
Public methodDeleteDocumentControlField
Delete a Document Control Field.
Public methodDeleteDocumentSchema
Deletes document schema
Public methodDeleteDocumentSchemaFieldDefinition
Deletes document schema field definition
Public methodDeleteEvent
Delete an event definition.
Public methodDeleteVersionControlField
Delete a Version Control Field.
Public methodGetAllDocumentsSchemas
Retrieves the details of all available document schemas.
Public methodGetAllFields
Retrieves the details of all available metadata fields (without drop down menu items).
Public methodGetAllowedConversionsInFolder
Calculate allowed document type conversions in given folder
Public methodGetAvailableCurrencySymbols
Returns available currency symbols
Public methodGetAvailableDateFormats
Returns available date formats
Public methodGetAvailableDecimalSeparators
Returns available decimal separators
Public methodGetAvailableGroupSeparators
Returns available group separators
Public methodGetAvailableNegativeColors
Returns available colors for negative numbers
Public methodGetAvailableNegativeFormats
Returns available formats for negative numbers
Public methodGetChoicesFromSource
Retrieves choices from specified source
Public methodGetChoicesFromSourceForPreview
Retrieves choices from specified source
Public methodGetControlFieldsOverview
Get an overview list of all Document and Version Control Fields
Public methodGetDataProviders
Return available custom data providers
Public methodGetDefaultFolderSchemaId
Retrieve default schema ID for folder.
Public methodGetDocumentControlField
Get details of a Document Control Field.
Public methodGetDocumentControlFieldsList
Get a list of all existing Document Control Fields.
Public methodGetDocumentDetailsFields
Returns all metadata fields of particular schema and DocumentName system field
Public methodGetDocumentSchema
Retrieves schema's details
Public methodGetDocumentSchemaFields
Returns all metadata fields of particular schema
Public methodGetDocumentSchemaFieldsIncludingInvisible
Returns all metadata fields of particular schema (with fields marked as not visible)
Public methodGetDocumentSchemasInfoList
Lists document schemas start with the specified string
Public methodGetDocumentSchemasOverviewList
Lists all document schemas present in system providing general information about them.
Public methodGetDocumentSchemaType
Return default format of given schema
Public methodGetDrillDownMenuItemByID
Public methodGetDrilldownMenuItems
Returns collection of drill-down choices specified for particular field
Public methodGetDrillDownMenuPathByID
Public methodGetDropDownMenuItems
Returns collection of choices specified for particular field
Public methodGetDropDownMenuItemsByIDs
Returns collection of choices specified for particular field and given ids
Public methodGetDropDownMenuItemsByNames
Returns collection of choices specified for particular field and given names
Public methodGetDropDownMenuItemsForImport
Public methodGetDropDownMenuItemsPaged
Returns collection of choices specified for particular field with paging and filtering
Public methodGetElectronicSchemaList
Return all schemas for electronic documents or records.
Public methodGetEventDefinition
Return event definition with given identifier.
Public methodGetEventsList
Get a list of all events.
Public methodGetEventsOverview
Get an overview list of all events.
Public methodGetFieldsInfo
Returns information about specified fields from particular schema
Public methodGetFieldsList
Returns brief information about all metadata fields existing in the system. The text property is the metadata field name and the value is the metadata field id.
Public methodGetFieldsOverviewInfoList
/// Returns information about all metadata fields starting with the specified string.
Public methodGetFieldsOverviewList
Returns information about all metadata fields existing in the system.
Public methodGetFieldsOverviewListIncludingInvisible
Returns information about all metadata fields existing in the system including invisible fields.
Public methodGetFilteredDropDownMenuItems
Public methodGetFirstCharactersOfDocumentSchemas
Return distinct first characters of document schema names
Public methodGetFirstCharactersOfGlobalFields
Return distinct first characters of metadata fields
Public methodGetGlobalField
Returns specified metadata field definition (also called "global field" in the API)
Public methodGetGlobalFieldFast
Returns metadata field without drop down menu items
Public methodGetGlobalFields(String, Boolean, Boolean)
Public methodGetGlobalFields(String, Boolean, Boolean, Database, DbTransaction)
Public methodGetOfflineSchemaList
Return all schemas for offline documents.
Public methodGetPagedDocumentSchemaFields
Retrieves schema's fields.
Public methodGetPagedDocumentSchemaFieldsCount
Retrieves schema's fields count.
Public methodGetReindexWarningThreshold
Returns a minimum number of documents that when changing their metadata value field will show a warning message.
Public methodGetSchemaList
Returns all schemas defined in system.
Public methodGetSchemaListAdvanced
Return list of document schemas for editing document metadata
Public methodGetSchemaListForCabinet
Returns list of schemas to which user has permissions based on localization.
Public methodGetSchemaListNoCustomNaming
Return all schemas without custom naming.
Public methodGetSchemaListOfConvertedType
Public methodGetSchemaListOfDocumentType
Returns all schemas of specified type (type is specified by document).
Public methodGetSchemaListOfSelectionType
Returns all schemas of specified type (type is specified by selection).
Public methodGetUserDateFormats
Return date formats for the current user.
Public methodGetVersionControlField
Get details of a Version Control Field.
Public methodGetVersionControlFieldsList
Get a list of all existing Version Control Fields.
Public methodIsCustomNamingPatterModified
Check if custom naming pattern was modified
Public methodIsDocumentSchemaUsed
Check if the document schema is associated with any document.
Public methodIsMetadataFieldUsed
Check if a metadata field has associated documents or auto-tagging definitions.
Public methodIsReindexWarningThresholdReached
Checks if ReindexWarningThreshold is reached and how many documents will need reindexing
Public methodLookupMetadata
Lookup metadata for the given value.
Public methodLookupMultiMetadata(Int32, FieldWithValue)
Lookup metadata for given values.
Public methodLookupMultiMetadata(Int32, LookupSettings, FieldWithValue, Database, DbTransaction)
Public methodRemoveDocumentSchemaField
Removes document schema field
Public methodStatic memberRemoveEventNotifications
Public methodSetFieldsOrder
Sets order of fields for particular schema
Public methodUpdateDocumentControlField
Update an existing Document Control Field.
Public methodUpdateEvent
Change the definition of an event.
Public methodUpdateVersionControlField
Update an existing version control field.
Public methodVerifyConnection
Check connection to given data source.
Public methodVerifyFieldSourceSettings
Verifies source settings of specified field
Public methodVerifyLookupConnection
Check connection to given lookup data source.
Public methodVerifySourceSettings
Verifies specified source settings
Top
Extension Methods
See Also