Spread Windows Forms 6.0 Product Documentation
GetPreferredSize(Graphics,Size,Font,String,String,ButtonTextAlign,Boolean,Int32,Image,Image) Method
See Also  Support Options
FarPoint.Win Assembly > FarPoint.Win Namespace > FpButton Class > GetPreferredSize Method : GetPreferredSize(Graphics,Size,Font,String,String,ButtonTextAlign,Boolean,Int32,Image,Image) Method


g
GDI+ graphics surface
size
Size
font
Font
text
Text of button when not pressed
textDown
Text of button when pressed
nAlign
Alignment of text
wordWrap
Whether text wraps to multiple lines
shadowSize
Size of shadow around button
pictUp
Picture (image) when button is not pressed
pictDown
Picture (image) when button is pressed

Glossary Item Box

Calculates the height and width required to display the button text and picture.

Syntax

Visual Basic (Declaration) 
Public Overloads Shared Function GetPreferredSize( _
   ByVal g As Graphics, _
   ByVal size As Size, _
   ByVal font As Font, _
   ByVal text As String, _
   ByVal textDown As String, _
   ByVal nAlign As ButtonTextAlign, _
   ByVal wordWrap As Boolean, _
   ByVal shadowSize As Integer, _
   ByVal pictUp As Image, _
   ByVal pictDown As Image _
) As Size
Visual Basic (Usage)Copy Code
Dim g As Graphics
Dim size As Size
Dim font As Font
Dim text As String
Dim textDown As String
Dim nAlign As ButtonTextAlign
Dim wordWrap As Boolean
Dim shadowSize As Integer
Dim pictUp As Image
Dim pictDown As Image
Dim value As Size
 
value = FpButton.GetPreferredSize(g, size, font, text, textDown, nAlign, wordWrap, shadowSize, pictUp, pictDown)
C# 
public static Size GetPreferredSize( 
   Graphics g,
   Size size,
   Font font,
   string text,
   string textDown,
   ButtonTextAlign nAlign,
   bool wordWrap,
   int shadowSize,
   Image pictUp,
   Image pictDown
)

Parameters

g
GDI+ graphics surface
size
Size
font
Font
text
Text of button when not pressed
textDown
Text of button when pressed
nAlign
Alignment of text
wordWrap
Whether text wraps to multiple lines
shadowSize
Size of shadow around button
pictUp
Picture (image) when button is not pressed
pictDown
Picture (image) when button is pressed

Return Value

Size object containing the size of the control

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.