Class CropRectangle
Crop rectangle for OCR input
Inheritance
System.Object
CropRectangle
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class CropRectangleConstructors
CropRectangle(Rectangle, CropRectangle.MeasurementUnits)
Create a new crop rectangle using the specified values
Declaration
public CropRectangle(Rectangle rect, CropRectangle.MeasurementUnits units = CropRectangle.MeasurementUnits.Pixels)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Rectangle | rect | Rectangle |
| CropRectangle.MeasurementUnits | units | Unit of measurement |
CropRectangle(Single, Single, Single, Single, CropRectangle.MeasurementUnits)
Create a new crop rectangle using the specified values
Declaration
public CropRectangle(float x, float y, float width, float height, CropRectangle.MeasurementUnits units = CropRectangle.MeasurementUnits.Pixels)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | x | X |
| System.Single | y | Y |
| System.Single | width | Width |
| System.Single | height | Height |
| CropRectangle.MeasurementUnits | units | Unit of measurement |
Properties
Height
Height
Declaration
public float Height { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Rectangle
Crop rectangle values
Declaration
public RectangleF Rectangle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Drawing.RectangleF |
Units
Unit of measurement
Declaration
public CropRectangle.MeasurementUnits Units { get; set; }Property Value
| Type | Description |
|---|---|
| CropRectangle.MeasurementUnits |
Width
Width
Declaration
public float Width { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
X
X
Declaration
public float X { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Y
Y
Declaration
public float Y { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Methods
ConvertTo(CropRectangle.MeasurementUnits, Int32)
Convert this crop rectangle to the specified units of measurement using the specified DPI
Declaration
public CropRectangle ConvertTo(CropRectangle.MeasurementUnits units, int dpi)Parameters
| Type | Name | Description |
|---|---|---|
| CropRectangle.MeasurementUnits | units | Unit of measurement |
| System.Int32 | dpi | DPI for conversion |
Returns
| Type | Description |
|---|---|
| CropRectangle | A new crop rectangle which uses the desired units of measurement |
Exceptions
| Type | Condition |
|---|---|
| System.NotImplementedException | Conversion not implemented |
Operators
Implicit(CropRectangle to Nullable<Rectangle>)
Crop rectangle values as a Rectangle
Declaration
public static implicit operator Rectangle? (CropRectangle value)Parameters
| Type | Name | Description |
|---|---|---|
| CropRectangle | value | Crop rectangle |
Returns
| Type | Description |
|---|---|
| System.Nullable<System.Drawing.Rectangle> |
Implicit(CropRectangle to Nullable<RectangleF>)
Crop rectangle values as a RectangleF
Declaration
public static implicit operator RectangleF? (CropRectangle value)Parameters
| Type | Name | Description |
|---|---|---|
| CropRectangle | value | Crop rectangle |
Returns
| Type | Description |
|---|---|
| System.Nullable<System.Drawing.RectangleF> |
Inherited members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)