LEADTOOLS Special Effects (Leadtools.SpecialEffects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
Draw3dText(IntPtr,String,Rectangle,SpecialEffectsTextStyle,SpecialEffectsTextAlignmentFlags,Int32,Int32,Color,Color,Color,IntPtr,IntPtr) Method
See Also 
Leadtools.SpecialEffects Namespace > SpecialEffectsProcessor Class > Draw3dText Method : Draw3dText(IntPtr,String,Rectangle,SpecialEffectsTextStyle,SpecialEffectsTextAlignmentFlags,Int32,Int32,Color,Color,Color,IntPtr,IntPtr) Method



hdc
Handle to a device context.
text
Text string.
destRect
Rectangle to be used as the display destination rectangle.
textStyle
Text style. Use this parameter to control the style and justification of the three-dimensional text. For valid values refer to SpecialEffectsTextStyle.
textAlignment
Text Alignment, For valid values refer to SpecialEffectsTextAlignmentFlags.
xDepth
Horizontal shadow position.
yDepth
Vertical shadow position.
textColor
Text color.
shadowColor
Shadow color.
hiliteColor
Border color.
textHfont
A handle to a System.Drawing.Font object that will be used for drawing the 3D text.
foreImageHdc
a handle to a System.Drawing.Graphics object that will be used to place an image (such as a gradient) on the surface of the three-dimensional text. Use null to paint the color specified in textColor.
hdc
Handle to a device context.
text
Text string.
destRect
Rectangle to be used as the display destination rectangle.
textStyle
Text style. Use this parameter to control the style and justification of the three-dimensional text. For valid values refer to SpecialEffectsTextStyle.
textAlignment
Text Alignment, For valid values refer to SpecialEffectsTextAlignmentFlags.
xDepth
Horizontal shadow position.
yDepth
Vertical shadow position.
textColor
Text color.
shadowColor
Shadow color.
hiliteColor
Border color.
textHfont
A handle to a System.Drawing.Font object that will be used for drawing the 3D text.
foreImageHdc
a handle to a System.Drawing.Graphics object that will be used to place an image (such as a gradient) on the surface of the three-dimensional text. Use null to paint the color specified in textColor.
Draws three-dimensional text onto the target device context using the specified font, color, and style.

Syntax

Visual Basic (Declaration) 
Overloads Public Sub Draw3dText( _
   ByVal hdc As IntPtr, _
   ByVal text As String, _
   ByVal destRect As Rectangle, _
   ByVal textStyle As SpecialEffectsTextStyle, _
   ByVal textAlignment As SpecialEffectsTextAlignmentFlags, _
   ByVal xDepth As Integer, _
   ByVal yDepth As Integer, _
   ByVal textColor As Color, _
   ByVal shadowColor As Color, _
   ByVal hiliteColor As Color, _
   ByVal textHfont As IntPtr, _
   ByVal foreImageHdc As IntPtr _
) 
Visual Basic (Usage)Copy Code
Dim instance As SpecialEffectsProcessor
Dim hdc As IntPtr
Dim text As String
Dim destRect As Rectangle
Dim textStyle As SpecialEffectsTextStyle
Dim textAlignment As SpecialEffectsTextAlignmentFlags
Dim xDepth As Integer
Dim yDepth As Integer
Dim textColor As Color
Dim shadowColor As Color
Dim hiliteColor As Color
Dim textHfont As IntPtr
Dim foreImageHdc As IntPtr
 
instance.Draw3dText(hdc, text, destRect, textStyle, textAlignment, xDepth, yDepth, textColor, shadowColor, hiliteColor, textHfont, foreImageHdc)
C++/CLI 
public:
void Draw3dText( 
   IntPtr hdc,
   String^ text,
   Rectangle destRect,
   SpecialEffectsTextStyle textStyle,
   SpecialEffectsTextAlignmentFlags textAlignment,
   int xDepth,
   int yDepth,
   Color textColor,
   Color shadowColor,
   Color hiliteColor,
   IntPtr textHfont,
   IntPtr foreImageHdc
) 

Parameters

hdc
Handle to a device context.
text
Text string.
destRect
Rectangle to be used as the display destination rectangle.
textStyle
Text style. Use this parameter to control the style and justification of the three-dimensional text. For valid values refer to SpecialEffectsTextStyle.
textAlignment
Text Alignment, For valid values refer to SpecialEffectsTextAlignmentFlags.
xDepth
Horizontal shadow position.
yDepth
Vertical shadow position.
textColor
Text color.
shadowColor
Shadow color.
hiliteColor
Border color.
textHfont
A handle to a System.Drawing.Font object that will be used for drawing the 3D text.
foreImageHdc
a handle to a System.Drawing.Graphics object that will be used to place an image (such as a gradient) on the surface of the three-dimensional text. Use null to paint the color specified in textColor.

Example

This example shows the minimum requirements for using the Draw3dText(Graphics,String,Rectangle,SpecialEffectsTextStyle,SpecialEffectsTextAlignmentFlags,Int32,Int32,Color,Color,Color,Font,Image) method.

Visual BasicCopy Code
Public Sub Draw3dText(ByVal g As Graphics, ByVal destRect As Rectangle)
      Dim processor As SpecialEffectsProcessor = New SpecialEffectsProcessor()
      Dim textFont As Font = New Font("Arial", 24)

      Dim img As Image = Image.FromFile(Path.Combine(LEAD_VARS.ImagesDir, "Ulay1.bmp"))

      processor.Draw3dText(g, "3D Text - LEADTOOLS", destRect, SpecialEffectsTextStyle.DropShadow, SpecialEffectsTextAlignmentFlags.HorizontalCenter Or SpecialEffectsTextAlignmentFlags.VerticalCenter, 2, 2, Color.Blue, Color.Black, Color.White, textFont, img)

      img.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void Draw3dText(Graphics g, Rectangle destRect)
   {
      SpecialEffectsProcessor processor = new SpecialEffectsProcessor();
      Font textFont = new Font("Arial", 24);

      Image image = Image.FromFile(Path.Combine(LEAD_VARS.ImagesDir, "Ulay1.bmp"));

      processor.Draw3dText(g,
                           "3D Text - LEADTOOLS",
                           destRect,
                           SpecialEffectsTextStyle.DropShadow,
                           SpecialEffectsTextAlignmentFlags.HorizontalCenter | SpecialEffectsTextAlignmentFlags.VerticalCenter,
                           2, /* horizontal  shadow position */
                           2, /* vertical shadow position */
                           Color.Blue, /* text color, blue */
                           Color.Black,/* shadow color, black */
                           Color.White, /* border color, white */
                           textFont,
                           image);

      image.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Remarks

Use the textStyle and textAlignment parameters to control the style and justification of the three-dimensional text. Use the textFont parameter to place an image (such as a gradient) on the surface of the three-dimensional text.

Drop shadows are available only for the following textStyle values:

  • DropShadow
  • BlockShadow
  • OutlineBlock

shadowColor is available only for the following textStyle values:

  • InsetHeavy
  • InsetExtraHeavy
  • RaisedHeavy
  • RaisedExtraHeavy

hiliteColor is available only for the following textStyle values:

  • InsetLight
  • InsetExtraLight
  • InsetHeavy
  • InsetExtraHeavy
  • RaisedLight
  • RaisedExtraLight
  • RaisedHeavy
  • RaisedExtraHeavy
  • OutlineBlock

For general information, refer to Implementing Special Effects.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also