GdPicture.NET.14
GdPicture14 Namespace / GdPictureTextExtraction Class / GetKeyValuePairKeyRect Method
The 0-based index of the key-value pair. It must be a value between 0 and GetKeyValuePairCount().
Returns the left x-coordinate of the key's bounding box, in pixels.
Returns the top y-coordinate of the key's bounding box, in pixels.
Returns the width of the key's bounding box, in pixels.
Returns the width of the key's bounding box, in pixels.





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

Parameters

PairIdx
The 0-based index of the key-value pair. It must be a value between 0 and GetKeyValuePairCount().
Left
Returns the left x-coordinate of the key's bounding box, in pixels.
Top
Returns the top y-coordinate of the key's bounding box, in pixels.
Width
Returns the width of the key's bounding box, in pixels.
Height
Returns the width of the key's bounding box, in pixels.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

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

See Also