DrawString (ImageKit Control/PrintDraw Method)

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

* ImageKit9ALib refers to the ANSI version, ImageKit9Lib refers to the Unicode version, (x86) refers to the 32 bit version, and (x64) refers to the 64 bit version.

Parameters

The following constants can be used: (ikScreen = 0, ikPrinter = 1, ikMemoryHandle = 2).

Return Value

Returns True (nonzero) if successful. Returns False (0) 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)

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 0 or 2 then the left, top, right, bottom parameters are in pixel units.

If the DeviceMode parameter is 1 then the left, top, right, bottom 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 Visual Basic and in .NET should start with H instead of 0x.

The following constants can be used: (ikDirectionRightToLeft = 0x00000001, ikDirectionVertical = 0x00000002, ikNoFitBlackBox = 0x00000004, ikDisplayFormatControl = 0x00000020, ikNoFontFallback = 0x00000400, ikMeasureTrailingSpaces = 0x00000800, ikNoWrap = 0x00001000, ikLineLimit = 0x00002000, ikNoClip = 0x00004000).

Sample code:

Visual Basic

    Dim Str_Width As Single

    Dim Str_Height As Single

    Dim charactersFitted As Long

    Dim linesFilled As Long

    Dim TxRight As Long

    Dim TxBottom As Long

    ImageKit1.PrintDraw.FontSize = 20

    ImageKit1.PrintDraw.FontName = "Arial"

    ImageKit1.PrintDraw.HotkeyPrefix = 0

    ImageKit1.PrintDraw.Text = "Text"

    ImageKit1.PrintDraw.MeasureString(hDC, 0, 0, Str_Width, Str_Height, charactersFitted, linesFilled, 0, 0)

    TxRight = 10 + CLng(Str_Width) - 1

    TxBottom = 10 + CLng(Str_Height) - 1

    ImageKit1.PrintDraw.CharAngle = 0

    ImageKit1.PrintDraw.TextColor1 = vbRed

    ImageKit1.PrintDraw.Alpha1 = 255

    ImageKit1.PrintDraw.TextColor2 = vbWhite

    ImageKit1.PrintDraw.Alpha2 = 255

    'using the Gradiation Brush

    ImageKit1.PrintDraw.DrawString(hDC, 10, 10, TxRight, TxBottom, 4, 0, 0, 0, 0, 0)

Visual C++

    float Str_Width, Str_Height;

    long charactersFitted, linesFilled, right, bottom;

    ImageKit1.GetPrintDraw().ClearProperty();

    ImageKit1.GetPrintDraw().SetFontSize(20);

    ImageKit1.GetPrintDraw().SetFontName("Arial");

    ImageKit1.GetPrintDraw().SetHotkeyPrefix(0);

    ImageKit1.GetPrintDraw().SetText("Text");

    ImageKit1.GetPrintDraw().MeasureString(hDC, 0, 0, &Str_Width, &Str_Height, &charactersFitted, &linesFilled, 0, 0);

    right = 10 + (long)Str_Width - 1;

    bottom = 10 + (long)Str_Height - 1;

    ImageKit1.GetPrintDraw().SetCharAngle(0);

    ImageKit1.GetPrintDraw().SetTextColor1(RGB(255, 0, 0));

    ImageKit1.GetPrintDraw().SetAlpha1(255);

    ImageKit1.GetPrintDraw().SetTextColor2(RGB(255, 255, 255));

    ImageKit1.GetPrintDraw().SetAlpha2(255);

    //using the Gradiation Brush

    ImageKit1.GetPrintDraw().DrawString(hDC, 10, 10, right, bottom, 4, 0, 0, 0, 0, 0);

VB.NET

    Dim Str_Width As Single

    Dim Str_Height As Single

    Dim charactersFitted As Integer

    Dim linesFilled As Integer

    Dim TxRight As Integer

    Dim TxBottom As Integer

    ImageKit1.PrintDraw.FontSize = 20

    ImageKit1.PrintDraw.FontName = "Arial"

    ImageKit1.PrintDraw.HotkeyPrefix = 0

    ImageKit1.PrintDraw.Text = "Text"

    ImageKit1.PrintDraw.MeasureString(hDC, 0, 0, Str_Width, Str_Height, charactersFitted, linesFilled, 0, 0)

    TxRight = 10 + CLng(Str_Width) - 1

    TxBottom = 10 + CLng(Str_Height) - 1

    ImageKit1.PrintDraw.CharAngle = 0

    ImageKit1.PrintDraw.TextColor1 = ColorTranslator.ToWin32(Color.Red)

    ImageKit1.PrintDraw.Alpha1 = 255

    ImageKit1.PrintDraw.TextColor2 = ColorTranslator.ToWin32(Color.White)

    ImageKit1.PrintDraw.Alpha2 = 255

    'using the Gradiation Brush

    ImageKit1.PrintDraw.DrawString(hDC, 10, 10, TxRight, TxBottom, 4, 0, 0, 0, 0, 0)

C#.NET

    float Str_Width, Str_Height;

    int charactersFitted, linesFilled, right, bottom;

    Str_Width = Str_Height = 0;

    charactersFitted = linesFilled = 0;

    ImageKit1.PrintDraw.FontSize = 20;

    ImageKit1.PrintDraw.FontName = "Arial";

    ImageKit1.PrintDraw.HotkeyPrefix = 0;

    ImageKit1.PrintDraw.Text = "Text";

    ImageKit1.PrintDraw.MeasureString(hDC, 0, 0, ref Str_Width, ref Str_Height, ref charactersFitted, ref linesFilled, 0, 0);

    right = 10 + (int)Str_Width - 1;

    bottom = 10 + (int)Str_Height - 1;

    ImageKit1.PrintDraw.CharAngle = 0;

    ImageKit1.PrintDraw.TextColor1 = (uint)ColorTranslator.ToWin32(Color.Red);

    ImageKit1.PrintDraw.Alpha1 = 255;

    ImageKit1.PrintDraw.TextColor2 = (uint)ColorTranslator.ToWin32(Color.White);

    ImageKit1.PrintDraw.Alpha2 = 255;

    //using the Gradiation Brush

    ImageKit1.PrintDraw.DrawString(hDC, 10, 10, right, bottom, 4, 0, 0, 0, 0, 0);

Differences between the ImageKit7/8

The DeviceValue and ImageHandle arguments' type has changed.