FormControl.userHide Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
userHide(Int32) | |
userHide() |
Gets or sets the value that indicates whether the control is hidden from the user. |
userHide(Int32)
public:
virtual int userHide(int _value);
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public virtual int userHide (int _value);
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
abstract member userHide : int -> int
override this.userHide : int -> int
Public Overridable Function userHide (_value As Integer) As Integer
Parameters
- _value
- Int32
The value that indicates whether the control is hidden from the user; optional.
Returns
- Attributes
-
Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute
Applies to
userHide()
Gets or sets the value that indicates whether the control is hidden from the user.
public:
virtual int userHide();
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public virtual int userHide ();
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
abstract member userHide : unit -> int
override this.userHide : unit -> int
Public Overridable Function userHide () As Integer
Returns
1 if the control is hidden from the user; otherwise, 0.
- Attributes
-
Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute
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.
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);