LEADTOOLS Special Effects (Leadtools.SpecialEffects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
Draw3dShape(IntPtr,SpecialEffectsShape,Rectangle,Color,IntPtr,Rectangle,SpecialEffectsBackStyle,Color,SpecialEffectsFillStyle,Color,SpecialEffectsBorderStyle,Int32,Color,Color,SpecialEffectsInnerStyle,Int32,Color,Color,SpecialEffectsOuterStyle,Int32,Int32,Int32,Color,IntPtr) Method
See Also 
Leadtools.SpecialEffects Namespace > SpecialEffectsProcessor Class > Draw3dShape Method : Draw3dShape(IntPtr,SpecialEffectsShape,Rectangle,Color,IntPtr,Rectangle,SpecialEffectsBackStyle,Color,SpecialEffectsFillStyle,Color,SpecialEffectsBorderStyle,Int32,Color,Color,SpecialEffectsInnerStyle,Int32,Color,Color,SpecialEffectsOuterStyle,Int32,Int32,Int32,Color,IntPtr) Method



hdc
Handle to the target device context.
shape
Shape type. For valid values, refer to SpecialEffectsShape.
destRect
Rectangle to be used as the display destination rectangle.
backColor
Value that specifies the background color.
backImageHdc
Handle to the source device context for background. Use this parameter and prcBack to place an image from another device context onto the background of the shape. To use a background image, the fillStyle parameter must not be Solid.
backRect
Rectangle to be used as the display background rectangle.
backStyle
Background style. For valid values, refer to SpecialEffectsBackStyle.
fillColor
Value that specifies the foreground color.
fillStyle
Foreground style. For valid values, refer to fillStyle.
borderColor
Value that specifies the border color.
borderStyle
Border style. For valid values, refer to SpecialEffectsBorderStyle.
borderWidth
Border width.
innerHiliteColor
Value that specifies the inner band highlight color.
innerShadowColor
Value that specifies the inner band shadow color.
innerStyle
Inner band style. For valid values, refer to SpecialEffectsInnerStyle. The inner band is available only for squares and rectangles.
innerWidth
Inner band width.
outerHiliteColor
Value that specifies the outer band highlight color.
outerShadowColor
Value that specifies the inner band shadow color.
outerStyle
Outer band style. For valid values, refer to SpecialEffectsOuterStyle.
outerWidth
Outer band width.
shadowX
Horizontal position of the shadow.
shadowY
Vertical position of the shadow.
shadowColor
Value that specifies the shadow color.
shapeHrgn
Handle to a Windows region that defines the shape. This parameter is used only if the shape parameter is Region.
hdc
Handle to the target device context.
shape
Shape type. For valid values, refer to SpecialEffectsShape.
destRect
Rectangle to be used as the display destination rectangle.
backColor
Value that specifies the background color.
backImageHdc
Handle to the source device context for background. Use this parameter and prcBack to place an image from another device context onto the background of the shape. To use a background image, the fillStyle parameter must not be Solid.
backRect
Rectangle to be used as the display background rectangle.
backStyle
Background style. For valid values, refer to SpecialEffectsBackStyle.
fillColor
Value that specifies the foreground color.
fillStyle
Foreground style. For valid values, refer to fillStyle.
borderColor
Value that specifies the border color.
borderStyle
Border style. For valid values, refer to SpecialEffectsBorderStyle.
borderWidth
Border width.
innerHiliteColor
Value that specifies the inner band highlight color.
innerShadowColor
Value that specifies the inner band shadow color.
innerStyle
Inner band style. For valid values, refer to SpecialEffectsInnerStyle. The inner band is available only for squares and rectangles.
innerWidth
Inner band width.
outerHiliteColor
Value that specifies the outer band highlight color.
outerShadowColor
Value that specifies the inner band shadow color.
outerStyle
Outer band style. For valid values, refer to SpecialEffectsOuterStyle.
outerWidth
Outer band width.
shadowX
Horizontal position of the shadow.
shadowY
Vertical position of the shadow.
shadowColor
Value that specifies the shadow color.
shapeHrgn
Handle to a Windows region that defines the shape. This parameter is used only if the shape parameter is Region.
Draws the specified three-dimensional shape onto the target device context using the specified color, style, and size.

Syntax

Visual Basic (Declaration) 
Overloads Public Sub Draw3dShape( _
   ByVal hdc As IntPtr, _
   ByVal shape As SpecialEffectsShape, _
   ByVal destRect As Rectangle, _
   ByVal backColor As Color, _
   ByVal backImageHdc As IntPtr, _
   ByVal backRect As Rectangle, _
   ByVal backStyle As SpecialEffectsBackStyle, _
   ByVal fillColor As Color, _
   ByVal fillStyle As SpecialEffectsFillStyle, _
   ByVal borderColor As Color, _
   ByVal borderStyle As SpecialEffectsBorderStyle, _
   ByVal borderWidth As Integer, _
   ByVal innerHiliteColor As Color, _
   ByVal innerShadowColor As Color, _
   ByVal innerStyle As SpecialEffectsInnerStyle, _
   ByVal innerWidth As Integer, _
   ByVal outerHiliteColor As Color, _
   ByVal outerShadowColor As Color, _
   ByVal outerStyle As SpecialEffectsOuterStyle, _
   ByVal outerWidth As Integer, _
   ByVal shadowX As Integer, _
   ByVal shadowY As Integer, _
   ByVal shadowColor As Color, _
   ByVal shapeHrgn As IntPtr _
) 
Visual Basic (Usage)Copy Code
Dim instance As SpecialEffectsProcessor
Dim hdc As IntPtr
Dim shape As SpecialEffectsShape
Dim destRect As Rectangle
Dim backColor As Color
Dim backImageHdc As IntPtr
Dim backRect As Rectangle
Dim backStyle As SpecialEffectsBackStyle
Dim fillColor As Color
Dim fillStyle As SpecialEffectsFillStyle
Dim borderColor As Color
Dim borderStyle As SpecialEffectsBorderStyle
Dim borderWidth As Integer
Dim innerHiliteColor As Color
Dim innerShadowColor As Color
Dim innerStyle As SpecialEffectsInnerStyle
Dim innerWidth As Integer
Dim outerHiliteColor As Color
Dim outerShadowColor As Color
Dim outerStyle As SpecialEffectsOuterStyle
Dim outerWidth As Integer
Dim shadowX As Integer
Dim shadowY As Integer
Dim shadowColor As Color
Dim shapeHrgn As IntPtr
 
instance.Draw3dShape(hdc, shape, destRect, backColor, backImageHdc, backRect, backStyle, fillColor, fillStyle, borderColor, borderStyle, borderWidth, innerHiliteColor, innerShadowColor, innerStyle, innerWidth, outerHiliteColor, outerShadowColor, outerStyle, outerWidth, shadowX, shadowY, shadowColor, shapeHrgn)

Parameters

hdc
Handle to the target device context.
shape
Shape type. For valid values, refer to SpecialEffectsShape.
destRect
Rectangle to be used as the display destination rectangle.
backColor
Value that specifies the background color.
backImageHdc
Handle to the source device context for background. Use this parameter and prcBack to place an image from another device context onto the background of the shape. To use a background image, the fillStyle parameter must not be Solid.
backRect
Rectangle to be used as the display background rectangle.
backStyle
Background style. For valid values, refer to SpecialEffectsBackStyle.
fillColor
Value that specifies the foreground color.
fillStyle
Foreground style. For valid values, refer to fillStyle.
borderColor
Value that specifies the border color.
borderStyle
Border style. For valid values, refer to SpecialEffectsBorderStyle.
borderWidth
Border width.
innerHiliteColor
Value that specifies the inner band highlight color.
innerShadowColor
Value that specifies the inner band shadow color.
innerStyle
Inner band style. For valid values, refer to SpecialEffectsInnerStyle. The inner band is available only for squares and rectangles.
innerWidth
Inner band width.
outerHiliteColor
Value that specifies the outer band highlight color.
outerShadowColor
Value that specifies the inner band shadow color.
outerStyle
Outer band style. For valid values, refer to SpecialEffectsOuterStyle.
outerWidth
Outer band width.
shadowX
Horizontal position of the shadow.
shadowY
Vertical position of the shadow.
shadowColor
Value that specifies the shadow color.
shapeHrgn
Handle to a Windows region that defines the shape. This parameter is used only if the shape parameter is Region.

Example

This example shows the minimum requirements for using the Draw3dShape(Graphics,SpecialEffectsShape,Rectangle,Color,Image,Rectangle,SpecialEffectsBackStyle,Color,SpecialEffectsFillStyle,Color,SpecialEffectsBorderStyle,Int32,Color,Color,SpecialEffectsInnerStyle,Int32,Color,Color,SpecialEffectsOuterStyle,Int32,Int32,Int32,Color,Region) method.

Visual BasicCopy Code
Public Sub Draw3dShape(ByVal g As Graphics, ByVal destRect As Rectangle)
      Dim processor As SpecialEffectsProcessor = New SpecialEffectsProcessor()
      Dim img As Image = Image.FromFile(Path.Combine(LEAD_VARS.ImagesDir, "Ulay1.bmp"))
      Dim imageRect As Rectangle = New Rectangle(0, 0, img.Width, img.Height)

      processor.Draw3dShape(g, SpecialEffectsShape.Star4, destRect, Color.Blue, img, imageRect, SpecialEffectsBackStyle.TranslucentTiledImage, Color.Red, SpecialEffectsFillStyle.Transparent, Color.Red, SpecialEffectsBorderStyle.Solid, 5, Color.White, Color.Gray, SpecialEffectsInnerStyle.Inset, 3, Color.Red, Color.Gray, SpecialEffectsOuterStyle.Inset, 3, 2, 2, Color.Black, Nothing) ' no region handle 
      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 Draw3dShape(Graphics g, Rectangle destRect)
   {
      SpecialEffectsProcessor processor = new SpecialEffectsProcessor();
      Image image = Image.FromFile(Path.Combine(LEAD_VARS.ImagesDir, "Ulay1.bmp"));
      Rectangle imageRect = new Rectangle(0, 0, image.Width, image.Height);

      processor.Draw3dShape(g,
                           SpecialEffectsShape.Star4, /* star shape */
                           destRect,  /* destination rectangle */
                           Color.Blue, /* background color, blue */
                           image, /* use this to place an image in the background */
                           imageRect, /* display background rectangle */
                           SpecialEffectsBackStyle.TranslucentTiledImage, /* style flags for 3D shape */
                           Color.Red, /* foreground color, red */
                           SpecialEffectsFillStyle.Transparent, /* foreground style */
                           Color.Red, /* border color, red */
                           SpecialEffectsBorderStyle.Solid, /* border style */
                           5, /* border width */
                           Color.White, /* inner band highlight color, white */
                           Color.Gray, /* inner band shadow color */
                           SpecialEffectsInnerStyle.Inset, /* inner band style */
                           3, /* inner band width */
                           Color.Red, /* outer band highlight color, RED */
                           Color.Gray, /* outer band shadow color */
                           SpecialEffectsOuterStyle.Inset,/* outer band style */
                           3, /* outer band width */
                           2, /* horizontal shadow position */
                           2, /* vertical shadow position */
                           Color.Black, /* shadow color, black */
                           null);    /* no region handle */
      image.Dispose();
   }

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

Remarks

Use backImage and backRect to place an image from another device context onto the background of the shape.

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