Marblecore Imaging Library Documentation

Documentation / Marblecore Imaging / Methods / DrawTextWithBorder

DrawTextWithBorder method

Syntax

Boolean DrawTextWithBorder(strText As String, nLeft As Number, nTop As Number, nPenColor As Number, nPenOpacity As Number, nPenStyle As Pen, nPenWidth As Number, strFontFace As String, nFontSize As Number, nFontColor As Number, nFontOpacity As Number, bFontBold As State, bFontItalic As State, bFontUnderline As State, bFontStrikeout As State, bFontAntiAliasing As State, nFontAlignment As Alignment, nFontRotation As Number, nFontShearX As Number, nFontShearY As Number)

Return value

Returns true if the function succeeded.

Parameters

Parameter	Type	Required	Description
strText	String	Yes	Text to draw.
nLeft	Number	Yes	Left coordinate for the text.
nTop	Number	Yes	Top coordinate for the text.
nPenColor	Number	No	Optional parameter containing a color value. If no color is specified, the current pen color will be used instead.
nPenOpacity	Number	No	Optional parameter containing the opacity percentage (where 0% is completely transparent). If no opacity is specified, the current pen opacity will be used instead.
nPenStyle	Pen (Enumeration)	No	Optional parameter containing the desired line style. If no style is specified, the current pen style will be used instead.
nPenWidth	Number	No	Optional parameter containing the desired line width (thickness) in pixels (ranging from 1...100). If no width is specified, the current pen width will be used instead.
strFontFace	String	No	Optional parameter which specifies the font face.
nFontSize	Number	No	Optional parameter which specifies the font size.
nFontColor	Number	No	Optional parameter which specifies the font color.
nFontOpacity	Number	No	Optional parameter which specifies the font opacity.
bFontBold	State (Enumeration)	No	Optional parameter which enables or disables the bold font style.
bFontItalic	State (Enumeration)	No	Optional parameter which enables or disables the italic font style.
bFontUnderline	State (Enumeration)	No	Optional parameter which enables or disables the underline font style.
bFontStrikeout	State (Enumeration)	No	Optional parameter which enables or disables the strikeout font style.
bFontAntiAliasing	State (Enumeration)	No	Optional parameter which enables or disables the font anti-aliasing.
nFontAlignment	Alignment (Enumeration)	No	Optional parameter which specifies the alignment of the text.
nFontRotation	Number	No	Optional parameter which specifies the rotation angle of the text in degrees.
nFontShearX	Number	No	Optional parameter which specifies the horizontal shear percentage of the text.
nFontShearY	Number	No	Optional parameter which specifies the vertical shear percentage of the text.

Example

The example below shows how to use the method. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.

1 // Creates a new transparent image
2 MarblecoreImaging.Create(150, 150, true);
3 
4 // Execute the operation
5 MarblecoreImaging.DrawTextWithBorder("Demo", 25, 45, 255);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-drawtextwithborder.jpg");

Category

Text drawing

See also

DrawTextInGradient | DrawTextInGradientUsingWarp | DrawTextInGradientWithBorder | DrawTextInGradientWithBorderAndShadow | DrawTextInGradientWithBorderAndShadowUsingWarp | DrawTextInGradientWithBorderUsingWarp | DrawTextInGradientWithShadow | DrawTextInGradientWithShadowUsingWarp | DrawTextNormal | DrawTextUsingWarp | DrawTextWithBorderUsingWarp | DrawTextWithShadow | DrawTextWithShadowUsingWarp | GetTextHeight | GetTextWidth