GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureTextExtraction Class / GetFormFieldKeyRect Method
The 0-based index of the form field pair within the last extraction process. It must be a value between 0 and GdPictureTextExtraction.GetFormFieldCount() - 1.
Returns the left x-coordinate of the field key's bounding box, in pixels.
Returns the top y-coordinate of the field key's bounding box, in pixels.
Returns the width of the field key's bounding box, in pixels.
Returns the width of the field key's bounding box, in pixels.





In This Topic
GetFormFieldKeyRect Method (GdPictureTextExtraction)
In This Topic
Returns the location of the key part of a specified form field.
Syntax
'Declaration
 
Public Function GetFormFieldKeyRect( _
   ByVal FieldIdx As Integer, _
   ByRef Left As Integer, _
   ByRef Top As Integer, _
   ByRef Width As Integer, _
   ByRef Height As Integer _
) As GdPictureStatus
public GdPictureStatus GetFormFieldKeyRect( 
   int FieldIdx,
   out int Left,
   out int Top,
   out int Width,
   out int Height
)
public function GetFormFieldKeyRect( 
    FieldIdx: Integer;
   Out  Left: Integer;
   Out  Top: Integer;
   Out  Width: Integer;
   Out  Height: Integer
): GdPictureStatus; 
public function GetFormFieldKeyRect( 
   FieldIdx : int,
   Left : int,
   Top : int,
   Width : int,
   Height : int
) : GdPictureStatus;
public: GdPictureStatus GetFormFieldKeyRect( 
   int FieldIdx,
   [PARAMFLAG::Out] int Left,
   [PARAMFLAG::Out] int Top,
   [PARAMFLAG::Out] int Width,
   [PARAMFLAG::Out] int Height
) 
public:
GdPictureStatus GetFormFieldKeyRect( 
   int FieldIdx,
   [Out] int Left,
   [Out] int Top,
   [Out] int Width,
   [Out] int Height
) 

Parameters

FieldIdx
The 0-based index of the form field pair within the last extraction process. It must be a value between 0 and GdPictureTextExtraction.GetFormFieldCount() - 1.
Left
Returns the left x-coordinate of the field key's bounding box, in pixels.
Top
Returns the top y-coordinate of the field key's bounding box, in pixels.
Width
Returns the width of the field key's bounding box, in pixels.
Height
Returns the width of the field key's bounding box, in pixels.

Return Value

A member of the GdPictureStatus enumeration.
Remarks

This method requires the KVP and Table Processing - Intelligent Redaction component to run.

See Also