'Declaration Public Class TemplateImage
'Usage Dim instance As TemplateImage
public class TemplateImage
public __gc class TemplateImage
public ref class TemplateImage
'Declaration Public Class TemplateImage
'Usage Dim instance As TemplateImage
public class TemplateImage
public __gc class TemplateImage
public ref class TemplateImage
This object represents a single image. FormDirector has no requirements for the image, other than it must be 1 bit/pixel. Accusoft's other components may also place constraints on this image. For example, form drop-out will only work if the template is a "blank" form.
There are a number of image properties for this object (Image, Hbitmap, and Hdib.) They are all interchangeable and serve the same purpose: to get and set the image contained within this object. This allows you to work with uncompressed images in the form that is most convenient to you.
A TemplateImage holds a compressed form of the template image in its CompressedData property. Since this image is intended solely for use by this object, the compression method is subject to change and Accusoft does not support using it for any purpose other than storing the compressed image as part of a form definition.
TemplateImage objects can have a type associated with them, using the Type property. However, that facility is not currently exploited by Accusoft's components.
You may choose to store multiple template images in a form definition file, but you should follow a few simple rules to insure future compatibility. First, there should be a single template which is considered to be the primary template. It must be the first item in the TemplateImages property of a FormDefinition. It must also have a Type of "". Finally, the type of your additional template images must begin with "_". Accusoft will never define a type that begins with "_", so this rule will insure your types never conflict with our future types.
Instances of this class can be used as the destination of Accusoft's standard methods for passing images between different components: CopyTo(object destination) and TransferTo(object destination).
Instances of this class only accept bitonal, 1 bit per pixel images.
System.Object
Accusoft.FormDirectorSdk.TemplateImage