Class ScannedDocument

Namespace

ScanbotSDK.MAUI.Document

Assembly

DocumentSDK.MAUI.dll

public class ScannedDocument

Inheritance

object

ScannedDocument

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ScannedDocument()

public ScannedDocument()

ScannedDocument(Guid)

public ScannedDocument(Guid documentUuid)

Parameters

documentUuid Guid

ScannedDocument(int)

public ScannedDocument(int documentImageSizeLimit = 0)

Parameters

documentImageSizeLimit int

Properties

this[Guid]

public ScannedDocument.Page this[Guid pageId] { get; }

Parameters

pageId Guid

Property Value

ScannedDocument.Page

this[int]

public ScannedDocument.Page this[int index] { get; }

Parameters

index int

Property Value

ScannedDocument.Page

PageCount

public int PageCount { get; }

Property Value

int

Pages

public IEnumerable<ScannedDocument.Page> Pages { get; }

Property Value

IEnumerable<ScannedDocument.Page>

PdfUri

public Uri PdfUri { get; }

Property Value

Uri

StoredDocumentUuids

public static Guid[] StoredDocumentUuids { get; }

Property Value

Guid[]

TiffUri

public Uri TiffUri { get; }

Property Value

Uri

Uuid

public Guid Uuid { get; }

Property Value

Guid

Methods

AddPage(PlatformImage, bool, ParametricFilter[], int)

Adds a page to the ScannedDocument object. Depending on the parameters, additional actions such as document detection and filter application may be performed.

public ScannedDocument.Page AddPage(PlatformImage image, bool detectDocument, ParametricFilter[] filters = null, int index = -1)

Parameters

image PlatformImage

PlatformImage object.

detectDocument bool

Indicates whether to perform document detection when adding the page. Recommended.

filters ParametricFilter[]

Optional: Parametric filters array.

index int

Optional: The desired position of the page. Defaults to -1, which appends the page to the end.

Returns

ScannedDocument.Page

A Page object.

Clone()

public ScannedDocument Clone()

Returns

ScannedDocument

DeleteAsync()

public Task DeleteAsync()

Returns

Task

MovePage(int, int)

public bool MovePage(int sourceIndex, int destinationIndex)

Parameters

sourceIndex int

destinationIndex int

Returns

bool

RemoveAllPagesAsync()

public Task RemoveAllPagesAsync()

Returns

Task

RemovePageAsync(Page)

public Task RemovePageAsync(ScannedDocument.Page page)

Parameters

page ScannedDocument.Page

Returns

Task

Explicit Interface Implementations

CreateDocumentFromLegacyPagesAsync(IScannedPage[], int)

static Task<ScannedDocument> CreateDocumentFromLegacyPagesAsync(IScannedPage[] pages, int documentImageSizeLimit = 0)

Parameters

pages IScannedPage[]

documentImageSizeLimit int

Returns

Task<ScannedDocument>

DeleteAllDocumentsAsync()

static Task DeleteAllDocumentsAsync()

Returns

Task

DeleteAsync(Guid)

static Task DeleteAsync(Guid documentUuid)

Parameters

documentUuid Guid

Returns

Task