DSSDK logo Document Scanner SDK
z

Class PxlScannerView

Composite MAUI control that hosts live camera preview, guidance overlays, and capture controls for document scanning scenarios.

Namespace: ImageSdkWrapper.Maui Assembly: ImageSdkWrapper.MAUI

Inheritance: object → BindableObject → Element → NavigableElement → VisualElement → View → Layout → Grid

public class PxlScannerView : Grid, IDisposable

Constructor

PxlScannerView()

Creates the scanner view and initialises UI layers and supporting services.

public PxlScannerView()

Field

CloseClicked

Raised when the user presses the close button to dismiss the scanner.

public EventHandler CloseClicked

Returns

  • EventHandler

DebugTakePictureUtcTime

Captures the UTC timestamp of the last debug capture request.

public DateTime DebugTakePictureUtcTime

Returns

  • DateTime

PictureReceiver

Callback invoked after ImageSdkWrapper.Maui.Camera.CameraPreviewView.TakePicture(ImageSdkWrapper.Maui.PxlScannerView.PictureReceiverHandler) completes, delivering the resulting image or error details.

public PxlScannerView.PictureReceiverHandler PictureReceiver

Returns

  • PictureReceiverHandler

Method

Dispose()

Releases camera, analyzer, and shake detector resources.

public void Dispose()

Restart()

Resets analysis state and updates UI to accept a new capture.

public void Restart()

StartCamera()

Starts the camera preview if a renderer is available.

public bool StartCamera()

Returns

  • bool: true if the renderer began streaming; otherwise false.

Property

ButtonsSize

Gets or sets the size of the flash and smart buttons.

public double ButtonsSize { get; set; }

Returns

  • double

CloseButtonPadding

Gets or sets padding applied around the close button area.

public Thickness CloseButtonPadding { get; set; }

Returns

  • Thickness

CloseButtonsSize

Gets or sets the close button visual size.

public double CloseButtonsSize { get; set; }

Returns

  • double

OnReadyForStart

Triggered when the camera view is ready to start streaming frames.

public EventHandler OnReadyForStart { get; set; }

Returns

  • EventHandler

PanelBackgroundColor

Gets or sets the background colour of the bottom control panel.

public Color PanelBackgroundColor { get; set; }

Returns

  • Color

PanelPadding

Gets or sets padding applied to the bottom control panel.

public Thickness PanelPadding { get; set; }

Returns

  • Thickness

SafeAreaPadding

Gets or sets safe area padding applied to the control layout.

public Thickness SafeAreaPadding { get; set; }

Returns

  • Thickness

ShotButtonBorderColor

Gets or sets the border colour of the shutter button.

public Color ShotButtonBorderColor { get; set; }

Returns

  • Color

ShotButtonSize

Gets or sets the diameter of the main shutter button.

public double ShotButtonSize { get; set; }

Returns

  • double

StateBackgroundColor

Gets or sets the background colour for the state label.

public Color StateBackgroundColor { get; set; }

Returns

  • Color

StateTextColor

Gets or sets the text colour of the state label.

public Color StateTextColor { get; set; }

Returns

  • Color

StateTextFontSize

Gets or sets the state label font size.

public double StateTextFontSize { get; set; }

Returns

  • double

StateTextPadding

Gets or sets padding applied to the state label.

public Thickness StateTextPadding { get; set; }

Returns

  • Thickness

StateTextVerticalDiv

Gets or sets spacing between state labels and buttons.

public double StateTextVerticalDiv { get; set; }

Returns

  • double
Top