Class SBSDKUIFinderDocumentScannerViewController

Namespace

ScanbotSDK.iOS

Assembly

DocumentSDK.NET.iOS.dll

public class SBSDKUIFinderDocumentScannerViewController : SBSDKUICameraViewController, ISBSDKDocumentScannerViewControllerDelegate, INativeObject, IDisposable

Inheritance

object

SBSDKUIViewController

SBSDKUICameraViewController

SBSDKUIFinderDocumentScannerViewController

Implements

ISBSDKDocumentScannerViewControllerDelegate

INativeObject

IDisposable

Inherited Members

SBSDKUICameraViewController.ApplicationDidBecomeActive()

SBSDKUICameraViewController.TraitCollectionDidChange(UITraitCollection)

SBSDKUICameraViewController.UpdateLayout()

SBSDKUICameraViewController.ViewDidDisappear(bool)

SBSDKUICameraViewController.ViewDidLayoutSubviews()

SBSDKUICameraViewController.ViewWillAppear(bool)

SBSDKUICameraViewController.ViewWillTransitionToSizeWithTransitionCoordinator(CGSize, IUIViewControllerTransitionCoordinator)

SBSDKUICameraViewController.IsCameraAccessGranted

SBSDKUIViewController.Dismiss(bool)

SBSDKUIViewController.PreferredStatusBarStyle

SBSDKUIViewController.PrefersHomeIndicatorAutoHidden

SBSDKUIViewController.PrefersStatusBarHidden

SBSDKUIViewController.ShouldAutorotate

SBSDKUIViewController.ShouldHideHomeIndicator

SBSDKUIViewController.ShouldShowStatusBar

SBSDKUIViewController.StatusBarStyle

Constructors

SBSDKUIFinderDocumentScannerViewController()

public SBSDKUIFinderDocumentScannerViewController()

SBSDKUIFinderDocumentScannerViewController(NSCoder)

public SBSDKUIFinderDocumentScannerViewController(NSCoder coder)

Parameters

coder NSCoder

SBSDKUIFinderDocumentScannerViewController(NSObjectFlag)

protected SBSDKUIFinderDocumentScannerViewController(NSObjectFlag t)

Parameters

t NSObjectFlag

SBSDKUIFinderDocumentScannerViewController(NativeHandle)

protected SBSDKUIFinderDocumentScannerViewController(NativeHandle handle)

Parameters

handle NativeHandle

Properties

ClassHandle

public override NativeHandle ClassHandle { get; }

Property Value

NativeHandle

ContainerForEnableCameraView

public virtual UIView ContainerForEnableCameraView { get; }

Property Value

UIView

Delegate

public SBSDKUIFinderDocumentScannerViewControllerDelegate? Delegate { get; set; }

Property Value

SBSDKUIFinderDocumentScannerViewControllerDelegate

EnableCameraTextConfiguration

public virtual SBSDKUIEnableCameraTextConfiguration EnableCameraTextConfiguration { get; }

Property Value

SBSDKUIEnableCameraTextConfiguration

EnableCameraUIConfiguration

public virtual SBSDKUIEnableCameraUIConfiguration EnableCameraUIConfiguration { get; }

Property Value

SBSDKUIEnableCameraUIConfiguration

SupportedInterfaceOrientations

public virtual UIInterfaceOrientationMask SupportedInterfaceOrientations { get; }

Property Value

UIInterfaceOrientationMask

WeakDelegate

public virtual NSObject? WeakDelegate { get; set; }

Property Value

NSObject

Methods

CameraAccessDidChange(bool)

public virtual void CameraAccessDidChange(bool granted)

Parameters

granted bool

CaptureAnimationConfiguration(SBSDKDocumentScannerViewController)

public virtual SBSDKDocumentAnimationConfiguration? CaptureAnimationConfiguration(SBSDKDocumentScannerViewController controller)

Parameters

controller SBSDKDocumentScannerViewController

Returns

SBSDKDocumentAnimationConfiguration

ConfigureScanningStatusLabel(SBSDKDocumentScannerViewController, SBSDKDetectionStatusLabel, SBSDKDocumentDetectionResult?)

public virtual void ConfigureScanningStatusLabel(SBSDKDocumentScannerViewController controller, SBSDKDetectionStatusLabel label, SBSDKDocumentDetectionResult? result)

Parameters

controller SBSDKDocumentScannerViewController

label SBSDKDetectionStatusLabel

result SBSDKDocumentDetectionResult

CreateNew(SBSDKDocument?, SBSDKUIFinderDocumentScannerConfiguration, SBSDKUIFinderDocumentScannerViewControllerDelegate?)

public static SBSDKUIFinderDocumentScannerViewController CreateNew(SBSDKDocument? document, SBSDKUIFinderDocumentScannerConfiguration configuration, SBSDKUIFinderDocumentScannerViewControllerDelegate? @delegate)

Parameters

document SBSDKDocument

configuration SBSDKUIFinderDocumentScannerConfiguration

delegate SBSDKUIFinderDocumentScannerViewControllerDelegate

Returns

SBSDKUIFinderDocumentScannerViewController

CreateNew(SBSDKUIFinderDocumentScannerConfiguration, SBSDKUIFinderDocumentScannerViewControllerDelegate?)

public static SBSDKUIFinderDocumentScannerViewController CreateNew(SBSDKUIFinderDocumentScannerConfiguration configuration, SBSDKUIFinderDocumentScannerViewControllerDelegate? @delegate)

Parameters

configuration SBSDKUIFinderDocumentScannerConfiguration

delegate SBSDKUIFinderDocumentScannerViewControllerDelegate

Returns

SBSDKUIFinderDocumentScannerViewController

DidFailSnappingImage(SBSDKDocumentScannerViewController, NSError?)

public virtual void DidFailSnappingImage(SBSDKDocumentScannerViewController controller, NSError? error)

Parameters

controller SBSDKDocumentScannerViewController

error NSError

DidFinish()

public virtual void DidFinish()

DidHideEnableCameraView()

public virtual void DidHideEnableCameraView()

DidSampleVideoFrameScanningResult(SBSDKDocumentScannerViewController, UIImage, SBSDKDocumentDetectionResult?)

public virtual void DidSampleVideoFrameScanningResult(SBSDKDocumentScannerViewController controller, UIImage videoFrameImage, SBSDKDocumentDetectionResult? result)

Parameters

controller SBSDKDocumentScannerViewController

videoFrameImage UIImage

result SBSDKDocumentDetectionResult

DidSnapDocumentImage(SBSDKDocumentScannerViewController, UIImage, UIImage, SBSDKDocumentDetectionResult?, bool)

public virtual void DidSnapDocumentImage(SBSDKDocumentScannerViewController controller, UIImage documentImage, UIImage originalImage, SBSDKDocumentDetectionResult? result, bool autoSnapped)

Parameters

controller SBSDKDocumentScannerViewController

documentImage UIImage

originalImage UIImage

result SBSDKDocumentDetectionResult

autoSnapped bool

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters

disposing bool

PolygonConfigurationFor(SBSDKDocumentScannerViewController, SBSDKDocumentDetectionStatus)

public virtual SBSDKDocumentScannerPolygonConfiguration PolygonConfigurationFor(SBSDKDocumentScannerViewController controller, SBSDKDocumentDetectionStatus status)

Parameters

controller SBSDKDocumentScannerViewController

status SBSDKDocumentDetectionStatus

Returns

SBSDKDocumentScannerPolygonConfiguration

PresentOn(UIViewController, SBSDKDocument?, SBSDKUIFinderDocumentScannerConfiguration, SBSDKUIFinderDocumentScannerViewControllerDelegate?)

public static SBSDKUIFinderDocumentScannerViewController PresentOn(UIViewController presenter, SBSDKDocument? document, SBSDKUIFinderDocumentScannerConfiguration configuration, SBSDKUIFinderDocumentScannerViewControllerDelegate? @delegate)

Parameters

presenter UIViewController

document SBSDKDocument

configuration SBSDKUIFinderDocumentScannerConfiguration

delegate SBSDKUIFinderDocumentScannerViewControllerDelegate

Returns

SBSDKUIFinderDocumentScannerViewController

PresentOn(UIViewController, SBSDKUIFinderDocumentScannerConfiguration, SBSDKUIFinderDocumentScannerViewControllerDelegate?)

public static SBSDKUIFinderDocumentScannerViewController PresentOn(UIViewController presenter, SBSDKUIFinderDocumentScannerConfiguration configuration, SBSDKUIFinderDocumentScannerViewControllerDelegate? @delegate)

Parameters

presenter UIViewController

configuration SBSDKUIFinderDocumentScannerConfiguration

delegate SBSDKUIFinderDocumentScannerViewControllerDelegate

Returns

SBSDKUIFinderDocumentScannerViewController

ShouldAutoSnapImage(SBSDKDocumentScannerViewController, SBSDKDocumentDetectionResult?)

public virtual bool ShouldAutoSnapImage(SBSDKDocumentScannerViewController controller, SBSDKDocumentDetectionResult? result)

Parameters

controller SBSDKDocumentScannerViewController

result SBSDKDocumentDetectionResult

Returns

bool

ShouldScanDocument(SBSDKDocumentScannerViewController)

public virtual bool ShouldScanDocument(SBSDKDocumentScannerViewController controller)

Parameters

controller SBSDKDocumentScannerViewController

Returns

bool

UpdateFlashButton()

public virtual void UpdateFlashButton()

ViewDidLoad()

public virtual void ViewDidLoad()

WillShowEnableCameraView()

public virtual void WillShowEnableCameraView()

WillSnapImage(SBSDKDocumentScannerViewController)

public virtual void WillSnapImage(SBSDKDocumentScannerViewController controller)

Parameters

controller SBSDKDocumentScannerViewController

Events

DidCancel

public event EventHandler DidCancel

Event Type

EventHandler

DidFinishWithDocument

public event EventHandler<FinishWithDocumentEventArgs> DidFinishWithDocument

Event Type

EventHandler<FinishWithDocumentEventArgs>