Leadtools.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Draw3dText(Graphics,String,Rectangle,SpecialEffectsTextStyle,SpecialEffectsTextAlignmentFlags,Int32,Int32,Color,Color,Color,Font,Image) Method
See Also  Example
Leadtools.SpecialEffects Namespace > SpecialEffectsProcessor Class > Draw3dText Method : Draw3dText(Graphics,String,Rectangle,SpecialEffectsTextStyle,SpecialEffectsTextAlignmentFlags,Int32,Int32,Color,Color,Color,Font,Image) Method



g
The destination Graphics object.
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
Value that specifies the text color.
shadowColor
Value that specifies the shadow color.
hiliteColor
Value that specifies the border color.
textFont
Font object that will be used for drawing the 3D text.
foreImage
Image 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)  
Public Overloads Sub Draw3dText( _
   ByVal g As Graphics, _
   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 textFont As Font, _
   ByVal foreImage As Image _
) 
Visual Basic (Usage) Copy Code
Dim instance As SpecialEffectsProcessor
Dim g As Graphics
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 textFont As Font
Dim foreImage As Image
 
instance.Draw3dText(g, text, destRect, textStyle, textAlignment, xDepth, yDepth, textColor, shadowColor, hiliteColor, textFont, foreImage)
C#  
public void Draw3dText( 
   Graphics g,
   string text,
   Rectangle destRect,
   SpecialEffectsTextStyle textStyle,
   SpecialEffectsTextAlignmentFlags textAlignment,
   int xDepth,
   int yDepth,
   Color textColor,
   Color shadowColor,
   Color hiliteColor,
   Font textFont,
   Image foreImage
)
C++/CLI  
public:
void Draw3dText( 
   Graphics g,
   String^ text,
   Rectangle destRect,
   SpecialEffectsTextStyle textStyle,
   SpecialEffectsTextAlignmentFlags textAlignment,
   int xDepth,
   int yDepth,
   Color textColor,
   Color shadowColor,
   Color hiliteColor,
   Font textFont,
   Image foreImage
) 

Parameters

g
The destination Graphics object.
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
Value that specifies the text color.
shadowColor
Value that specifies the shadow color.
hiliteColor
Value that specifies the border color.
textFont
Font object that will be used for drawing the 3D text.
foreImage
Image 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 method.

Visual Basic Copy 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(LeadtoolsExamples.Common.ImagesPath.Path + "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
C# Copy Code
public void Draw3dText(Graphics g, Rectangle destRect) 

   SpecialEffectsProcessor processor = new SpecialEffectsProcessor(); 
   Font textFont = new Font("Arial", 24); 
 
   Image image = Image.FromFile(LeadtoolsExamples.Common.ImagesPath.Path + "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(); 
}

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

Shadow colors are available only for the following textStyle values:

  • InsetHeavy
  • InsetExtraHeavy
  • RaisedHeavy
  • RaisedExtraHeavy

Highlight colors are 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 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also