Back to all docs
API Reference / Telerik.Documents.AI.Tools.Core / IDocumentRepository<TDocument>

Interface
IDocumentRepository<TDocument>

Provides a unified interface for managing documents of a specific type. Implementations can support single-document or multi-document scenarios.

Definition

Namespace:Telerik.Documents.AI.Tools.Core

Assembly:Telerik.Documents.AI.Tools.Core.dll

Type Parameters:

TDocument

The type of document managed by this repository.

Syntax:
cs-api-definition
public interface IDocumentRepository<TDocument> : IDocumentRepository

Derived Classes: SingleWorkbookRepositoryInMemoryFixedDocumentRepositoryInMemoryFlowDocumentRepositoryInMemoryWorkbookRepository

Inherited Members IDocumentRepository.ListDocuments()IDocumentRepository.Export(string, DocumentFormat, Stream)IDocumentRepository.Import(Stream, DocumentFormat, string)IDocumentRepository.GetDocumentAsObject(string)IDocumentRepository.CreateDocument(string, string[])IDocumentRepository.MergeAndExport(string[], Stream, DocumentFormat)IDocumentRepository.RemoveDocument(string)IDocumentRepository.Clear()IDocumentRepository.DocumentTypeIDocumentRepository.SupportsCreationIDocumentRepository.SupportsMultipleDocuments

Methods

GetDocument(string)

Gets a document by its identifier.

Declaration

cs-api-definition
TDocument GetDocument(string documentId = null)

Parameters

documentId

string

The document identifier. If null, returns the default/current document. In single-document mode, this parameter is ignored.

Returns

TDocument

The requested document instance.

Exceptions

KeyNotFoundException

Thrown when the specified document ID does not exist.

InvalidOperationException

Thrown when no documents are available and documentId is null.

In this article
DefinitionMethodsGetDocument(string)
Not finding the help you need?
Contact Support