Skip to content

KVSDMSDocumentsFactboxMgt#

Procedures#

ShouldShowFactboxForTable(Variant) : Boolean#

Summary: Checks if the factbox shall be displayed for the given record.

procedure ShouldShowFactboxForTable(recordVariant: Variant): Boolean

Parameters:

  • recordVariant: Variant that specifies the record to be used for the check.

Returns: Return variable result of type Boolean defines if the factbox should be displayed.

ShouldShowFactboxForTable(Integer) : Boolean#

Summary: Checks if the factbox shall be displayed for the given table id.

procedure ShouldShowFactboxForTable(newTableId: Integer): Boolean

Parameters:

  • newTableId: Integer that specifies the table id used for the check.

Returns: Return variable result of type Boolean defines if the factbox should be displayed.

SetForCompanyCode(Text) :#

Summary: Set the Company Code to handle values for.

procedure SetForCompanyCode(newValue: Text):

Parameters:

  • newValue: Text that specifies the company code.

GetSourceRecord() : RecordRef#

Summary: Gets the Source Record Record Reference that has been set by the Factbox Page Integration. This procedure can be used within event subscribers in order to create individual factbox experiences.

procedure GetSourceRecord(): RecordRef

GetStorageDefinition() : Record#

procedure GetStorageDefinition(): Record KVSDMSStorageDefinition

GetDocumentEnvelopeStorageDefinition() : Record#

procedure GetDocumentEnvelopeStorageDefinition(): Record KVSDMSStorageDefinition

Events#

OnBeforeShouldShowFactboxForTable(Integer, Text, Boolean, Boolean) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeShouldShowFactboxForTable(newTableId: Integer; runForCompanyCode: Text; var result: Boolean; var isHandled: Boolean): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeShouldShowFactboxForTable', '', false, false)]
local procedure DoSomethingOnBeforeShouldShowFactboxForTable(newTableId: Integer; runForCompanyCode: Text; var result: Boolean; var isHandled: Boolean)
begin
end;

OnAfterSetSourceRecord(Variant, Record KVSDMSFileBuffer, Boolean, Boolean, Boolean, Record KVSDMSStorageDefinition, Record KVSDMSDocSearchDefinition, Record KVSDMSDisplayDefinition, Boolean, Boolean, Text) :#

[IntegrationEvent(false, false)]
local procedure OnAfterSetSourceRecord(recVariant: Variant; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var uploadAllowed: Boolean; var manualTagsExist: Boolean; var filePackExists: Boolean; var storageDefinition: Record "KVSDMSStorageDefinition"; var searchDefinition: Record "KVSDMSDocSearchDefinition"; var displayDefinition: Record "KVSDMSDisplayDefinition"; var isSourceRecordInitialized: Boolean; var dontReloadFilesForCurrentRecord: Boolean; runForCompanyCode: Text): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnAfterSetSourceRecord', '', false, false)]
local procedure DoSomethingOnAfterSetSourceRecord(recVariant: Variant; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var uploadAllowed: Boolean; var manualTagsExist: Boolean; var filePackExists: Boolean; var storageDefinition: Record "KVSDMSStorageDefinition"; var searchDefinition: Record "KVSDMSDocSearchDefinition"; var displayDefinition: Record "KVSDMSDisplayDefinition"; var isSourceRecordInitialized: Boolean; var dontReloadFilesForCurrentRecord: Boolean; runForCompanyCode: Text)
begin
end;

OnBeforeLoadFiles(Record KVSDMSFileBuffer, Boolean, Record KVSDMSStorageDefinition, Record KVSDMSDocSearchDefinition, Boolean, Boolean, Text, Boolean) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeLoadFiles(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; isSourceRecordInitialized: Boolean; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; dontReloadFilesForCurrentRecord: Boolean; searchResultsLoaded: Boolean; runForCompanyCode: Text; var isHandled: Boolean): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeLoadFiles', '', false, false)]
local procedure DoSomethingOnBeforeLoadFiles(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; isSourceRecordInitialized: Boolean; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; dontReloadFilesForCurrentRecord: Boolean; searchResultsLoaded: Boolean; runForCompanyCode: Text; var isHandled: Boolean)
begin
end;

OnAfterLoadFiles(Record KVSDMSFileBuffer, Boolean, Record KVSDMSStorageDefinition, Record KVSDMSDocSearchDefinition, Boolean, Boolean, Text) :#

[IntegrationEvent(false, false)]
local procedure OnAfterLoadFiles(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; isSourceRecordInitialized: Boolean; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; dontReloadFilesForCurrentRecord: Boolean; searchResultsLoaded: Boolean; runForCompanyCode: Text): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnAfterLoadFiles', '', false, false)]
local procedure DoSomethingOnAfterLoadFiles(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; isSourceRecordInitialized: Boolean; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; dontReloadFilesForCurrentRecord: Boolean; searchResultsLoaded: Boolean; runForCompanyCode: Text)
begin
end;

OnBeforeUploadFile(Text, Codeunit Temp Blob, RecordRef, Record KVSDMSStorageDefinition, Boolean, Text) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeUploadFile(var fileName: Text; var tempBlob: Codeunit "Temp Blob"; sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; isDragAndDrop: Boolean; runForCompanyCode: Text): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeUploadFile', '', false, false)]
local procedure DoSomethingOnBeforeUploadFile(var fileName: Text; var tempBlob: Codeunit "Temp Blob"; sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; isDragAndDrop: Boolean; runForCompanyCode: Text)
begin
end;

OnBeforeUploadFileByStream(Text, InStream, RecordRef, Record KVSDMSStorageDefinition, Boolean, Text) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeUploadFileByStream(var fileName: Text; var fileInStream: InStream; sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; isDragAndDrop: Boolean; runForCompanyCode: Text): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeUploadFileByStream', '', false, false)]
local procedure DoSomethingOnBeforeUploadFileByStream(var fileName: Text; var fileInStream: InStream; sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; isDragAndDrop: Boolean; runForCompanyCode: Text)
begin
end;

OnBeforeShowFileOrDirectory(Record KVSDMSFileBuffer, Boolean, Text, Boolean) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeShowFileOrDirectory(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; showFolderForFiles: Boolean; runForCompanyCode: Text; var isHandled: Boolean): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeShowFileOrDirectory', '', false, false)]
local procedure DoSomethingOnBeforeShowFileOrDirectory(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; showFolderForFiles: Boolean; runForCompanyCode: Text; var isHandled: Boolean)
begin
end;

OnBeforeDownloadFile(Record KVSDMSFileBuffer, Text, Boolean) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeDownloadFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; runForCompanyCode: Text; var isHandled: Boolean): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeDownloadFile', '', false, false)]
local procedure DoSomethingOnBeforeDownloadFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; runForCompanyCode: Text; var isHandled: Boolean)
begin
end;

OnAfterSetFilterAvailableSearchDefinition(RecordRef, Record KVSDMSDocSearchDefinition, Text) :#

[IntegrationEvent(false, false)]
local procedure OnAfterSetFilterAvailableSearchDefinition(sourceRecord: RecordRef; var availableSearchDefinition: Record "KVSDMSDocSearchDefinition"; runForCompanyCode: Text): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnAfterSetFilterAvailableSearchDefinition', '', false, false)]
local procedure DoSomethingOnAfterSetFilterAvailableSearchDefinition(sourceRecord: RecordRef; var availableSearchDefinition: Record "KVSDMSDocSearchDefinition"; runForCompanyCode: Text)
begin
end;

OnBeforeShowDocumentSearch(RecordRef, Record KVSDMSStorageDefinition, Record KVSDMSDocSearchDefinition, Page KVSDMSDocumentsSearch) :#

[IntegrationEvent(false, false)]
local procedure OnBeforeShowDocumentSearch(sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; var documentSearch: Page "KVSDMSDocumentsSearch"): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnBeforeShowDocumentSearch', '', false, false)]
local procedure DoSomethingOnBeforeShowDocumentSearch(sourceRecord: RecordRef; storageDefinition: Record "KVSDMSStorageDefinition"; searchDefinition: Record "KVSDMSDocSearchDefinition"; var documentSearch: Page "KVSDMSDocumentsSearch")
begin
end;

OnShowFileContentWithDocumentLinkDisplayTypeCaseElse(Record KVSDMSFileBuffer) :#

[IntegrationEvent(false, false)]
local procedure OnShowFileContentWithDocumentLinkDisplayTypeCaseElse(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary): 

[EventSubscriber(ObjectType::Codeunit, Codeunit::"KVSDMSDocumentsFactboxMgt", 'OnShowFileContentWithDocumentLinkDisplayTypeCaseElse', '', false, false)]
local procedure DoSomethingOnShowFileContentWithDocumentLinkDisplayTypeCaseElse(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary)
begin
end;