DrawString (ImageKit Control/PrintDraw Method)

This method uses GDI+ to draw text on the designated object.

[TVIkOutPutDeviceMode Type]

Unit
     IkInit

type
     TVIkOutPutDeviceMode = (vikScreen, vikPrinter, vikMemoryHandle);

Parameters

Use either ALeft, ATop, ARight, ABottom or ARect.

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The DrawString method uses GDI+ to draw text on the designated object. If the right and bottom parameters are set to 0 then the text will be drawn with a start position determined by the left and top parameters. If the right and bottom parameters are set to values other than 0, then the text will be drawn within a rectangle defined by the left, top, right, and bottom parameters. Any text that cannot fit within this rectangle will be cut.

Supported designated objects are the screen, printer, or image data (memory handle)

To draw text using the DrawString method, please set the following properties: TextColor1, Alpha1, TextColor2, Alpha2, FontName, FontSize, CharAngle, HCentering, VCentering, HotkeyPrefix, and Text.

When the HotkeyPrefix property is set to values other than 1, prefixed string functionality cannot be used.

The TextColor1 and Alpha1 properties relate to the following: Solid Brush: brush color; Hatch Brush: line color; Gradiation Brush: start color for lined gradiation. The TextColor2 and Alpha2 properties relate to the following: Hatch Brush: background color between the hatch lines; Gradiation Brush: end color for lined gradiation.

If using the gradiation brush (BrushType=4), please set the left, top, right,and bottom parameters

If the DeviceMode parameter is vikScreen or vikMemoryHandle, then the ALeft, ATop, ARight, ABottom, (or ARect), X1, Y1, X2, Y2 parameters are in pixel units.

If the DeviceMode parameter is vikPrinter, then the ALeft, ATop, ARight, ABottom, (or ARect), X1, Y1, X2, Y2 parameters are in 0.1mm units.

The style settings for each brush

For the Hatch Brush

For the Texture Brush

For the Gradiation Brush

For Text Rendering

String format info

The values of the DrawString method in Delphi should start with $ instead of 0x.

The following constants can be used: (vikDirectionRightToLeft = 0x00000001, vikDirectionVertical = 0x00000002, vikNoFitBlackBox = 0x00000004, vikDisplayFormatControl = 0x00000020, vikNoFontFallback = 0x00000400, vikMeasureTrailingSpaces = 0x00000800, vikNoWrap = 0x00001000, vikLineLimit = 0x00002000, vikNoClip = 0x00004000).

Sample code:

In C++Builder

float Str_Width, Str_Height;
int charactersFitted, linesFilled, ARight, ABottom;

VImageKit1->PrintDraw->ClearProperty();
VImageKit1->PrintDraw->FontSize = 20;
VImageKit1->PrintDraw->FontName = "Arial";
VImageKit1->PrintDraw->HotkeyPrefix = 0;
VImageKit1->PrintDraw->Text = "Text";
VImageKit1->PrintDraw->MeasureString(DC, 0, 0, Str_Width, Str_Height, charactersFitted, linesFilled, 0, vikPrinterPixel);

ARight = 10 + (int)Str_Width - 1;
ABottom = 10 + (int)Str_Height - 1;
VImageKit1->PrintDraw->CharAngle = 0;
VImageKit1->PrintDraw->TextColor1 = clRed;
VImageKit1->PrintDraw->Alpha1 = 255;
VImageKit1->PrintDraw->TextColor2 = clWhite;
VImageKit1->PrintDraw->Alpha2 = 255;
//Use gradiation brush
VImageKit1->PrintDraw->DrawString(DC, 10, 10, ARight, ABottom, 4, 0, 0, 0, 0, TVIkOutPutDeviceMode(vikPrinterPixel));

In Delphi

Str_Width, Str_Height: Single;
CharactersFitted, linesFilled, TxRight, TxBottom: Integer;

VImageKit1.PrintDraw.ClearProperty();
VImageKit1.PrintDraw.FontSize := 20;
VImageKit1.PrintDraw.FontName := 'Arial';
VImageKit1.PrintDraw.HotkeyPrefix := 0;
VImageKit1.PrintDraw.Text := 'Text';
VImageKit1.PrintDraw.MeasureString(DC, 0, 0, Str_Width, Str_Height, charactersFitted, linesFilled, 0, vikPrinterPixel);

TxRight := 10 + Trunc(Str_Width) - 1;
TxBottom := 10 + Trunc(Str_Height) - 1;
VImageKit1.PrintDraw.CharAngle := 0;
VImageKit1.PrintDraw.TextColor1 := clRed;
VImageKit1.PrintDraw.Alpha1 := 255;
VImageKit1.PrintDraw.TextColor2 := clWhite;
VImageKit1.PrintDraw.Alpha2 := 255;
//Use gradiation brush
VImageKit1.PrintDraw.DrawString(DC, 10, 10, TxRight, TxBottom, 4, 0, 0, 0, 0, TVIkOutPutDeviceMode(vikPrinterPixel));

Differences between the ImageKit7/8/9

In VCL the constants contain a "v". In ActiveX, the constants are: ikScreen, ikPrinter, ikMemoryHandle, ikDirectionRightToLeft, ikDirectionVertical, ikNoFitBlackBox, ikDisplayFormatControl, ikNoFontFallback, ikMeasureTrailingSpaces, ikNoWrap, ikLineLimit, ikNoClip.
Methods that pass a TRect type have been added.