Share via


FormControl.userHide Method

Gets or sets the value that indicates whether the control is hidden from the user.

Syntax

public int userHide([int value])

Run On

Client

Parameters

  • value
    Type: int
    The value that indicates whether the control is hidden from the user; optional.

Return Value

Type: int
1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Examples

The following example shows how to return and set the value that indicates whether the control is hidden from the user.

int nUserHide; 
 
// The ctrl variable was previously assigned  
// as a control variable. 
 
// Retrieve the userHide value. 
nUserHide = ctrl.userHide(); 
 
// Set the userHide value. 
ctrl.userHide(1);

See Also

Reference

FormControl Class