←Select platform

GetImageData Method

Summary

Returns the image data at the specified location and size.

Syntax
C#
VB
Java
C++
public abstract byte[] GetImageData( 
   AnnContainer container, 
   LeadRectD bounds 
) 
Public MustOverride Function GetImageData( _ 
   ByVal container As AnnContainer, _ 
   ByVal bounds As LeadRectD _ 
) As Byte() 
public abstract byte[] getImageData(AnnContainer container, LeadRectD bounds) 
public:  
   virtual array<Byte>^ GetImageData( 
      AnnContainer^ container, 
      LeadRectD^ bounds 
   ) abstract 

Parameters

container
The reference AnnContainer.

bounds
The location and size in container on where to get the image data. This is in container coordinates.

Return Value

A byte array that contains the image data.

Remarks

Derived classes must implement GetImageData to extract the data of the image being annotated at the specified location and size, and SetImageData to reapply this same data to the image.

The data is application specific since it will only be stored as is inside the caller annotation object (for example, AnnRedactionObject during realize/restore). The format of the data and how it is obtained or applied is hidden from the annotations framework. A typical would be to copy the pixel data from the image then convert it to a standard format such as PNG and return it from GetImageData.

The automation framework will call GetImageData only if the value of CanRead is true and SetImageData only if the value of CanWrite is true.

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly