Class SBSDKScannedDocument

Namespace

ScanbotSDK.iOS

Assembly

DocumentSDK.NET.iOS.dll

public class SBSDKScannedDocument : NSObject

Inheritance

object

SBSDKScannedDocument

Extension Methods

NSErrorExtension.GetOrThrow<T>(T, NSError)

NSErrorExtension.GetOrThrow<T>(T, NSError)

NSErrorExtension.GetOrThrow<T>(T, NSError)

Constructors

SBSDKScannedDocument(NSObjectFlag)

protected SBSDKScannedDocument(NSObjectFlag t)

Parameters

t NSObjectFlag

SBSDKScannedDocument(NativeHandle)

protected SBSDKScannedDocument(NativeHandle handle)

Parameters

handle NativeHandle

SBSDKScannedDocument(SBSDKDocument, nint, out NSError?)

public SBSDKScannedDocument(SBSDKDocument document, nint documentImageSizeLimit, out NSError? error)

Parameters

document SBSDKDocument

documentImageSizeLimit nint

error NSError

SBSDKScannedDocument(SBSDKScannedDocument, out NSError?)

public SBSDKScannedDocument(SBSDKScannedDocument document, out NSError? error)

Parameters

document SBSDKScannedDocument

error NSError

SBSDKScannedDocument(nint, out NSError?)

public SBSDKScannedDocument(nint documentImageSizeLimit, out NSError? error)

Parameters

documentImageSizeLimit nint

error NSError

Properties

ClassHandle

public override NativeHandle ClassHandle { get; }

Property Value

NativeHandle

CreationDate

public virtual NSDate CreationDate { get; }

Property Value

NSDate

CreationTimeStamp

public virtual long CreationTimeStamp { get; }

Property Value

long

DocumentImageSizeLimit

public virtual nint DocumentImageSizeLimit { get; }

Property Value

nint

DocumentImageURLs

public virtual NSUrl[] DocumentImageURLs { get; }

Property Value

NSUrl[]

FileStorageBaseDirectory

public static NSUrl FileStorageBaseDirectory { get; set; }

Property Value

NSUrl

FileStorageImageFormat

public static SBSDKImageFileFormat FileStorageImageFormat { get; set; }

Property Value

SBSDKImageFileFormat

FileStorageImageQuality

public static byte FileStorageImageQuality { get; set; }

Property Value

byte

Hash

public virtual nuint Hash { get; }

Property Value

nuint

PageCount

public virtual nint PageCount { get; }

Property Value

nint

PageUuids

public virtual string[] PageUuids { get; }

Property Value

string[]

Pages

public virtual SBSDKScannedPage[] Pages { get; }

Property Value

SBSDKScannedPage[]

PdfURI

public virtual NSUrl PdfURI { get; }

Property Value

NSUrl

StoredDocumentUuids

public static string[] StoredDocumentUuids { get; }

Property Value

string[]

TiffURI

public virtual NSUrl TiffURI { get; }

Property Value

NSUrl

Uuid

public virtual string Uuid { get; }

Property Value

string

Methods

AddObserver(SBSDKScannedDocumentObserver)

public virtual void AddObserver(SBSDKScannedDocumentObserver observer)

Parameters

observer SBSDKScannedDocumentObserver

AddPageWith(SBSDKImageRef, SBSDKPolygon, SBSDKParametricFilter[], out NSError?)

public virtual SBSDKScannedPage? AddPageWith(SBSDKImageRef image, SBSDKPolygon polygon, SBSDKParametricFilter[] filters, out NSError? error)

Parameters

image SBSDKImageRef

polygon SBSDKPolygon

filters SBSDKParametricFilter[]

error NSError

Returns

SBSDKScannedPage

CloneAndReturnError(out NSError?)

public virtual SBSDKScannedDocument? CloneAndReturnError(out NSError? error)

Parameters

error NSError

Returns

SBSDKScannedDocument

CreateDocumentWithDocumentImageSizeLimit(nint, out NSError?)

public static SBSDKScannedDocument? CreateDocumentWithDocumentImageSizeLimit(nint documentImageSizeLimit, out NSError? error)

Parameters

documentImageSizeLimit nint

error NSError

Returns

SBSDKScannedDocument

DeleteAndReturnError(out NSError?)

public virtual bool DeleteAndReturnError(out NSError? error)

Parameters

error NSError

Returns

bool

DeleteDocumentWithDocumentUuid(string)

public static bool DeleteDocumentWithDocumentUuid(string documentUuid)

Parameters

documentUuid string

Returns

bool

DocumentExistsWithDocumentUuid(string)

public static bool DocumentExistsWithDocumentUuid(string documentUuid)

Parameters

documentUuid string

Returns

bool

InsertPageWithAt(SBSDKImageRef, nint, SBSDKPolygon, SBSDKParametricFilter[], out NSError?)

public virtual SBSDKScannedPage? InsertPageWithAt(SBSDKImageRef image, nint index, SBSDKPolygon polygon, SBSDKParametricFilter[] filters, out NSError? error)

Parameters

image SBSDKImageRef

index nint

polygon SBSDKPolygon

filters SBSDKParametricFilter[]

error NSError

Returns

SBSDKScannedPage

LoadDocumentWithDocumentUuid(string, out NSError?)

public static SBSDKScannedDocument? LoadDocumentWithDocumentUuid(string documentUuid, out NSError? error)

Parameters

documentUuid string

error NSError

Returns

SBSDKScannedDocument

MovePageAtTo(nint, nint, out NSError?)

public virtual bool MovePageAtTo(nint sourceIndex, nint destIndex, out NSError? error)

Parameters

sourceIndex nint

destIndex nint

error NSError

Returns

bool

PageAt(nint, out NSError?)

public virtual SBSDKScannedPage? PageAt(nint index, out NSError? error)

Parameters

index nint

error NSError

Returns

SBSDKScannedPage

PageExistsWithDocumentUuid(string, string)

public static bool PageExistsWithDocumentUuid(string documentUuid, string pageUuid)

Parameters

documentUuid string

pageUuid string

Returns

bool

PageWith(string, out NSError?)

public virtual SBSDKScannedPage? PageWith(string pageUuid, out NSError? error)

Parameters

pageUuid string

error NSError

Returns

SBSDKScannedPage

RebuildPagesAndReturnError(out NSError?)

public virtual bool RebuildPagesAndReturnError(out NSError? error)

Parameters

error NSError

Returns

bool

RemoveAllPagesAndReturnError(out NSError?)

public virtual bool RemoveAllPagesAndReturnError(out NSError? error)

Parameters

error NSError

Returns

bool

RemoveObserver(SBSDKScannedDocumentObserver)

public virtual void RemoveObserver(SBSDKScannedDocumentObserver observer)

Parameters

observer SBSDKScannedDocumentObserver

RemovePage(SBSDKScannedPage, out NSError?)

public virtual bool RemovePage(SBSDKScannedPage page, out NSError? error)

Parameters

page SBSDKScannedPage

error NSError

Returns

bool

ScannedPageDidChangeData(SBSDKScannedPage)

public virtual void ScannedPageDidChangeData(SBSDKScannedPage page)

Parameters

page SBSDKScannedPage

ToJson()

public virtual string ToJson()

Returns

string