Common Data Structures#

Geometric Types#

Defined in namespace Scandit.Datacapture.Core

MeasureUnit#

Added in version 6.2.0

Specifies in what units the value has been specified (fraction, device-independent pixels, pixels).

Dip#

Added in version 6.2.0

Value is measured in device-independent pixels.

Pixel#

Added in version 6.2.0

Value is measured in pixels.

Fraction#

Added in version 6.2.0

Value is measured as a fraction. Valid values range from 0 to 1. This can be used to specify values in relative coordinates with respect to a reference, e.g. the view width or height.

SizingMode#

Added in version 6.2.0

An enumeration of possible ways to define a rectangular size.

WidthAndHeight#

Added in version 6.2.0

This value will use a SizeWithUnit to determine width and the height.

WidthAndAspectRatio#

Added in version 6.2.0

This value will use a FloatWithUnit to determine the width and a float multiplier to determine the height.

HeightAndAspectRatio#

Added in version 6.2.0

This value will use a FloatWithUnit to determine the height and a float multiplier to determine the width.

ShorterDimensionAndAspectRatio#

Added in version 6.8.0

This value will use a FloatWithUnit to determine the rectangle length on the short side of the reference and a float multiplier to determine the length on the long side.

Point#
class Point

Added in version 6.2.0

Point()#
Point(float x, float y)

Added in version 6.2.0

Construct a new point at position x and y.

X#
float X { get; }

Added in version 6.2.0

X coordinate of the point.

Y#
float Y { get; }

Added in version 6.2.0

Y coordinate of the point.

PointWithUnit#
class PointWithUnit

Added in version 6.2.0

PointWithUnit()#
PointWithUnit(FloatWithUnit x, FloatWithUnit y)

Added in version 6.2.0

Construct a new point at position x and y.

X#
FloatWithUnit X { get; }

Added in version 6.2.0

X coordinate of the point.

Y#
FloatWithUnit Y { get; }

Added in version 6.2.0

Y coordinate of the point.

Rect#
class Rect

Added in version 6.2.0

Rect()#
Rect(Point origin, Size2 size)

Added in version 6.2.0

Construct a new rectangle.

Origin#
Point Origin { get; }

Added in version 6.2.0

The origin (top-left corner) of the rectangle.

Size#
Size2 Size { get; }

Added in version 6.2.0

The size of the rectangle.

RectWithUnit#
class RectWithUnit

Added in version 6.2.0

RectWithUnit()#
RectWithUnit(PointWithUnit point, SizeWithUnit size)

Added in version 6.2.0

Construct a new rectangle with unit.

Origin#
PointWithUnit Origin { get; }

Added in version 6.2.0

The origin (top-left corner) of the rectangle.

Size#
SizeWithUnit Size { get; }

Added in version 6.2.0

The size of the rectangle.

Size2#
class Size2

Added in version 6.2.0

Size2()#
Size2(float width, float height)

Added in version 6.2.0

Construct a new Size2 instance.

Width#
float Width { get; }

Added in version 6.2.0

The width.

Height#
float Height { get; }

Added in version 6.2.0

The height.

SizeWithUnit#
class SizeWithUnit

Added in version 6.2.0

SizeWithUnit()#
SizeWithUnit(FloatWithUnit width, FloatWithUnit height)

Added in version 6.2.0

Construct a new size with unit.

Width#
FloatWithUnit Width { get; }

Added in version 6.2.0

The width.

Height#
FloatWithUnit Height { get; }

Added in version 6.2.0

The height.

SizeWithAspect#
class SizeWithAspect

Added in version 6.2.0

Holds values to define a rectangular size using a dimension and an aspect ratio multiplier.

SizeWithAspect()#
SizeWithAspect(FloatWithUnit size, float aspect)

Added in version 6.2.0

Construct a new size with aspect.

Size#
FloatWithUnit Size { get; }

Added in version 6.2.0

The size of one dimension.

Aspect#
float Aspect { get; }

Added in version 6.2.0

The aspect ratio for the other dimension.

FloatWithUnit#
class FloatWithUnit

Added in version 6.2.0

Holds a floating-point value plus a measure unit.

FloatWithUnit()#
FloatWithUnit(float value, MeasureUnit unit)

Added in version 6.2.0

Construct a new float with unit.

Value#
float Value { get; }

Added in version 6.2.0

Unit#
MeasureUnit Unit { get; }

Added in version 6.2.0

MarginsWithUnit#
class MarginsWithUnit

Added in version 6.2.0

Holds margin values (left, top, right, bottom) that can each be expressed with a different measure unit.

MarginsWithUnit()#
MarginsWithUnit(FloatWithUnit left, FloatWithUnit top, FloatWithUnit right, FloatWithUnit bottom)

Added in version 6.2.0

Constructs a new MarginsWithUnit instance.

Left#
FloatWithUnit Left { get; }

Added in version 6.2.0

Left margin.

Right#
FloatWithUnit Right { get; }

Added in version 6.2.0

Right margin.

Top#
FloatWithUnit Top { get; }

Added in version 6.2.0

Top margin.

Bottom#
FloatWithUnit Bottom { get; }

Added in version 6.2.0

Bottom margin.

Quadrilateral#
class Quadrilateral

Added in version 6.2.0

Polygon represented by 4 corners.

Quadrilateral()#
Quadrilateral(Point topLeft, Point topRight, Point bottomRight, Point bottomLeft)

Added in version 6.2.0

Constructs a new Quadrilateral instance.

TopLeft#
Point TopLeft { get; }

Added in version 6.2.0

TopRight#
Point TopRight { get; }

Added in version 6.2.0

BottomRight#
Point BottomRight { get; }

Added in version 6.2.0

BottomLeft#
Point BottomLeft { get; }

Added in version 6.2.0

SizeWithUnitAndAspect#
class SizeWithUnitAndAspect

Added in version 6.2.0

Holds a SizingMode - and corresponding required values - to define a rectangular size.

WidthAndHeight#
SizeWithUnit WidthAndHeight { get; }

Added in version 6.2.0

The values for width and height.

Note

This value will always be null unless SizingMode is SizingMode.WidthAndHeight.

WidthAndAspectRatio#
SizeWithAspect WidthAndAspectRatio { get; }

Added in version 6.2.0

The value for width and the aspect ratio for height.

Note

This value will always be null unless SizingMode is SizingMode.WidthAndAspectRatio.

HeightAndAspectRatio#
SizeWithAspect HeightAndAspectRatio { get; }

Added in version 6.2.0

The value for height and the aspect ratio for width.

Note

This value will always be null unless SizingMode is SizingMode.HeightAndAspectRatio.

ShorterDimensionAndAspectRatio#
SizeWithAspect ShorterDimensionAndAspectRatio { get; }

Added in version 6.8.0

The value for the short dimension of the reference view and the aspect ratio for the long dimension of the reference view.

Note

This value will always be null unless SizingMode is SizingMode.ShorterDimensionAndAspectRatio.

SizingMode#
SizingMode SizingMode { get; }

Added in version 6.2.0

The sizing mode.

ToJson()#
string ToJson()

Added in version 6.2.0

Misc Types#

Defined in namespace Scandit.Datacapture.Core

ICallback#
interface ICallback

Added in version 6.2.0

Interface for a callback/callable accepting a generic parameter of type T.

Run()#
void Run(Object value)

Added in version 6.2.0

Called when the callback is invoked.

Defined in namespace Scandit.Datacapture.Core

EncodingRange#
class EncodingRange

Added in version 6.2.0

Defines the encoding of a range of bytes.

EncodingRange()#
EncodingRange(string ianaName, int startIndex, int endIndex)

Added in version 6.2.0

Construct a new encoding range.

IanaName#
string IanaName { get; }

Added in version 6.2.0

Charset encoding name as defined by IANA.

StartIndex#
int StartIndex { get; }

Added in version 6.2.0

Start index of this encoding range.

EndIndex#
int EndIndex { get; }

Added in version 6.2.0

End index (first index after the last) of this encoding range.

Defined in namespace Scandit.Datacapture.Core