Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / DrawTextWithBorder

DrawTextWithBorder method

Draws bordered text on the current image canvas.

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

ParameterTypeRequiredDescription
strTextStringYesText to draw.
nLeftNumberYesLeft coordinate for the text.
nTopNumberYesTop coordinate for the text.
nPenColorNumberNoOptional parameter containing a color value. If no color is specified, the current pen color will be used instead.
nPenOpacityNumberNoOptional parameter containing the opacity percentage (where 0% is completely transparent). If no opacity is specified, the current pen opacity will be used instead.
nPenStylePen (Enumeration)NoOptional parameter containing the desired line style. If no style is specified, the current pen style will be used instead.
nPenWidthNumberNoOptional 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.
strFontFaceStringNoOptional parameter which specifies the font face.
nFontSizeNumberNoOptional parameter which specifies the font size.
nFontColorNumberNoOptional parameter which specifies the font color.
nFontOpacityNumberNoOptional parameter which specifies the font opacity.
bFontBoldState (Enumeration)NoOptional parameter which enables or disables the bold font style.
bFontItalicState (Enumeration)NoOptional parameter which enables or disables the italic font style.
bFontUnderlineState (Enumeration)NoOptional parameter which enables or disables the underline font style.
bFontStrikeoutState (Enumeration)NoOptional parameter which enables or disables the strikeout font style.
bFontAntiAliasingState (Enumeration)NoOptional parameter which enables or disables the font anti-aliasing.
nFontAlignmentAlignment (Enumeration)NoOptional parameter which specifies the alignment of the text.
nFontRotationNumberNoOptional parameter which specifies the rotation angle of the text in degrees.
nFontShearXNumberNoOptional parameter which specifies the horizontal shear percentage of the text.
nFontShearYNumberNoOptional 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