Share via


FormControl.userWidth Method

Definition

Overloads

userWidth(Int32)
userWidth()

Sets or returns the width of the control in pixels.

userWidth(Int32)

public:
 virtual int userWidth(int _value);
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public virtual int userWidth (int _value);
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
abstract member userWidth : int -> int
override this.userWidth : int -> int
Public Overridable Function userWidth (_value As Integer) As Integer

Parameters

_value
Int32

The number of pixels to use as the width of the control; optional.

Returns

Attributes
Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute

Applies to

userWidth()

Sets or returns the width of the control in pixels.

public:
 virtual int userWidth();
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public virtual int userWidth ();
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
abstract member userWidth : unit -> int
override this.userWidth : unit -> int
Public Overridable Function userWidth () As Integer

Returns

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Attributes
Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width for the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

The following example shows how to return and set the user width of a form control.

int nWidth; 
// The ctrl variable was previously defined 
// as a FormControl value. 
// Return the width. 
nWidth = ctrl.userWidth(); 
// Specify the width. 
ctrl.userWidth(90);  // 15 characters * 6 pixels == 90

Applies to