Spread Windows Forms 10.0 Product Documentation
GetPreferredSize(Graphics,Size,Font,String,String,ButtonTextAlign,TextOrientation,Boolean,Int32,Image,Image,HotkeyPrefix) Method


GDI+ graphics surface
Size
Font
Text of button when not pressed
Text of button when pressed
Alignment of text
Text orientation
Whether text wraps to multiple lines
Size of shadow around button
Picture when button is not pressed
Picture when button is pressed
Hotkey prefix
Calculates the height and width required to display the button text and picture.
Syntax
'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 textOrientation As TextOrientation, _
   ByVal wordWrap As Boolean, _
   ByVal shadowSize As Integer, _
   ByVal pictUp As Image, _
   ByVal pictDown As Image, _
   ByVal prefix As HotkeyPrefix _
) As Size
'Usage
 
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 textOrientation As TextOrientation
Dim wordWrap As Boolean
Dim shadowSize As Integer
Dim pictUp As Image
Dim pictDown As Image
Dim prefix As HotkeyPrefix
Dim value As Size
 
value = FpButton.GetPreferredSize(g, size, font, text, textDown, nAlign, textOrientation, wordWrap, shadowSize, pictUp, pictDown, prefix)
public static Size GetPreferredSize( 
   Graphics g,
   Size size,
   Font font,
   string text,
   string textDown,
   ButtonTextAlign nAlign,
   TextOrientation textOrientation,
   bool wordWrap,
   int shadowSize,
   Image pictUp,
   Image pictDown,
   HotkeyPrefix prefix
)

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
textOrientation
Text orientation
wordWrap
Whether text wraps to multiple lines
shadowSize
Size of shadow around button
pictUp
Picture when button is not pressed
pictDown
Picture when button is pressed
prefix
Hotkey prefix

Return Value

Size object containing the size of the control
Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

See Also

Reference

FpButton Class
FpButton Members
Overload List

 

 


Copyright © GrapeCity, inc. All rights reserved.